@gradientedge/commercetools-utils
    Preparing search index...

    Interface LineItemStateTransitionMessage

    Generated after a successful Transition LineItem State update action.

    interface LineItemStateTransitionMessage {
        createdAt: string;
        createdBy?: CreatedBy;
        fromState: StateReference;
        id: string;
        lastModifiedAt: string;
        lastModifiedBy?: LastModifiedBy;
        lineItemId: string;
        lineItemKey?: string;
        quantity: number;
        resource: Reference;
        resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
        resourceVersion: number;
        sequenceNumber: number;
        toState: StateReference;
        transitionDate: string;
        type: "LineItemStateTransition";
        version: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    createdAt createdBy? fromState id lastModifiedAt lastModifiedBy? lineItemId lineItemKey? quantity resource resourceUserProvidedIdentifiers? resourceVersion sequenceNumber toState transitionDate type version

    Properties

    createdAt: string

    Date and time (UTC) the Message was generated.

    createdBy?: CreatedBy

    IDs and references that created the Message.

    fromState: StateReference

    State the Line Item was transitioned from.

    id: string

    Unique identifier of the Message. Can be used to track which Messages have been processed.

    lastModifiedAt: string

    Value of createdAt.

    lastModifiedBy?: LastModifiedBy

    IDs and references that last modified the Message.

    lineItemId: string

    Unique identifier of the Line Item.

    lineItemKey?: string

    User-defined unique identifier of the LineItem.

    quantity: number

    Number of Line Items for which the State was transitioned.

    resource: Reference

    Reference to the resource on which the change or action was performed.

    resourceUserProvidedIdentifiers?: UserProvidedIdentifiers

    User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

    resourceVersion: number

    Version of the resource on which the change or action was performed.

    sequenceNumber: number

    Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

    toState: StateReference

    State the Line Item was transitioned to.

    transitionDate: string

    Date and time (UTC) the transition of the Line Item State was performed.

    type: "LineItemStateTransition"

    Message Type of the Message.

    version: number

    Version of a resource. In case of Messages, this is always 1.

    Settings

    Member Visibility

    On This Page

    Properties