Interface ParcelItemsUpdatedMessagePayload

Generated after a successful Set Parcel Items update action.

interface ParcelItemsUpdatedMessagePayload {
    deliveryId: string;
    items: DeliveryItem[];
    oldItems: DeliveryItem[];
    parcelId: string;
    shippingKey?: string;
    type: "ParcelItemsUpdated";
}

Hierarchy (View Summary)

IOrderMessagePayload
- ParcelItemsUpdatedMessagePayload

Index

Properties

deliveryId items oldItems parcelId shippingKey? type

Properties

`Readonly`deliveryId

deliveryId: string

Unique identifier of the Delivery.

`Readonly`items

items: DeliveryItem[]

Delivery Items after the Set Parcel Items update action.

`Readonly`oldItems

oldItems: DeliveryItem[]

Delivery Items before the Set Parcel Items update action.

`Readonly`parcelId

parcelId: string

Unique identifier of the Parcel.

`Optional` `Readonly`shippingKey

shippingKey?: string

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

`Readonly`type

type: "ParcelItemsUpdated"