Package com.commercetools.api.models.order

Interface OrderSetShippingAddressAction

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

This action updates the shippingAddress on the Order, but it does not change the shipping address on the referenced Cart from which the Order is created. Also, it does not recalculate the Cart as taxes may not fit to the shipping address anymore.

Produces the Order Shipping Address Set Message.

Example to create an instance using the builder pattern 

     OrderSetShippingAddressAction orderSetShippingAddressAction = OrderSetShippingAddressAction.builder()
             .build()

  • Field Details

    • SET_SHIPPING_ADDRESS

      static final String SET_SHIPPING_ADDRESS
      discriminator value for OrderSetShippingAddressAction
      See Also:

  • Method Details

    • getAddress

      @Valid @Valid BaseAddress getAddress()

      Value to set. It replaces the entire address, including Custom Fields if custom is not included. To preserve Custom Fields, include the custom object in the request.

      If omitted, any existing value is removed.

      Returns:
      address

    • setAddress

      void setAddress(BaseAddress address)

      Value to set. It replaces the entire address, including Custom Fields if custom is not included. To preserve Custom Fields, include the custom object in the request.

      If omitted, any existing value is removed.

      Parameters:
      address - value to be set

    • of

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

    • of

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

    • copyDeep

      OrderSetShippingAddressAction copyDeep()
      Specified by:
      copyDeep in interface OrderUpdateAction

    • deepCopy

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

    • builder

      static OrderSetShippingAddressActionBuilder builder()
      builder factory method for OrderSetShippingAddressAction
      Returns:
      builder

    • builder

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

    • withOrderSetShippingAddressAction

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