Generated after a successful Set Price Custom Type update action.

interface ProductPriceCustomFieldsSetMessage {
    createdAt: string;
    createdBy?: CreatedBy;
    customField: CustomFields;
    id: string;
    lastModifiedAt: string;
    lastModifiedBy?: LastModifiedBy;
    oldTypeId?: string;
    priceId: string;
    resource: Reference;
    resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
    resourceVersion: number;
    sequenceNumber: number;
    staged: boolean;
    type: "ProductPriceCustomFieldsSet";
    variantId: number;
    version: number;
}

Properties

createdAt: string

Date and time (UTC) the Message was generated.

createdBy?: CreatedBy

IDs and references that created the Message.

customField: CustomFields

Custom Fields that were set.

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.

oldTypeId?: string

id of the previous Custom Type. Absent if there was no previous Custom Type present.

priceId: string

Unique identifier of the Price on which the Custom Type was set.

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: "ProductPriceCustomFieldsSet"
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.