Package com.commercetools.api.models.cart

Interface CartRemoveShippingMethodAction

All Superinterfaces:
CartUpdateAction, ResourceUpdateAction<CartUpdateAction>
public interface CartRemoveShippingMethodAction extends CartUpdateAction

Removes a Shipping Method from a Cart that has the Multiple ShippingMode.

Example to create an instance using the builder pattern 

     CartRemoveShippingMethodAction cartRemoveShippingMethodAction = CartRemoveShippingMethodAction.builder()
             .shippingKey("{shippingKey}")
             .build()

  • Field Details

    • REMOVE_SHIPPING_METHOD

      static final String REMOVE_SHIPPING_METHOD
      discriminator value for CartRemoveShippingMethodAction
      See Also:

  • Method Details

    • getShippingKey

      @NotNull @NotNull String getShippingKey()

      User-defined unique identifier of the Shipping Method to remove from the Cart.

      Returns:
      shippingKey

    • setShippingKey

      void setShippingKey(String shippingKey)

      User-defined unique identifier of the Shipping Method to remove from the Cart.

      Parameters:
      shippingKey - value to be set

    • of

      static CartRemoveShippingMethodAction of()
      factory method
      Returns:
      instance of CartRemoveShippingMethodAction

    • of

      static CartRemoveShippingMethodAction of(CartRemoveShippingMethodAction template)
      factory method to create a shallow copy CartRemoveShippingMethodAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static CartRemoveShippingMethodAction deepCopy(@Nullable CartRemoveShippingMethodAction template)
      factory method to create a deep copy of CartRemoveShippingMethodAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static CartRemoveShippingMethodActionBuilder builder()
      builder factory method for CartRemoveShippingMethodAction
      Returns:
      builder

    • builder

      static CartRemoveShippingMethodActionBuilder builder(CartRemoveShippingMethodAction template)
      create builder for CartRemoveShippingMethodAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withCartRemoveShippingMethodAction

      default <T> T withCartRemoveShippingMethodAction(Function<CartRemoveShippingMethodAction,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<CartRemoveShippingMethodAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference