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

    Interface CustomLineItemStateTransitionMessage

    Generated after a successful Transition CustomLineItem State update action.

    interface CustomLineItemStateTransitionMessage {
        createdAt: string;
        createdBy?: CreatedBy;
        customLineItemId: string;
        customLineItemKey?: string;
        fromState: StateReference;
        id: string;
        lastModifiedAt: string;
        lastModifiedBy?: LastModifiedBy;
        quantity: number;
        resource: Reference;
        resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
        resourceVersion: number;
        sequenceNumber: number;
        toState: StateReference;
        transitionDate: string;
        type: "CustomLineItemStateTransition";
        version: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    createdAt createdBy? customLineItemId customLineItemKey? fromState id lastModifiedAt lastModifiedBy? 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.

    customLineItemId: string

    Unique identifier of the Custom Line Item.

    customLineItemKey?: string

    User-defined unique identifier of the Custom Line Item.

    fromState: StateReference

    State the Custom 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.

    quantity: number

    Number of Custom 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 Custom Line Item was transitioned to.

    transitionDate: string

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

    type: "CustomLineItemStateTransition"

    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