Interface DeliveryAddedMessagePayload

Generated after a successful Add Delivery update action.

interface DeliveryAddedMessagePayload {
    delivery: Delivery;
    shippingKey?: string;
    type: "DeliveryAdded";
}

Properties

delivery shippingKey? type

Properties

Readonly delivery

delivery: Delivery

Delivery that was added to the Order. The Delivery in the Message body does not contain Parcels if those were part of the initial Add Delivery update action. In that case, the update action produces an additional Parcel Added To Delivery Message containing information about the Parcels.

Optional Readonly shippingKey

shippingKey?: string

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

Readonly type

type: "DeliveryAdded"

Settings

Member Visibility

Theme

On This Page

deliveryshippingKeytype