io.sphere.sdk.shippingmethods.queries

Interface ShippingMethodsByLocationGet

All Superinterfaces:

ExpansionPathContainer<ShippingMethod>, Get<List<ShippingMethod>>, GetDsl<List<ShippingMethod>,ShippingMethod,ShippingMethodsByCartGet>, MetaModelGetDsl<List<ShippingMethod>,ShippingMethod,ShippingMethodsByCartGet,ShippingMethodExpansionModel<ShippingMethod>>, MetaModelReferenceExpansionDsl<ShippingMethod,ShippingMethodsByCartGet,ShippingMethodExpansionModel<ShippingMethod>>, ReferenceExpansionDsl<ShippingMethod,ShippingMethodsByCartGet>, ReferenceExpansionSupport<ShippingMethod>, SphereRequest<List<ShippingMethod>>

public interface ShippingMethodsByLocationGet
extends MetaModelGetDsl<List<ShippingMethod>,ShippingMethod,ShippingMethodsByCartGet,ShippingMethodExpansionModel<ShippingMethod>>

Retrieves all the shipping methods that can ship to the given location. If the currency parameter is given, then the shipping methods must also have a rate defined in the specified currency.

withShippingMethodForGermany(client(), shippingMethod -> {
    final SphereRequest<List<ShippingMethod>> sphereRequest =
            new VrapRequestDecorator<>(ShippingMethodsByLocationGet.of(CountryCode.DE).withExpansionPaths(m -> m.zones()), "response");

    final List<ShippingMethod> shippingMethodsByLocation =
            client().executeBlocking(sphereRequest);
    assertThat(shippingMethodsByLocation).isNotEmpty();

    for (final ShippingMethod shippingMethodByLocation : shippingMethodsByLocation) {
        final List<ShippingRate> shippingRates = shippingMethodByLocation.getZoneRates().stream()
                .flatMap(zoneRate -> zoneRate.getShippingRates().stream())
                .collect(Collectors.toList());

        assertThat(shippingRates).areAtLeastOne(new Condition<>(ShippingRate::isMatching, "Shipping rate is matching"));
        assertThat(shippingMethodByLocation.getZones()).isNotEmpty();
        assertThat(shippingMethodByLocation.getZones().get(0).getObj()).isNotNull();
    }
});
See the test code.

Method Summary

Modifier and Type	Method and Description
static ShippingMethodsByLocationGet	of(com.neovisionaries.i18n.CountryCode countryCode)
static ShippingMethodsByLocationGet	of(com.neovisionaries.i18n.CountryCode countryCode, javax.money.CurrencyUnit currencyUnit)
static ShippingMethodsByLocationGet	of(com.neovisionaries.i18n.CountryCode countryCode, String state)
static ShippingMethodsByLocationGet	of(com.neovisionaries.i18n.CountryCode countryCode, String state, javax.money.CurrencyUnit currencyUnit)

Methods inherited from interface io.sphere.sdk.queries.Get

deserialize

Methods inherited from interface io.sphere.sdk.client.SphereRequest

canDeserialize, httpRequestIntent

Methods inherited from interface io.sphere.sdk.expansion.MetaModelReferenceExpansionDsl

plusExpansionPaths, withExpansionPaths

Methods inherited from interface io.sphere.sdk.expansion.ReferenceExpansionDsl

plusExpansionPaths, plusExpansionPaths, plusExpansionPaths, plusExpansionPaths, withExpansionPaths, withExpansionPaths, withExpansionPaths, withExpansionPaths

Methods inherited from interface io.sphere.sdk.expansion.ReferenceExpansionSupport

expansionPaths

Method Detail

of

static ShippingMethodsByLocationGet of(com.neovisionaries.i18n.CountryCode countryCode)

of

static ShippingMethodsByLocationGet of(com.neovisionaries.i18n.CountryCode countryCode,
                                       String state)

of

static ShippingMethodsByLocationGet of(com.neovisionaries.i18n.CountryCode countryCode,
                                       javax.money.CurrencyUnit currencyUnit)

of

static ShippingMethodsByLocationGet of(com.neovisionaries.i18n.CountryCode countryCode,
                                       String state,
                                       javax.money.CurrencyUnit currencyUnit)