Interface SetOrderLineItemCustomTypeChange

Change triggered by the following update actions:

- [Set LineItem Custom Type](ctp:api:type:OrderSetLineItemCustomTypeAction) on Orders.
- [Set LineItem Custom Type](ctp:api:type:StagedOrderSetLineItemCustomTypeAction) on Staged Orders.
interface SetOrderLineItemCustomTypeChange {
    change: string;
    lineItem: LocalizedString;
    nextValue: CustomFields;
    previousValue: CustomFields;
    type: "SetOrderLineItemCustomTypeChange";
    variant: string;
}

Hierarchy (View Summary)

  • IChange
    • SetOrderLineItemCustomTypeChange

Properties

change lineItem nextValue previousValue type variant

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.

ReadonlylineItem

lineItem: LocalizedString

Name of the Product the updated Line Item is based on.

ReadonlynextValue

nextValue: CustomFields

Value after the change.

ReadonlypreviousValue

previousValue: CustomFields

Value before the change.

Readonlytype

type: "SetOrderLineItemCustomTypeChange"

Unique discriminator value to reliably deserialize the data type.

Readonlyvariant

variant: string

sku or key of the ProductVariant.

Settings

Member Visibility

On This Page

Properties