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

    Interface OrderCustomFieldChangedMessage

    Generated when an existing Custom Field has been changed using the Set CustomField action.

    interface OrderCustomFieldChangedMessage {
        createdAt: string;
        createdBy?: CreatedBy;
        id: string;
        lastModifiedAt: string;
        lastModifiedBy?: LastModifiedBy;
        name: string;
        previousValue?: any;
        resource: Reference;
        resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
        resourceVersion: number;
        sequenceNumber: number;
        type: "OrderCustomFieldChanged";
        value: any;
        version: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    createdAt createdBy? id lastModifiedAt lastModifiedBy? name previousValue? resource resourceUserProvidedIdentifiers? resourceVersion sequenceNumber type value version

    Properties

    createdAt: string

    Date and time (UTC) the Message was generated.

    createdBy?: CreatedBy

    IDs and references that created the Message.

    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.

    name: string

    Name of the Custom Field that changed.

    previousValue?: any

    CustomFieldValue based on the FieldType before the Set CustomField update action. When there has not been a Custom Field with the name on the Order before, an Order Custom Field Added Message is generated instead.

    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.

    type: "OrderCustomFieldChanged"

    Message Type of the Message.

    value: any

    CustomFieldValue based on the FieldType after the Set CustomField update action.

    version: number

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

    Settings

    Member Visibility

    On This Page

    Properties