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

    Interface ProductPriceCustomFieldAddedMessage

    Generated after adding a Custom Field to a Price using the Set Price CustomField update action.

    interface ProductPriceCustomFieldAddedMessage {
        createdAt: string;
        createdBy?: CreatedBy;
        id: string;
        lastModifiedAt: string;
        lastModifiedBy?: LastModifiedBy;
        name: string;
        priceId: string;
        resource: Reference;
        resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
        resourceVersion: number;
        sequenceNumber: number;
        staged: boolean;
        type: "ProductPriceCustomFieldAdded";
        value: any;
        variantId: number;
        version: number;
    }

    Hierarchy (View Summary)

    • IMessage
      • ProductPriceCustomFieldAddedMessage
    Index

    Properties

    createdAt createdBy? id lastModifiedAt lastModifiedBy? name priceId resource resourceUserProvidedIdentifiers? resourceVersion sequenceNumber staged type value variantId 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 was added.

    priceId: string

    Unique identifier of the Price to which the Custom Field was added.

    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.

    staged: boolean

    Whether the update was only applied to the staged Product Projection.

    type: "ProductPriceCustomFieldAdded"

    Message Type of the Message.

    value: any

    The added CustomFieldValue based on the FieldType.

    variantId: number

    Unique identifier of the ProductVariant to which the Price belongs.

    version: number

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

    Settings

    Member Visibility

    On This Page

    Properties