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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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 createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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 createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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 createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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 createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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 createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
key​
String​
key value of the Discount Code after the Set Key update action.
MinLength: 2​MaxLength: 256​Pattern: ^[A-Za-z0-9_-]+$​
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
oldKey​
String​
key value of the Discount Code before the Set Key update action.
MinLength: 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 createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Discount Group Messages

Messages that represent a change or an action performed on a Discount Group.

Discount Group Created

Generated after a successful Create DiscountGroup request.
id​
String​

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

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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

type​
String​
"DiscountGroupCreated"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
discountGroup​

The DiscountGroup that was created.

createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Discount Group Deleted

Generated after a successful Delete DiscountGroup request.
id​
String​

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

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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

type​
String​
"DiscountGroupDeleted"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Discount Group 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​
Int64​
Version of a resource. In case of Messages, this is always 1.
key​
String​
key value of the DiscountGroup after the Set Key update action.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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

type​
String​
"DiscountGroupKeySet"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
oldKey​
String​
key value of the DiscountGroup before the Set Key update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Discount Group IsActive Set

Generated after a successful Set IsActive update action.
id​
String​

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

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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

type​
String​
"DiscountGroupIsActiveSet"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
isActive​
Boolean​
isActive value of the DiscountGroup after the Set IsActive update action.
oldIsActive​
Boolean​
isActive value of the DiscountGroup before the Set IsActive update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Discount Group Sort Order Set

Generated after a successful Set SortOrder update action.
id​
String​

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

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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

type​
String​
"DiscountGroupSortOrderSet"
Message Type of the Message.
resourceUserProvidedIdentifiers​
User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.
sortOrder​
String​
sortOrder value of the DiscountGroup after the Set SortOrder update action.
oldSortOrder​
String​
sortOrder value of the DiscountGroup before the Set SortOrder update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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 createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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 createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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 createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
key​
String​
key value of the StandalonePrice after the Set Key update action.
MinLength: 2​MaxLength: 256​Pattern: ^[A-Za-z0-9_-]+$​
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
oldKey​
String​
key value of the StandalonePrice before the Set Key update action.
MinLength: 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 createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
discounted​
The new discounted value of the updated StandalonePrice.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
discounted​
The discounted value of the StandalonePrice after the Set Discounted Price update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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 createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
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 createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
active​
Boolean​
Value of the active field of the StandalonePrice after the Change Active update action.
oldActive​
Boolean​
Value of the active field of the StandalonePrice before the Change Active update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
validFrom​
Value of StandalonePrice validFrom after the Set Valid From update action.
previousValidFrom​
Value of StandalonePrice validFrom before the Set Valid From update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
validUntil​
Value of StandalonePrice validUntil after the Set Valid Until update action.
previousValidUntil​
Value of StandalonePrice validUntil before the Set Valid Until update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
validFrom​
Value of StandalonePrice validFrom after the Set Valid From and Until update action.
previousValidFrom​
Value of StandalonePrice validFrom before the Set Valid From and Until update action.
validUntil​
Value of StandalonePrice validUntil after the Set Valid From and Until update action.
previousValidUntil​
Value of StandalonePrice validUntil before the Set Valid From and Until update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
tier​
The Price Tier that has been added to the array field tiers for the StandalonePrice.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
removedTier​
The Price Tier that has been removed from the array field tiers for the StandalonePrice.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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.
resource​
Reference to the resource on which the change or action was performed.
resourceVersion​
Int64​

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 key or externalId. Only present if the resource has such identifiers.
tiers​
Array of PriceTier​
The updated content of the field tiers of the affected StandalonePrice.
previousTiers​
Array of PriceTier​
The previous content of the field tiers of the affected StandalonePrice.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.