Package com.commercetools.api.models.message

Interface ParcelItemsUpdatedMessagePayload

All Superinterfaces:
MessagePayload, MessagePayloadMixin, OrderMessagePayload
public interface ParcelItemsUpdatedMessagePayload extends OrderMessagePayload

Generated after a successful Set Parcel Items update action.

Example to create an instance using the builder pattern 

     ParcelItemsUpdatedMessagePayload parcelItemsUpdatedMessagePayload = ParcelItemsUpdatedMessagePayload.builder()
             .parcelId("{parcelId}")
             .deliveryId("{deliveryId}")
             .plusItems(itemsBuilder -> itemsBuilder)
             .plusOldItems(oldItemsBuilder -> oldItemsBuilder)
             .build()

  • Field Details

    • PARCEL_ITEMS_UPDATED

      static final String PARCEL_ITEMS_UPDATED
      discriminator value for ParcelItemsUpdatedMessagePayload
      See Also:

  • Method Details

    • getParcelId

      @NotNull @NotNull String getParcelId()

      Unique identifier of the Parcel.

      Returns:
      parcelId

    • getDeliveryId

      @NotNull @NotNull String getDeliveryId()

      Unique identifier of the Delivery.

      Returns:
      deliveryId

    • getItems

      @NotNull @Valid @NotNull @Valid List<DeliveryItem> getItems()

      Delivery Items after the Set Parcel Items update action.

      Returns:
      items

    • getOldItems

      @NotNull @Valid @NotNull @Valid List<DeliveryItem> getOldItems()

      Delivery Items before the Set Parcel Items update action.

      Returns:
      oldItems

    • getShippingKey

      String getShippingKey()

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

      Returns:
      shippingKey

    • setParcelId

      void setParcelId(String parcelId)

      Unique identifier of the Parcel.

      Parameters:
      parcelId - value to be set

    • setDeliveryId

      void setDeliveryId(String deliveryId)

      Unique identifier of the Delivery.

      Parameters:
      deliveryId - value to be set

    • setItems

      void setItems(DeliveryItem... items)

      Delivery Items after the Set Parcel Items update action.

      Parameters:
      items - values to be set

    • setItems

      void setItems(List<DeliveryItem> items)

      Delivery Items after the Set Parcel Items update action.

      Parameters:
      items - values to be set

    • setOldItems

      void setOldItems(DeliveryItem... oldItems)

      Delivery Items before the Set Parcel Items update action.

      Parameters:
      oldItems - values to be set

    • setOldItems

      void setOldItems(List<DeliveryItem> oldItems)

      Delivery Items before the Set Parcel Items update action.

      Parameters:
      oldItems - values 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 ParcelItemsUpdatedMessagePayload of()
      factory method
      Returns:
      instance of ParcelItemsUpdatedMessagePayload

    • of

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

    • deepCopy

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

    • builder

      static ParcelItemsUpdatedMessagePayloadBuilder builder()
      builder factory method for ParcelItemsUpdatedMessagePayload
      Returns:
      builder

    • builder

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

    • withParcelItemsUpdatedMessagePayload

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