Typescript SDK Type Docs
    Preparing search index...

    Interface UpdateSyncInfoChange

    Change triggered by the following update actions:

    - [Update SyncInfo](ctp:api:type:OrderUpdateSyncInfoAction) on Orders.
- [Update SyncInfo](ctp:api:type:StagedOrderUpdateSyncInfoAction) on Staged Orders.
    interface UpdateSyncInfoChange {
        change: string;
        channelId: string;
        nextValue: SyncInfo;
        type: "UpdateSyncInfoChange";
    }

    Hierarchy (View Summary)

    Index

    Properties

    change channelId nextValue 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.
    channelId: string

    id of the updated Channel.

    nextValue: SyncInfo

    Value after the change.

    type: "UpdateSyncInfoChange"

    Unique discriminator value to reliably deserialize the data type.

    Settings

    Member Visibility

    On This Page

    Properties