Messages that represent a change or an action performed on a Product, Product Selection, Product Tailoring, Category, Inventory Entry or Review.
Product Messages
Product Created
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
productProjection | The staged Product Projection of the Product at the time of creation. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Published
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Unpublished
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product State Transition
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Slug Changed
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Image Added
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Reverted Staged Changes
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
removedImageUrls Array of String | List of image URLs that were removed during the Revert Staged Changes update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Price Key Set
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 1 . |
key String | MinLength: 2 MaxLength: 256 Pattern: ^[A-Za-z0-9_-]+$ |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
variantId Int | |
priceId String | Unique identifier of the Price. |
oldKey String | MinLength: 2 MaxLength: 256 Pattern: ^[A-Za-z0-9_-]+$ |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Price Discounts Set
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
updatedPrices Array of ProductPriceDiscountsSetUpdatedPrice | Array containing details about the Embedded Prices that were updated. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Price Discounts Set Updated Price
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
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Price Added
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Price Changed
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Prices Set
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Price Removed
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Price Mode Set
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
The PriceMode that was set. | |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Variant Added
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
variant | Unique identifier of the Product Variant that was added. |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Variant Deleted
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 true , this message informs that only the staged ProductVariant has been removed by the update action.
If false , both the current and staged ProductVariant have been removed. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Added To Category
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
category | |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Removed From Category
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
category | |
staged Boolean | Whether the update was only applied to the staged Product Projection. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Deleted
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Price Custom Field Added
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Price Custom Field Changed
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 | |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Price Custom Field Removed
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Price Custom Fields Set
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 | id of the previous Custom Type. Absent if there was no previous Custom Type present. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Price Custom Fields Removed
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Selection Messages
Product Selection Created
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
productSelection | Product Selection that was created. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Selection Product Added
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
product | Product that was added to the Product Selection. |
variantSelection | Product Variant Selection after the Add Product update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Selection Product Excluded
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
product | Product that was excluded from the Product Selection. |
variantExclusion | Product Variant Exclusion after the Exclude Product update action. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Selection Product Removed
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
product | Product that was removed from the Product Selection. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Selection Variant Selection Changed
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Selection Variant Exclusion Changed
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Selection Deleted
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Tailoring Messages
Product Tailoring Created
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 1 . |
key String | User-defined unique identifier of the Product Tailoring. |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 | true if the ProductTailoring is published. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Tailoring Deleted
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Tailoring Name Set
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Tailoring Description Set
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Tailoring Slug Set
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Tailoring Published
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Tailoring Unpublished
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Variant Tailoring Added
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
store | The Store to which the Product Tailoring belongs. |
productKey String | key of the tailored Product. |
product | Reference to the tailored Product. |
variantId Int | id of the ProductVariant added to the Tailoring. |
variant | The ProductVariantTailoring that was added to the ProductTailoring. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Variant Tailoring Removed
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
store | The Store to which the Product Tailoring belongs. |
productKey String | key of the tailored Product. |
product | Reference to the Product the Product Tailoring belongs to. |
variantId Int | id of the ProductVariant removed from the Tailoring. |
variant | The ProductVariantTailoring that was removed from the ProductTailoring. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Tailoring Image Added
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
store | The Store to which the Product Tailoring belongs. |
productKey String | key of the tailored Product. |
product | Reference to the tailored Product. |
variantId Int | id of the tailored ProductVariant. |
image | Image that was added. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Product Tailoring Images Set
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
store | The Store to which the Product Tailoring belongs. |
productKey String | key of the tailored Product. |
product | Reference to the Product the Product Tailoring belongs to. |
variantId Int | id of the tailored Product Variant. |
oldImages Array of Image | |
images Array of Image | |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Category Messages
Category Created
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
category | Category that was created. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Category Slug Changed
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Inventory Entry Messages
InventoryEntry Created
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
inventoryEntry | InventoryEntry that was created. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
InventoryEntry Deleted
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
sku String | The sku of the InventoryEntry that was deleted. |
supplyChannel | |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
InventoryEntry Quantity Set
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
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 | |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Review Messages
Review Created
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
review | Review that was created. |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Review State Transition
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
oldState | |
newState | |
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 DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |
Review Rating Set
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 1 . |
sequenceNumber Int | 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 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 key or externalId . Only present if the resource has such identifiers. |
oldRating Float | |
newRating Float | |
includedInStatistics Boolean | Whether the Review was taken into account in the ratings statistics of the target. |
target | |
createdAt DateTime | Date and time (UTC) the Message was generated. |
createdBy BETA | IDs and references that created the Message. |
lastModifiedAt DateTime | Value of createdAt . |
lastModifiedBy BETA | IDs and references that last modified the Message. |