Interface SetCustomLineItemCustomFieldChange

Change triggered by the following update actions:

- [Set CustomLineItem Custom Type](ctp:api:type:OrderSetCustomLineItemCustomFieldAction) on Orders.
- [Set CustomLineItem Custom Type](ctp:api:type:StagedOrderSetCustomLineItemCustomFieldAction) on Staged Orders.
interface SetCustomLineItemCustomFieldChange {
    change: string;
    customLineItem: LocalizedString;
    customLineItemId: string;
    name: string;
    nextValue: any;
    previousValue: any;
    type: "SetCustomLineItemCustomFieldChange";
}

Hierarchy (View Summary)

  • IChange
    • SetCustomLineItemCustomFieldChange

Properties

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

ReadonlycustomLineItem

customLineItem: LocalizedString

Name of the updated CustomLineItem.

ReadonlycustomLineItemId

customLineItemId: string

id of the updated CustomLineItem.

Readonlyname

name: string

Name of the Custom Field.

ReadonlynextValue

nextValue: any

Value after the change.

ReadonlypreviousValue

previousValue: any

Value before the change.

Readonlytype

type: "SetCustomLineItemCustomFieldChange"

Unique discriminator value to reliably deserialize the data type.

Settings

Member Visibility

On This Page

Properties