Pricing and Discount Messages
Messages that represent a change or an action performed on a Cart Discount, Discount Code, or Standalone Price.
Messages are available in a variety of Message Types specific to a resource. Common fields across all Message Types are represented by a base resource, Message.
You can access Messages either by querying the Messages API, or by subscribing to them with a Subscription. To query Messages using the API, you must enable the feature first.
For Embedded Price related Messages, see the Product Catalog Messages page.
Cart Discount Messages
Messages that represent a change or an action performed on a Cart Discount.
Cart Discount Created
Generated after a successful Create CartDiscount request.
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CartDiscountCreated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
cartDiscount | The Cart Discount that was created. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Cart Discount Deleted
Generated after a successful Delete CartDiscount request.
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CartDiscountDeleted" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Cart Discount Store Added
Generated after a successful Add Store update action.
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CartDiscountStoreAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
store | The Store that was added to the Cart Discount. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Cart Discount Store Removed
Generated after a successful Remove Store update action.
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CartDiscountStoreRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
store | The Store that was removed from the Cart Discount. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Cart Discount Stores Set
Generated after a successful Set Stores update action.
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "CartDiscountStoresSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
stores Array of StoreKeyReference | Stores of the Cart Discount after the Set Stores update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Discount Code Messages
Messages that represent a change or an action performed on a Discount Code.
Discount Code Created
Generated after a successful Create DiscountCode request.
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "DiscountCodeCreated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
discountCode | The Discount Code that was created. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Discount Code Deleted
Generated after a successful Delete DiscountCode request.
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "DiscountCodeDeleted" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Discount Code Key Set
Generated after a successful Set Key update action.
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
key String |
2 MaxLength: 256 Pattern: ^[A-Za-z0-9_-]+$ |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "DiscountCodeKeySet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
oldKey String |
2 MaxLength: 256 Pattern: ^[A-Za-z0-9_-]+$ |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Standalone Price Messages
Messages that represent a change or an action performed on a StandalonePrice.
Standalone Price Created
Generated after a successful Create StandalonePrice request.
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "StandalonePriceCreated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
standalonePrice | Standalone Price that was created. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Standalone Price Deleted
Generated after a successful Delete StandalonePrice request.
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "StandalonePriceDeleted" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
sku String | SKU of the ProductVariant to which the deleted Standalone Price was associated. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Standalone Price Value Changed
Generated after a successful Change Value update action.
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "StandalonePriceValueChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
value | The new value of the updated StandalonePrice. |
staged Boolean | Whether the new value was applied to the current or the staged representation of the StandalonePrice. Staged changes are stored on the StagedStandalonePrice. Default:false |
oldValue | The old value of the updated StandalonePrice. Present on Messages created after 3 February 2023. Optional for backwards compatibility. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Standalone Price Key Set
Generated after a successful Set Key update action.
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
key String |
2 MaxLength: 256 Pattern: ^[A-Za-z0-9_-]+$ |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "StandalonePriceKeySet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
oldKey String |
2 MaxLength: 256 Pattern: ^[A-Za-z0-9_-]+$ |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Standalone Price Discount Set
Generated after a Product Discount is successfully applied to a StandalonePrice.
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "StandalonePriceDiscountSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
discounted | The new |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Standalone Price External Discount Set
Generated after a successful Set Discounted Price update action.
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "StandalonePriceExternalDiscountSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
discounted | The |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Standalone Price Staged Changes Applied
Generated after a successful Apply Staged Changes update action.
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "StandalonePriceStagedChangesApplied" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
stagedChanges | Applied changes of the StandalonePrice after the Apply Staged Changes update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Standalone Price Staged Changes Removed
Generated after a successful Remove Staged Changes update action.
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "StandalonePriceStagedChangesRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
stagedChanges | Removed changes of the StandalonePrice after the Remove Staged Changes update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Standalone Price Active Changed
Generated after a successful Change Active update action.
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "StandalonePriceActiveChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
active Boolean | Value of the |
oldActive Boolean | Value of the |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Standalone Price Valid From Set
Generated after a successful Set Valid From update action.
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "StandalonePriceValidFromSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
validFrom | Value of StandalonePrice |
previousValidFrom | Value of StandalonePrice |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Standalone Price Valid Until Set
Generated after a successful Set Valid Until update action.
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "StandalonePriceValidUntilSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
validUntil | Value of StandalonePrice |
previousValidUntil | Value of StandalonePrice |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Standalone Price Valid From and Until Set
Generated after a successful Set Valid From and Until update action.
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "StandalonePriceValidFromAndUntilSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
validFrom | Value of StandalonePrice |
previousValidFrom | Value of StandalonePrice |
validUntil | Value of StandalonePrice |
previousValidUntil | Value of StandalonePrice |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Standalone Price Tier Added
Generated after a successful Add Price Tier update action
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "StandalonePriceTierAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
tier | The Price Tier that has been added to the array field |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Standalone Price Tier Removed
Generated after a successful Remove Price Tier update action
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "StandalonePriceTierRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
removedTier | The Price Tier that has been removed from the array field |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Standalone Price Tiers Set
Generated after a successful Set Price Tier update action
id String | Unique identifier of the Message. Can be used to track which Messages have been processed. |
version Int | Version of a resource. In case of Messages, this is always |
sequenceNumber Int | Message number in relation to other Messages for a given resource. The |
resource | Reference to the resource on which the change or action was performed. |
resourceVersion Int | Version of the resource on which the change or action was performed. |
type String | "StandalonePriceTiersSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
tiers Array of PriceTier | The updated content of the field |
previousTiers Array of PriceTier | The previous content of the field |
createdAt | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt | Value of |
lastModifiedBy BETA | IDs and references that last modified the Message. |