Package com.commercetools.api.models.order

Interface OrderAddParcelToDeliveryAction

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

To add a Parcel, at least one Delivery must exist.

Produces the Parcel Added To Delivery Message.

Example to create an instance using the builder pattern 

     OrderAddParcelToDeliveryAction orderAddParcelToDeliveryAction = OrderAddParcelToDeliveryAction.builder()
             .build()

  • Field Details

    • ADD_PARCEL_TO_DELIVERY

      static final String ADD_PARCEL_TO_DELIVERY
      discriminator value for OrderAddParcelToDeliveryAction
      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

    • getParcelKey

      String getParcelKey()

      key of an existing Parcel.

      Returns:
      parcelKey

    • getMeasurements

      @Valid @Valid ParcelMeasurements getMeasurements()

      Value to set.

      Returns:
      measurements

    • getTrackingData

      @Valid @Valid TrackingData getTrackingData()

      Value to set.

      Returns:
      trackingData

    • getItems

      @Valid @Valid List<DeliveryItem> getItems()

      Value to set.

      Returns:
      items

    • getCustom

      @Valid @Valid CustomFieldsDraft getCustom()

      Custom Fields for the Parcel.

      Returns:
      custom

    • 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

    • setParcelKey

      void setParcelKey(String parcelKey)

      key of an existing Parcel.

      Parameters:
      parcelKey - value to be set

    • setMeasurements

      void setMeasurements(ParcelMeasurements measurements)

      Value to set.

      Parameters:
      measurements - value to be set

    • setTrackingData

      void setTrackingData(TrackingData trackingData)

      Value to set.

      Parameters:
      trackingData - value to be set

    • setItems

      void setItems(DeliveryItem... items)

      Value to set.

      Parameters:
      items - values to be set

    • setItems

      void setItems(List<DeliveryItem> items)

      Value to set.

      Parameters:
      items - values to be set

    • setCustom

      void setCustom(CustomFieldsDraft custom)

      Custom Fields for the Parcel.

      Parameters:
      custom - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static OrderAddParcelToDeliveryActionBuilder builder()
      builder factory method for OrderAddParcelToDeliveryAction
      Returns:
      builder

    • builder

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

    • withOrderAddParcelToDeliveryAction

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