Interface SetCustomLineItemShippingDetailsChange

Change triggered by the following update actions:

- [Set CustomLineItem ShippingDetails](ctp:api:type:OrderSetCustomLineItemShippingDetailsAction) on Orders.
- [Set CustomLineItem ShippingDetails](ctp:api:type:StagedOrderSetCustomLineItemShippingDetailsAction) on Staged Orders.
interface SetCustomLineItemShippingDetailsChange {
    change: string;
    customLineItemId: string;
    nextValue: ItemShippingDetails;
    previousValue: ItemShippingDetails;
    type: "SetCustomLineItemShippingDetailsChange";
}

Hierarchy (View Summary)

  • IChange
    • SetCustomLineItemShippingDetailsChange

Properties

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

ReadonlycustomLineItemId

customLineItemId: string

id of the updated CustomLineItem.

ReadonlynextValue

nextValue: ItemShippingDetails

Value after the change.

ReadonlypreviousValue

previousValue: ItemShippingDetails

Value before the change.

Readonlytype

type: "SetCustomLineItemShippingDetailsChange"

Unique discriminator value to reliably deserialize the data type.

Settings

Member Visibility

On This Page

Properties