Interface RemoveParcelFromDeliveryChange

Change triggered by the following update actions:

- [Remove Parcel From Delivery](ctp:api:type:OrderRemoveParcelFromDeliveryAction) on Orders.
- [Remove Parcel From Delivery](ctp:api:type:StagedOrderRemoveParcelFromDeliveryAction) on Staged Orders.
interface RemoveParcelFromDeliveryChange {
    change: string;
    deliveryId: string;
    previousValue: Parcel;
    type: "RemoveParcelFromDeliveryChange";
}

Hierarchy (View Summary)

  • IChange
    • RemoveParcelFromDeliveryChange

Properties

change deliveryId 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.

ReadonlydeliveryId

deliveryId: string

id of the Delivery from which the Parcel was removed.

ReadonlypreviousValue

previousValue: Parcel

Value before the change.

Readonlytype

type: "RemoveParcelFromDeliveryChange"

Unique discriminator value to reliably deserialize the data type.

Settings

Member Visibility

On This Page

Properties