Package com.commercetools.api.models.message

Interface DeliveryAddressSetMessagePayload

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

Generated after a successful Set Delivery Address update action.

Example to create an instance using the builder pattern 

     DeliveryAddressSetMessagePayload deliveryAddressSetMessagePayload = DeliveryAddressSetMessagePayload.builder()
             .deliveryId("{deliveryId}")
             .build()

  • Field Details

    • DELIVERY_ADDRESS_SET

      static final String DELIVERY_ADDRESS_SET
      discriminator value for DeliveryAddressSetMessagePayload
      See Also:

  • Method Details

    • getDeliveryId

      @NotNull @NotNull String getDeliveryId()

      Unique identifier of the Parcel.

      Returns:
      deliveryId

    • getAddress

      @Valid @Valid Address getAddress()

      Address after the Set Delivery Address update action.

      Returns:
      address

    • getOldAddress

      @Valid @Valid Address getOldAddress()

      Address before the Set Delivery Address update action.

      Returns:
      oldAddress

    • 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 Parcel.

      Parameters:
      deliveryId - value to be set

    • setAddress

      void setAddress(Address address)

      Address after the Set Delivery Address update action.

      Parameters:
      address - value to be set

    • setOldAddress

      void setOldAddress(Address oldAddress)

      Address before the Set Delivery Address update action.

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

    • of

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

    • deepCopy

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

    • builder

      static DeliveryAddressSetMessagePayloadBuilder builder()
      builder factory method for DeliveryAddressSetMessagePayload
      Returns:
      builder

    • builder

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

    • withDeliveryAddressSetMessagePayload

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