Package com.commercetools.api.client

Class ByProjectKeyShippingMethodsMatchingCartGet

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

Retrieves the active ShippingMethods that can ship to the shipping address of the provided Cart.

If the Cart belongs to a Store, the results include globally scoped ShippingMethods (those with an empty stores field) and ShippingMethods scoped to that Store. If the Cart has no Store, only globally scoped ShippingMethods are returned.

Each ShippingMethod contains exactly one ShippingRate with the flag isMatching set to true. This ShippingRate is used when the ShippingMethod is added to the Cart.

If a matching ShippingMethod has isDefault set to true, it is returned as the first item in the array.


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