Typescript SDK Type Docs
    Preparing search index...

    Interface SetShippingCustomFieldChange

    Change triggered by the Set Shipping CustomField update action.

    interface SetShippingCustomFieldChange {
        change: string;
        customTypeId: string;
        name: string;
        nextValue: any;
        previousValue: any;
        shippingKey: string;
        type: "SetShippingCustomFieldChange";
    }

    Hierarchy (View Summary)

    • IChange
      • SetShippingCustomFieldChange
    Index

    Properties

    change customTypeId name nextValue previousValue shippingKey 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.
    customTypeId: string

    id of the referenced Type.

    name: string

    Name of the Custom Field.

    nextValue: any

    Value after the change.

    previousValue: any

    Value before the change.

    shippingKey: string

    shippingKey of the updated Shipping.

    type: "SetShippingCustomFieldChange"

    Unique discriminator value to reliably deserialize the data type.

    Settings

    Member Visibility

    On This Page

    Properties