Package com.commercetools.api.models.order

Interface OrderRemoveParcelFromDeliveryAction

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

Produces the ParcelRemovedFromDelivery Message.

Example to create an instance using the builder pattern 

     OrderRemoveParcelFromDeliveryAction orderRemoveParcelFromDeliveryAction = OrderRemoveParcelFromDeliveryAction.builder()
             .build()

  • Field Details

    • REMOVE_PARCEL_FROM_DELIVERY

      static final String REMOVE_PARCEL_FROM_DELIVERY
      discriminator value for OrderRemoveParcelFromDeliveryAction
      See Also:

  • Method Details

    • getParcelId

      String getParcelId()

      id of an existing Parcel.

      Either parcelId or parcelKey must be provided.

      Returns:
      parcelId

    • getParcelKey

      String getParcelKey()

      key of an existing Parcel.

      Either parcelId or parcelKey must be provided.

      Returns:
      parcelKey

    • setParcelId

      void setParcelId(String parcelId)

      id of an existing Parcel.

      Either parcelId or parcelKey must be provided.

      Parameters:
      parcelId - value to be set

    • setParcelKey

      void setParcelKey(String parcelKey)

      key of an existing Parcel.

      Either parcelId or parcelKey must be provided.

      Parameters:
      parcelKey - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static OrderRemoveParcelFromDeliveryActionBuilder builder()
      builder factory method for OrderRemoveParcelFromDeliveryAction
      Returns:
      builder

    • builder

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

    • withOrderRemoveParcelFromDeliveryAction

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