Typescript SDK Type Docs
    Preparing search index...

    Interface SetCustomLineItemCustomTypeChange

    Change triggered by the following update actions:

    - [Set CustomLineItem CustomField](ctp:api:type:OrderSetCustomLineItemCustomTypeAction) on Orders.
- [Set CustomLineItem CustomField](ctp:api:type:StagedOrderSetCustomLineItemCustomTypeAction) on Staged Orders.
    interface SetCustomLineItemCustomTypeChange {
        change: string;
        customLineItem: LocalizedString;
        customLineItemId: string;
        nextValue: CustomFields;
        previousValue: CustomFields;
        type: "SetCustomLineItemCustomTypeChange";
    }

    Hierarchy (View Summary)

    • IChange
      • SetCustomLineItemCustomTypeChange
    Index

    Properties

    change customLineItem customLineItemId nextValue previousValue type

    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.
    customLineItem: LocalizedString

    Name of the updated CustomLineItem.

    customLineItemId: string

    id of the updated CustomLineItem.

    nextValue: CustomFields

    Value after the change.

    previousValue: CustomFields

    Value before the change.

    type: "SetCustomLineItemCustomTypeChange"

    Unique discriminator value to reliably deserialize the data type.

    Settings

    Member Visibility

    On This Page

    Properties