Package com.commercetools.api.models.message

Interface ParcelRemovedFromDeliveryMessagePayload

All Superinterfaces:
MessagePayload, MessagePayloadMixin, OrderMessagePayload
All Known Implementing Classes:
ParcelRemovedFromDeliveryMessagePayloadImpl
public interface ParcelRemovedFromDeliveryMessagePayload extends OrderMessagePayload

Generated after a successful Remove Parcel from Delivery update action.

Example to create an instance using the builder pattern 

     ParcelRemovedFromDeliveryMessagePayload parcelRemovedFromDeliveryMessagePayload = ParcelRemovedFromDeliveryMessagePayload.builder()
             .deliveryId("{deliveryId}")
             .parcel(parcelBuilder -> parcelBuilder)
             .build()

  • Field Details

    • PARCEL_REMOVED_FROM_DELIVERY

      static final String PARCEL_REMOVED_FROM_DELIVERY
      discriminator value for ParcelRemovedFromDeliveryMessagePayload
      See Also:

  • Method Details

    • getDeliveryId

      @NotNull @NotNull String getDeliveryId()

      Unique identifier of the Delivery.

      Returns:
      deliveryId

    • getParcel

      @NotNull @Valid @NotNull @Valid Parcel getParcel()

      Parcel that was removed from the Delivery.

      Returns:
      parcel

    • getShippingKey

      String getShippingKey()

      User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.

      Returns:
      shippingKey

    • setDeliveryId

      void setDeliveryId(String deliveryId)

      Unique identifier of the Delivery.

      Parameters:
      deliveryId - value to be set

    • setParcel

      void setParcel(Parcel parcel)

      Parcel that was removed from the Delivery.

      Parameters:
      parcel - value to be set

    • setShippingKey

      void setShippingKey(String shippingKey)

      User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.

      Parameters:
      shippingKey - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ParcelRemovedFromDeliveryMessagePayloadBuilder builder()
      builder factory method for ParcelRemovedFromDeliveryMessagePayload
      Returns:
      builder

    • builder

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

    • withParcelRemovedFromDeliveryMessagePayload

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