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;
}

Properties

change customTypeId lineItem name nextValue previousValue type variant

Properties

Readonly change

change: string

Readonly customTypeId

customTypeId: string

id of the referenced Type.

Readonly lineItem

lineItem: LocalizedString

Name of the Product the Line Item is based on.

Readonly name

name: string

Name of the Custom Field.

Readonly nextValue

nextValue: any

Value after the change.

Readonly previousValue

previousValue: any

Value before the change.

Readonly type

type: "SetOrderLineItemCustomFieldChange"

Readonly variant

variant: string

sku or key of the ProductVariant.

Settings

Member Visibility

Theme

On This Page

changecustomTypeIdlineItemnamenextValuepreviousValuetypevariant