Package com.commercetools.api.models.cart

Interface CartSetEstimatedDeliveryAction

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

Sets the estimated delivery window on the Cart's ShippingInfo.

This update action produces the CartEstimatedDeliverySet Message.

Example to create an instance using the builder pattern 

     CartSetEstimatedDeliveryAction cartSetEstimatedDeliveryAction = CartSetEstimatedDeliveryAction.builder()
             .build()

  • Field Details

    • SET_ESTIMATED_DELIVERY

      static final String SET_ESTIMATED_DELIVERY
      discriminator value for CartSetEstimatedDeliveryAction
      See Also:

  • Method Details

    • getShippingKey

      String getShippingKey()

      key of the Shipping to update. This is required and valid only for Carts with Multiple ShippingMode. An InvalidOperation error is returned if shippingKey is provided for Carts with Single ShippingMode, or omitted for Carts with Multiple ShippingMode.

      Returns:
      shippingKey

    • getEstimatedDelivery

      @Valid @Valid EstimatedDelivery getEstimatedDelivery()

      Value to set. If empty, any existing value is removed.

      Returns:
      estimatedDelivery

    • setShippingKey

      void setShippingKey(String shippingKey)

      key of the Shipping to update. This is required and valid only for Carts with Multiple ShippingMode. An InvalidOperation error is returned if shippingKey is provided for Carts with Single ShippingMode, or omitted for Carts with Multiple ShippingMode.

      Parameters:
      shippingKey - value to be set

    • setEstimatedDelivery

      void setEstimatedDelivery(EstimatedDelivery estimatedDelivery)

      Value to set. If empty, any existing value is removed.

      Parameters:
      estimatedDelivery - value to be set

    • of

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

    • of

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

    • copyDeep

      CartSetEstimatedDeliveryAction copyDeep()
      Specified by:
      copyDeep in interface CartUpdateAction

    • deepCopy

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

    • builder

      static CartSetEstimatedDeliveryActionBuilder builder()
      builder factory method for CartSetEstimatedDeliveryAction
      Returns:
      builder

    • builder

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

    • withCartSetEstimatedDeliveryAction

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

    • typeReference

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