Typescript SDK Type Docs
    Preparing search index...

    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;
        lineItemId: string;
        name: string;
        nextValue: any;
        previousValue: any;
        type: "SetOrderLineItemCustomFieldChange";
        variant: string;
    }

    Hierarchy (View Summary)

    • IChange
      • SetOrderLineItemCustomFieldChange
    Index

    Properties

    change customTypeId lineItem lineItemId name nextValue previousValue type variant

    Properties

    change: string

    Change type 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.
    customTypeId: string

    id of the referenced Type.

    lineItem: LocalizedString

    Name of the Product the Line Item is based on.

    lineItemId: string

    id of the updated LineItem.

    name: string

    Name of the Custom Field.

    nextValue: any

    Value after the change.

    previousValue: any

    Value before the change.

    type: "SetOrderLineItemCustomFieldChange"

    Unique discriminator value to reliably deserialize the data type.

    variant: string

    Identifier of the updated Product Variant.

    This field holds the SKU, if defined; otherwise the key; otherwise the ID.

    Settings

    Member Visibility

    On This Page

    Properties