Interface SetParcelItemsChange

Change triggered by the following update actions:

- [Set Parcel Items](ctp:api:type:OrderSetParcelItemsAction) on Orders.
- [Set Parcel Items](ctp:api:type:StagedOrderSetParcelItemsAction) on Staged Orders.
interface SetParcelItemsChange {
    change: string;
    nextValue: DeliveryItem[];
    parcel: ParcelChangeValue;
    previousValue: DeliveryItem[];
    type: "SetParcelItemsChange";
}

Hierarchy (View Summary)

Properties

change nextValue parcel previousValue type

Properties

Readonlychange

change: string

Type of change on a resource that is similar to the update action it relates to, where possible. It is not a unique identifier for the data structure, for example, the setDescription change can occur with a localized and non-localized representation.

[Records](ctp:history:type:Record) can be filtered by this value using the `changes` query parameter.

ReadonlynextValue

nextValue: DeliveryItem[]

Value after the change.

Readonlyparcel

parcel: ParcelChangeValue

Information about the updated Parcel.

ReadonlypreviousValue

previousValue: DeliveryItem[]

Value before the change.

Readonlytype

type: "SetParcelItemsChange"

Unique discriminator value to reliably deserialize the data type.

Settings

Member Visibility

On This Page

Properties