Typescript SDK Type Docs
    Preparing search index...

    Interface SetDeliveryItemsChange

    Change triggered by the following update actions:

    - [Set Delivery Items](ctp:api:type:OrderSetDeliveryItemsAction) on Orders.
- [Set Delivery Items](ctp:api:type:StagedOrderSetDeliveryItemsAction) on Staged Orders.
    interface SetDeliveryItemsChange {
        change: string;
        deliveryId: string;
        nextValue: DeliveryItem[];
        previousValue: DeliveryItem[];
        type: "SetDeliveryItemsChange";
    }

    Hierarchy (View Summary)

    Index

    Properties

    change deliveryId nextValue previousValue type

    Properties

    change: string

    Change type 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.
    deliveryId: string

    id of the updated Delivery.

    nextValue: DeliveryItem[]

    Value after the change.

    previousValue: DeliveryItem[]

    Value before the change.

    type: "SetDeliveryItemsChange"

    Unique discriminator value to reliably deserialize the data type.

    Settings

    Member Visibility

    On This Page

    Properties