Product Catalog Messages
Messages that represent a change or an action performed on a Product, Product Selection, Product Tailoring, Category, Inventory Entry or Review.
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 Standalone Price Messages, see the Pricing and Discount Messages page.
Product Messages
Messages that represent a change or an action performed on a Product.
Product Created
Generated after a successful Create Product 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 | "ProductCreated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
productProjection | The staged Product Projection of the Product at the time of creation. |
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. |
Product Published
Generated after a successful Publish 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 | "ProductPublished" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
removedImageUrls Array of String | List of image URLs which were removed during the Publish update action. |
productProjection | Current Product Projection of the Product at the time of creation. |
scope | Publishing Scope that was used during the Publish 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. |
Product Unpublished
Generated after a successful Unpublish Product 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 | "ProductUnpublished" 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. |
Product State Transition
Generated after a successful Transition State 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 | "ProductStateTransition" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
state | Product State after the Transition State update action. |
force Boolean | Whether State transition validations were turned off during the Transition State 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. |
Product Slug Changed
Generated after a successful Change Slug 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 | "ProductSlugChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
slug | The slug of the Product after the Change Slug update action. |
oldSlug | The slug of the Product before the Change Slug 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. |
Product Image Added
Generated after a successful Add External Image update action or after the successful upload of an image.
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 | "ProductImageAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
variantId Int | Unique identifier of the Product Variant to which the Image was added. |
image | Image that was added. |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
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. |
Product Reverted Staged Changes
Generated after a successful Revert 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 | "ProductRevertedStagedChanges" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
removedImageUrls Array of String | List of image URLs that were removed during the Revert 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. |
Product Price Key Set
Generated after a successful Set Price 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 | "ProductPriceKeySet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
variantId Int | |
priceId String | Unique identifier of the Price. |
oldKey String |
2 MaxLength: 256 Pattern: ^[A-Za-z0-9_-]+$ |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
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. |
Product Price Discounts Set
Generated after a Price is updated due to a Product Discount.
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 | "ProductPriceDiscountsSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
updatedPrices Array of ProductPriceDiscountsSetUpdatedPrice | Array containing details about the Embedded Prices that were updated. |
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. |
Product Price Discounts Set Updated Price
Details about an Embedded Price that was updated due to a Discount. Specific to Product Price Discounts Set Message.
variantId Int | Unique identifier of the ProductVariant for which the Discount was set. |
variantKey String | Key of the ProductVariant for which Discount was set. |
sku String | SKU of the ProductVariant for which Discount was set. |
priceId String | Unique identifier of the Price. |
discounted | Discounted Price for the ProductVariant for which Discount was set. |
staged Boolean | Whether the update was only applied to the staged ProductProjection. |
Product 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 | "ProductPriceExternalDiscountSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
variantId Int | Unique identifier of the Product Variant for which the Discount was set. |
variantKey String | Key of the Product Variant for which the Discount was set. |
sku String | SKU of the Product Variant for which Discount was set. |
priceId String | Unique identifier of the Price. |
discounted | Discounted Price for the Product Variant for which Discount was set. |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
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. |
Product Price Added
Generated after a successful Add 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 | "ProductPriceAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
variantId Int | Unique identifier of the ProductVariant for which the Price was added. |
price | The Embedded Price that was added to the ProductVariant. |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
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. |
Product Price Changed
Generated after a successful Change 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 | "ProductPriceChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
variantId Int | Unique identifier of the ProductVariant for which the Price was changed. |
oldPrice | The current Embedded Price before the Change Embedded Price update action. |
newPrice | The Embedded Price after the Change Embedded Price update action. |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
oldStagedPrice | The staged Embedded Price before the Change Embedded Price 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. |
Product Prices Set
Generated after a successful Set Prices 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 | "ProductPricesSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
variantId Int | Unique identifier of the ProductVariant for which the Price was set. |
prices Array of Price | The Embedded Prices that were set on the ProductVariant. |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
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. |
Product Price Removed
Generated after a successful Remove 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 | "ProductPriceRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
variantId Int | Unique identifier of the ProductVariant for which the Price was removed. |
price | The Embedded Price that was removed from the ProductVariant. |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
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. |
Product Price Mode Set
Generated after a successful Set PriceMode 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 | "ProductPriceModeSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
The PriceMode that was set. | |
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. |
Product Variant Added
Generated after a successful Add ProductVariant 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 | "ProductVariantAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
variant | Unique identifier of the Product Variant that was added. |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
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. |
Product Variant Deleted
Generated after a successful Remove ProductVariant 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 | "ProductVariantDeleted" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
variant | Unique identifier of the Product Variant that was added. |
removedImageUrls Array of String | List of image URLs that were removed with the Remove Product Variant update action. |
staged Boolean | If |
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. |
Product Added To Category
Generated after a successful Add to Category 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 | "ProductAddedToCategory" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
category | |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
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. |
Product Removed From Category
Generated after a successful Remove from Category 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 | "ProductRemovedFromCategory" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
category | |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
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. |
Product Deleted
Generated after a successful Delete Product 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 | "ProductDeleted" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
removedImageUrls Array of String | List of image URLs that were removed during the Delete Product request. |
currentProjection | Current Product Projection of the deleted Product. |
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. |
Product Price Custom Field Added
Generated after adding a Custom Field to a Price using the Set Price CustomField 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 | "ProductPriceCustomFieldAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
priceId String | Unique identifier of the Price to which the Custom Field was added. |
variantId Int | Unique identifier of the ProductVariant to which the Price belongs. |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
name String | Name of the Custom Field that was added. |
value | The added CustomFieldValue based on the FieldType. |
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. |
Product Price Custom Field Changed
Generated after changing an existing Custom Field on a Price using the Set Price CustomField 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 | "ProductPriceCustomFieldChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
priceId String | Unique identifier of the Price of which the Custom Field was changed. |
variantId Int | Unique identifier of the ProductVariant to which the Price belongs. |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
name String | Name of the Custom Field that was changed. |
value | CustomFieldValue based on the FieldType after the Set Price CustomField 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. |
Product Price Custom Field Removed
Generated after removing a Custom Field from a Price using the Set Price CustomField 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 | "ProductPriceCustomFieldRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
priceId String | Unique identifier of the Price from which the Custom Field was removed. |
variantId Int | Unique identifier of the ProductVariant to which the Price belongs. |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
name String | Name of the Custom Field that was removed. |
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. |
Product Price Custom Fields Set
Generated after a successful Set Price Custom Type 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 | "ProductPriceCustomFieldsSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
priceId String | Unique identifier of the Price on which the Custom Type was set. |
variantId Int | Unique identifier of the ProductVariant to which the Price belongs. |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
customField | Custom Fields that were set. |
oldTypeId String |
|
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. |
Product Price Custom Fields Removed
Generated after removing a Custom Type from a Price using the Set Price Custom Type 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 | "ProductPriceCustomFieldsRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
priceId String | Unique identifier of the Price from which the Custom Type was removed. |
variantId Int | Unique identifier of the ProductVariant to which the Price belongs. |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
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. |
Product Selection Messages
Messages that represent a change or an action performed on a Product Selection.
Product Selection Created
Generated after a successful Create Product Selection 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 | "ProductSelectionCreated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
productSelection | Product Selection 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. |
Product Selection Product Added
Generated after a successful Add Product 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 | "ProductSelectionProductAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
product | Product that was added to the Product Selection. |
variantSelection | Product Variant Selection after the Add Product 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. |
Product Selection Product Excluded
Generated after a successful Exclude Product 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 | "ProductSelectionProductExcluded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
product | Product that was excluded from the Product Selection. |
variantExclusion | Product Variant Exclusion after the Exclude Product 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. |
Product Selection Product Removed
Generated after a successful Remove Product 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 | "ProductSelectionProductRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
product | Product that was removed from the Product Selection. |
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. |
Product Selection Variant Selection Changed
Generated after a successful Set Variant Selection 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 | "ProductSelectionVariantSelectionChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
product | Product for which the Product Variant Selection changed. |
oldVariantSelection | Product Variant Selection before the Set Variant Selection update action. |
newVariantSelection | Product Variant Selection after the Set Variant Selection 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. |
Product Selection Variant Exclusion Changed
Generated after a successful Set Variant Exclusion 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 | "ProductSelectionVariantExclusionChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
product | Product for which the Product Variant Exclusion changed. |
oldVariantExclusion | Product Variant Exclusion before the Set Variant Exclusion update action. |
newVariantExclusion | Product Variant Exclusion after the Set Variant Exclusion 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. |
Product Selection Deleted
Generated after a successful Delete Product Selection 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 | "ProductSelectionDeleted" 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. |
Product Tailoring Messages
Messages that represent a change or an action performed on a Product Tailoring.
Product Tailoring Created
Generated after a successful Create Product Tailoring or Create Product Tailoring in Store 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 |
key String | User-defined unique identifier of the Product Tailoring. |
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 | "ProductTailoringCreated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
store | The Store to which the Product Tailoring belongs. |
productKey String | User-defined unique identifier of the Product this Product Tailoring belongs to. |
product | Reference to the Product the Product Tailoring belongs to. |
description | The description of the Product Tailoring at the time of creation. |
name | The name of the Product Tailoring at the time of creation. |
slug | The slug of the Product Tailoring at the time of creation. |
metaTitle | The metaTitle of the Product Tailoring at the time of creation. |
metaDescription | The metaDescription of the Product Tailoring at the time of creation. |
metaKeywords | The metaKeywords of the Product Tailoring at the time of creation. |
variants Array of ProductVariantTailoring | The variants of the Product Tailoring at the time of creation. |
published Boolean |
|
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. |
Product Tailoring Deleted
Generated after a successful Delete Product Tailoring or Delete ProductTailoring assigned to Product in Store 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 | "ProductTailoringDeleted" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
store | The Store to which the Product Tailoring belongs. |
productKey String | User-defined unique identifier of the Product this Product Tailoring belongs to. |
product | Reference to the Product the Product Tailoring belongs to. |
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. |
Product Tailoring Name Set
Generated after a successful Product Tailoring Set Name 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 | "ProductTailoringNameSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
store | The Store to which the Product Tailoring belongs. |
productKey String | User-defined unique identifier of the Product this Product Tailoring belongs to. |
product | Reference to the Product the Product Tailoring belongs to. |
name | The name of the Product Tailoring after the Set Name update action. |
oldName | The name of the ProductTailoring before the Set Name 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. |
Product Tailoring Description Set
Generated after a successful Product Tailoring Set Description 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 | "ProductTailoringDescriptionSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
store | The Store to which the Product Tailoring belongs. |
productKey String | User-defined unique identifier of the Product this Product Tailoring belongs to. |
product | Reference to the Product the Product Tailoring belongs to. |
description | The description of the Product Tailoring after the Set Description update action. |
oldDescription | The description of the ProductTailoring before the Set Description 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. |
Product Tailoring Slug Set
Generated after a successful Product Tailoring Set Slug 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 | "ProductTailoringSlugSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
store | The Store to which the Product Tailoring belongs. |
productKey String | User-defined unique identifier of the Product this Product Tailoring belongs to. |
product | Reference to the Product the Product Tailoring belongs to. |
slug | The slug of the Product Tailoring after the Set Slug update action. |
oldSlug | The slug of the ProductTailoring before the Set Slug 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. |
Product Tailoring Published
Generated after a successful Product Tailoring Publish 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 | "ProductTailoringPublished" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
store | The Store to which the Product Tailoring belongs. |
productKey String | User-defined unique identifier of the Product this Product Tailoring belongs to. |
product | Reference to the Product the Product Tailoring belongs to. |
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. |
Product Tailoring Unpublished
Generated after a successful Product Tailoring Unpublish 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 | "ProductTailoringUnpublished" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
store | The Store to which the Product Tailoring belongs. |
productKey String | User-defined unique identifier of the Product this Product Tailoring belongs to. |
product | Reference to the Product the Product Tailoring belongs to. |
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. |
Product Variant Tailoring Added
Generated after a successful Add ProductVariant Tailoring 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 | "ProductVariantTailoringAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
store | The Store to which the Product Tailoring belongs. |
productKey String |
|
product | Reference to the tailored Product. |
variantId Int |
|
variant | The ProductVariantTailoring that was added to the ProductTailoring. |
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. |
Product Variant Tailoring Removed
Generated after a successful Remove ProductVariant Tailoring 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 | "ProductVariantTailoringRemoved" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
store | The Store to which the Product Tailoring belongs. |
productKey String |
|
product | Reference to the Product the Product Tailoring belongs to. |
variantId Int |
|
variant | The ProductVariantTailoring that was removed from the ProductTailoring. |
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. |
Product Tailoring Image Added
Generated after a successful Add External Image update action or after a successful Upload Product Tailoring image 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 | "ProductTailoringImageAdded" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
store | The Store to which the Product Tailoring belongs. |
productKey String |
|
product | Reference to the tailored Product. |
variantId Int |
|
image | Image that was added. |
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. |
Product Tailoring Images Set
Generated after a successful Set Images 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 | "ProductTailoringImagesSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
store | The Store to which the Product Tailoring belongs. |
productKey String |
|
product | Reference to the Product the Product Tailoring belongs to. |
variantId Int |
|
oldImages Array of Image | Images on the tailored Product Variant before the Set Images update action. |
images Array of Image | Images on the tailored Product Variant after the Set Images 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. |
Category Messages
Messages that represent a change or an action performed on a Category.
Category Created
Generated after a successful Create Category 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 | "CategoryCreated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
category | Category 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. |
Category Slug Changed
Generated after a successful Change Slug 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 | "CategorySlugChanged" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
slug | The slug of the Category after the Change Slug update action. |
oldSlug | The slug of the Category before the Change Slug 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. |
Inventory Entry Messages
Messages that represent a change or an action performed on an Inventory Entry.
InventoryEntry Created
Generated after a successful Create InventoryEntry 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 | "InventoryEntryCreated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
inventoryEntry | InventoryEntry 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. |
InventoryEntry Deleted
Generated after a successful Delete InventoryEntry 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 | "InventoryEntryDeleted" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
sku String | The |
supplyChannel | Reference to the Channel where the InventoryEntry was deleted. |
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. |
InventoryEntry Quantity Set
Generated after a successful Add Quantity, Remove Quantity or Change Quantity update action. Inventory changes as a result of Order creation do not trigger this message.
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 | "InventoryEntryQuantitySet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
oldQuantityOnStock Int | Quantity on stock for the InventoryEntry before the quantity was updated. |
newQuantityOnStock Int | Quantity on stock for the InventoryEntry after the quantity was updated. |
oldAvailableQuantity Int | Available quantity for the InventoryEntry before the quantity was updated. |
newAvailableQuantity Int | Available quantity for the InventoryEntry after the quantity was updated. |
supplyChannel | Reference to the Channel where the InventoryEntry quantity was set. |
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. |
Review Messages
Messages that represent a change or an action performed on a Review.
Review Created
Generated after a successful Create Review 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 | "ReviewCreated" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
review | Review 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. |
Review State Transition
Generated after a successful Transition State 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 | "ReviewStateTransition" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
oldState | State of the Review before the Transition State update action. |
newState | State of the Review after the Transition State update action. |
oldIncludedInStatistics Boolean | Whether the old Review was taken into account in the rating statistics of the target before the state transition. |
newIncludedInStatistics Boolean | Whether the new Review was taken into account in the rating statistics of the target after the state transition. |
target | |
force Boolean | Whether State transition validations were turned off during the Transition State 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. |
Review Rating Set
Generated after a successful Set Rating 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 | "ReviewRatingSet" Message Type of the Message. |
resourceUserProvidedIdentifiers | User-provided identifiers of the resource, such as |
oldRating Float | The |
newRating Float | The |
includedInStatistics Boolean | Whether the Review was taken into account in the ratings statistics of the target. |
target | |
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. |