Package com.commercetools.api.models.order

Interface OrderSetEstimatedDeliveryAction

All Superinterfaces:
OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>
public interface OrderSetEstimatedDeliveryAction extends OrderUpdateAction

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

This update action produces the OrderEstimatedDeliverySet Message.

Example to create an instance using the builder pattern 

     OrderSetEstimatedDeliveryAction orderSetEstimatedDeliveryAction = OrderSetEstimatedDeliveryAction.builder()
             .build()

  • Field Details

    • SET_ESTIMATED_DELIVERY

      static final String SET_ESTIMATED_DELIVERY
      discriminator value for OrderSetEstimatedDeliveryAction
      See Also:

  • Method Details

    • getShippingKey

      String getShippingKey()

      key of the Shipping to update. This is required and valid only for Orders with Multiple ShippingMode. An InvalidOperation error is returned if shippingKey is provided for Orders with Single ShippingMode, or omitted for Orders 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 Orders with Multiple ShippingMode. An InvalidOperation error is returned if shippingKey is provided for Orders with Single ShippingMode, or omitted for Orders 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 OrderSetEstimatedDeliveryAction of()
      factory method
      Returns:
      instance of OrderSetEstimatedDeliveryAction

    • of

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

    • copyDeep

      OrderSetEstimatedDeliveryAction copyDeep()
      Specified by:
      copyDeep in interface OrderUpdateAction

    • deepCopy

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

    • builder

      static OrderSetEstimatedDeliveryActionBuilder builder()
      builder factory method for OrderSetEstimatedDeliveryAction
      Returns:
      builder

    • builder

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

    • withOrderSetEstimatedDeliveryAction

      default <T> T withOrderSetEstimatedDeliveryAction(Function<OrderSetEstimatedDeliveryAction,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<OrderSetEstimatedDeliveryAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference