Interface ProductPriceChangedMessage

Generated after a successful Change Price update action.

interface ProductPriceChangedMessage {
    createdAt: string;
    createdBy?: CreatedBy;
    id: string;
    lastModifiedAt: string;
    lastModifiedBy?: LastModifiedBy;
    newPrice: Price;
    oldPrice: Price;
    oldStagedPrice?: Price;
    resource: Reference;
    resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
    resourceVersion: number;
    sequenceNumber: number;
    staged: boolean;
    type: "ProductPriceChanged";
    variantId: number;
    version: number;
}

Properties

createdAt createdBy? id lastModifiedAt lastModifiedBy? newPrice oldPrice oldStagedPrice? resource resourceUserProvidedIdentifiers? resourceVersion sequenceNumber staged type variantId version

Properties

Readonly createdAt

createdAt: string

Date and time (UTC) the Message was generated.

Optional Readonly createdBy

createdBy?: CreatedBy

IDs and references that created the Message.

Readonly id

id: string

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

Readonly lastModifiedAt

lastModifiedAt: string

Value of createdAt.

Optional Readonly lastModifiedBy

lastModifiedBy?: LastModifiedBy

IDs and references that last modified the Message.

Readonly newPrice

newPrice: Price

The Embedded Price after the Change Embedded Price update action.

Readonly oldPrice

oldPrice: Price

The current Embedded Price before the Change Embedded Price update action.

Optional Readonly oldStagedPrice

oldStagedPrice?: Price

The staged Embedded Price before the Change Embedded Price update action.

Readonly resource

resource: Reference

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

Optional Readonly resourceUserProvidedIdentifiers

resourceUserProvidedIdentifiers?: UserProvidedIdentifiers

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

Readonly resourceVersion

resourceVersion: number

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

Readonly sequenceNumber

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.

Readonly staged

staged: boolean

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

Readonly type

type: "ProductPriceChanged"

Readonly variantId

variantId: number

Unique identifier of the ProductVariant for which the Price was changed.

Readonly version

version: number

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

Settings

Member Visibility

Theme

On This Page

createdAtcreatedByidlastModifiedAtlastModifiedBynewPriceoldPriceoldStagedPriceresourceresourceUserProvidedIdentifiersresourceVersionsequenceNumberstagedtypevariantIdversion