Package com.commercetools.api.models.message

Interface ParcelMeasurementsUpdatedMessagePayload

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

Generated after a successful Set Parcel Measurements update action.

Example to create an instance using the builder pattern 

     ParcelMeasurementsUpdatedMessagePayload parcelMeasurementsUpdatedMessagePayload = ParcelMeasurementsUpdatedMessagePayload.builder()
             .deliveryId("{deliveryId}")
             .parcelId("{parcelId}")
             .build()

  • Field Details

    • PARCEL_MEASUREMENTS_UPDATED

      static final String PARCEL_MEASUREMENTS_UPDATED
      discriminator value for ParcelMeasurementsUpdatedMessagePayload
      See Also:

  • Method Details

    • getDeliveryId

      @NotNull @NotNull String getDeliveryId()

      Unique identifier of the Delivery.

      Returns:
      deliveryId

    • getParcelId

      @NotNull @NotNull String getParcelId()

      Unique identifier of the Parcel.

      Returns:
      parcelId

    • getMeasurements

      @Valid @Valid ParcelMeasurements getMeasurements()

      The Parcel Measurements that were set on the Parcel.

      Returns:
      measurements

    • 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

    • setParcelId

      void setParcelId(String parcelId)

      Unique identifier of the Parcel.

      Parameters:
      parcelId - value to be set

    • setMeasurements

      void setMeasurements(ParcelMeasurements measurements)

      The Parcel Measurements that were set on the Parcel.

      Parameters:
      measurements - 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 ParcelMeasurementsUpdatedMessagePayload of()
      factory method
      Returns:
      instance of ParcelMeasurementsUpdatedMessagePayload

    • of

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

    • deepCopy

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

    • builder

      static ParcelMeasurementsUpdatedMessagePayloadBuilder builder()
      builder factory method for ParcelMeasurementsUpdatedMessagePayload
      Returns:
      builder

    • builder

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

    • withParcelMeasurementsUpdatedMessagePayload

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