Package com.commercetools.api.models.order_edit

Interface StagedOrderSetDeliveryAddressAction

All Superinterfaces:
ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction
public interface StagedOrderSetDeliveryAddressAction extends StagedOrderUpdateAction

Produces the DeliveryAddressSet Message.

Example to create an instance using the builder pattern 

     StagedOrderSetDeliveryAddressAction stagedOrderSetDeliveryAddressAction = StagedOrderSetDeliveryAddressAction.builder()
             .build()

  • Field Details

    • SET_DELIVERY_ADDRESS

      static final String SET_DELIVERY_ADDRESS
      discriminator value for StagedOrderSetDeliveryAddressAction
      See Also:

  • Method Details

    • getDeliveryId

      String getDeliveryId()

      id of an existing Delivery.

      Either deliveryId or deliveryKey must be provided.

      Returns:
      deliveryId

    • getDeliveryKey

      String getDeliveryKey()

      key of an existing Delivery.

      Either deliveryId or deliveryKey must be provided.

      Returns:
      deliveryKey

    • 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

    • setDeliveryId

      void setDeliveryId(String deliveryId)

      id of an existing Delivery.

      Either deliveryId or deliveryKey must be provided.

      Parameters:
      deliveryId - value to be set

    • setDeliveryKey

      void setDeliveryKey(String deliveryKey)

      key of an existing Delivery.

      Either deliveryId or deliveryKey must be provided.

      Parameters:
      deliveryKey - value to be set

    • 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 StagedOrderSetDeliveryAddressAction of()
      factory method
      Returns:
      instance of StagedOrderSetDeliveryAddressAction

    • of

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

    • copyDeep

      StagedOrderSetDeliveryAddressAction copyDeep()
      Specified by:
      copyDeep in interface StagedOrderUpdateAction

    • deepCopy

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

    • builder

      static StagedOrderSetDeliveryAddressActionBuilder builder()
      builder factory method for StagedOrderSetDeliveryAddressAction
      Returns:
      builder

    • builder

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

    • withStagedOrderSetDeliveryAddressAction

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

    • ofUnset

      static StagedOrderSetDeliveryAddressAction ofUnset()

    • typeReference

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