Package com.commercetools.api.client

Class ByProjectKeyShippingMethodsMatchingLocationGet

java.lang.Object
io.vrap.rmf.base.client.ApiMethod<T,TResult>
io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyShippingMethodsMatchingLocationGet,ShippingMethodPagedQueryResponse>
com.commercetools.api.client.ByProjectKeyShippingMethodsMatchingLocationGet
All Implemented Interfaces:
Deprecatable200Trait<ByProjectKeyShippingMethodsMatchingLocationGet>, ErrorableTrait<ByProjectKeyShippingMethodsMatchingLocationGet>, ExpandableTrait<ByProjectKeyShippingMethodsMatchingLocationGet>, SortableTrait<ByProjectKeyShippingMethodsMatchingLocationGet>, ClientRequestCommand<ShippingMethodPagedQueryResponse>, CreateHttpRequestCommand, HttpRequestCommand<ShippingMethodPagedQueryResponse>, RequestCommand<ShippingMethodPagedQueryResponse>
public class ByProjectKeyShippingMethodsMatchingLocationGet extends TypeApiMethod<ByProjectKeyShippingMethodsMatchingLocationGet,ShippingMethodPagedQueryResponse> implements ExpandableTrait<ByProjectKeyShippingMethodsMatchingLocationGet>, SortableTrait<ByProjectKeyShippingMethodsMatchingLocationGet>, ErrorableTrait<ByProjectKeyShippingMethodsMatchingLocationGet>, Deprecatable200Trait<ByProjectKeyShippingMethodsMatchingLocationGet>

Retrieves all the active ShippingMethods that can ship to the given Location. ShippingMethods that have a predicate defined are automatically disqualified. If the currency parameter is given, then the ShippingMethods must also have a rate defined in the specified currency. Each ShippingMethod contains at least one ShippingRate with the flag isMatching set to true. If the currency parameter is given, exactly one ShippingRate will contain it.


   CompletableFuture<ApiHttpResponse<com.commercetools.api.models.shipping_method.ShippingMethodPagedQueryResponse>> result = apiRoot
            .withProjectKey("{projectKey}")
            .shippingMethods()
            .matchingLocation()
            .get()
            .withCountry(country)
            .execute()