Interface SetOrderLineItemCustomFieldChange

Change triggered by the following update actions:

- [Set LineItem CustomField](ctp:api:type:OrderSetLineItemCustomFieldAction) on Orders.
- [Set LineItem CustomField](ctp:api:type:StagedOrderSetLineItemCustomFieldAction) on Staged Orders.
interface SetOrderLineItemCustomFieldChange {
    change: string;
    customTypeId: string;
    lineItem: LocalizedString;
    name: string;
    nextValue: any;
    previousValue: any;
    type: "SetOrderLineItemCustomFieldChange";
    variant: string;
}

Hierarchy (View Summary)

  • IChange
    • SetOrderLineItemCustomFieldChange

Properties

change customTypeId lineItem name 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.

ReadonlycustomTypeId

customTypeId: string

id of the referenced Type.

ReadonlylineItem

lineItem: LocalizedString

Name of the Product the Line Item is based on.

Readonlyname

name: string

Name of the Custom Field.

ReadonlynextValue

nextValue: any

Value after the change.

ReadonlypreviousValue

previousValue: any

Value before the change.

Readonlytype

type: "SetOrderLineItemCustomFieldChange"

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