Interface SetLineItemShippingDetailsChange

Change triggered by the following update actions:

- [Set LineItem ShippingDetails](ctp:api:type:OrderSetLineItemShippingDetailsAction) on Orders.
- [Set LineItem ShippingDetails](ctp:api:type:StagedOrderSetLineItemShippingDetailsAction) on Staged Orders.
interface SetLineItemShippingDetailsChange {
    change: string;
    lineItemId: string;
    nextValue: ItemShippingDetails;
    previousValue: ItemShippingDetails;
    type: "SetLineItemShippingDetailsChange";
}

Hierarchy (View Summary)

  • IChange
    • SetLineItemShippingDetailsChange

Properties

change lineItemId nextValue 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.

ReadonlylineItemId

lineItemId: string

id of the updated LineItem.

ReadonlynextValue

nextValue: ItemShippingDetails

Value after the change.

ReadonlypreviousValue

previousValue: ItemShippingDetails

Value before the change.

Readonlytype

type: "SetLineItemShippingDetailsChange"

Unique discriminator value to reliably deserialize the data type.

Settings

Member Visibility

On This Page

Properties