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
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Published
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
removedImageUrlsArray 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. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Unpublished
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product State Transition
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
forceBoolean | Whether State transition validations were turned off during the Transition State update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Slug Changed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Image Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
variantIdInt | Unique identifier of the Product Variant to which the Image was added. |
image | Image that was added. |
stagedBoolean | Whether the update was only applied to the staged Product Projection. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Reverted Staged Changes
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
removedImageUrlsArray 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. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Price Key Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
keyString | MinLength: 2MaxLength: 256Pattern: ^[A-Za-z0-9_-]+$ |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
variantIdInt | |
priceIdString | Unique identifier of the Price. |
oldKeyString | MinLength: 2MaxLength: 256Pattern: ^[A-Za-z0-9_-]+$ |
stagedBoolean | Whether the update was only applied to the staged Product Projection. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Price Discounts Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
updatedPricesArray of ProductPriceDiscountsSetUpdatedPrice | Array containing details about the Embedded Prices that were updated. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Price Discounts Set Updated Price
variantIdInt | Unique identifier of the ProductVariant for which the Discount was set. |
variantKeyString | Key of the ProductVariant for which Discount was set. |
skuString | SKU of the ProductVariant for which Discount was set. |
priceIdString | Unique identifier of the Price. |
discounted | Discounted Price for the ProductVariant for which Discount was set. |
stagedBoolean | Whether the update was only applied to the staged ProductProjection. |
Product Price External Discount Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
variantIdInt | Unique identifier of the Product Variant for which the Discount was set. |
variantKeyString | Key of the Product Variant for which the Discount was set. |
skuString | SKU of the Product Variant for which Discount was set. |
priceIdString | Unique identifier of the Price. |
discounted | Discounted Price for the Product Variant for which Discount was set. |
stagedBoolean | Whether the update was only applied to the staged Product Projection. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Price Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
variantIdInt | Unique identifier of the ProductVariant for which the Price was added. |
price | The Embedded Price that was added to the ProductVariant. |
stagedBoolean | Whether the update was only applied to the staged Product Projection. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Price Changed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
variantIdInt | 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. |
stagedBoolean | 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. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Prices Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
variantIdInt | Unique identifier of the ProductVariant for which the Price was set. |
pricesArray of Price | The Embedded Prices that were set on the ProductVariant. |
stagedBoolean | Whether the update was only applied to the staged Product Projection. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Price Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
variantIdInt | Unique identifier of the ProductVariant for which the Price was removed. |
price | The Embedded Price that was removed from the ProductVariant. |
stagedBoolean | Whether the update was only applied to the staged Product Projection. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Price Mode Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Variant Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
stagedBoolean | Whether the update was only applied to the staged Product Projection. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Variant Deleted
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
removedImageUrlsArray of String | List of image URLs that were removed with the Remove Product Variant update action. |
stagedBoolean | 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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Added To Category
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | |
stagedBoolean | Whether the update was only applied to the staged Product Projection. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Removed From Category
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | |
stagedBoolean | Whether the update was only applied to the staged Product Projection. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Deleted
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
removedImageUrlsArray 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. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Price Custom Field Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
priceIdString | Unique identifier of the Price to which the Custom Field was added. |
variantIdInt | Unique identifier of the ProductVariant to which the Price belongs. |
stagedBoolean | Whether the update was only applied to the staged Product Projection. |
nameString | 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. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Price Custom Field Changed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
priceIdString | Unique identifier of the Price of which the Custom Field was changed. |
variantIdInt | Unique identifier of the ProductVariant to which the Price belongs. |
stagedBoolean | Whether the update was only applied to the staged Product Projection. |
nameString | Name of the Custom Field that was changed. |
value | |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Price Custom Field Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
priceIdString | Unique identifier of the Price from which the Custom Field was removed. |
variantIdInt | Unique identifier of the ProductVariant to which the Price belongs. |
stagedBoolean | Whether the update was only applied to the staged Product Projection. |
nameString | Name of the Custom Field that was removed. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Price Custom Fields Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
priceIdString | Unique identifier of the Price on which the Custom Type was set. |
variantIdInt | Unique identifier of the ProductVariant to which the Price belongs. |
stagedBoolean | Whether the update was only applied to the staged Product Projection. |
customField | Custom Fields that were set. |
oldTypeIdString | id of the previous Custom Type. Absent if there was no previous Custom Type present. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Price Custom Fields Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
priceIdString | Unique identifier of the Price from which the Custom Type was removed. |
variantIdInt | Unique identifier of the ProductVariant to which the Price belongs. |
stagedBoolean | Whether the update was only applied to the staged Product Projection. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Selection Messages
Product Selection Created
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Selection Product Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Selection Product Excluded
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Selection Product Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Selection Variant Selection Changed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Selection Variant Exclusion Changed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Selection Deleted
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Tailoring Messages
Product Tailoring Created
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
keyString | User-defined unique identifier of the Product Tailoring. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
productKeyString | 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. |
variantsArray of ProductVariantTailoring | The variants of the Product Tailoring at the time of creation. |
attributesBETAArray of ProductTailoringAttribute | Attributes of the tailored Product.
If available, these Attributes are selectively merged into the attributes of the corresponding Product. If the Product contains an Attribute with the same name, then its value is overwritten. Otherwise, the Attribute and its value are added to the Product. |
publishedBoolean | true if the ProductTailoring is published. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Tailoring Deleted
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
productKeyString | 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. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Tailoring Name Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
productKeyString | 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. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Tailoring Description Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
productKeyString | 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. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Tailoring Slug Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
productKeyString | 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. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Tailoring Published
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
productKeyString | 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. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Tailoring Unpublished
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
productKeyString | 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. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Variant Tailoring Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
productKeyString | key of the tailored Product. |
product | Reference to the tailored Product. |
variantIdInt | id of the ProductVariant added to the Tailoring. |
variant | The ProductVariantTailoring that was added to the ProductTailoring. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Variant Tailoring Removed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
productKeyString | key of the tailored Product. |
product | Reference to the Product the Product Tailoring belongs to. |
variantIdInt | id of the ProductVariant removed from the Tailoring. |
variant | The ProductVariantTailoring that was removed from the ProductTailoring. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Tailoring Image Added
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
productKeyString | key of the tailored Product. |
product | Reference to the tailored Product. |
variantIdInt | id of the tailored ProductVariant. |
image | Image that was added. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Product Tailoring Images Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
productKeyString | key of the tailored Product. |
product | Reference to the Product the Product Tailoring belongs to. |
variantIdInt | id of the tailored Product Variant. |
oldImagesArray of Image | |
imagesArray of Image | |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Category Messages
Category Created
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Category Slug Changed
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Inventory Entry Messages
InventoryEntry Created
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
InventoryEntry Deleted
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
skuString | The sku of the InventoryEntry that was deleted. |
supplyChannel | |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
InventoryEntry Quantity Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
oldQuantityOnStockInt | Quantity on stock for the InventoryEntry before the quantity was updated. |
newQuantityOnStockInt | Quantity on stock for the InventoryEntry after the quantity was updated. |
oldAvailableQuantityInt | Available quantity for the InventoryEntry before the quantity was updated. |
newAvailableQuantityInt | Available quantity for the InventoryEntry after the quantity was updated. |
skuString | SKU of the InventoryEntry for which the quantity was updated. |
supplyChannel | |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Review Messages
Review Created
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Review State Transition
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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 | |
oldIncludedInStatisticsBoolean | Whether the old Review was taken into account in the rating statistics of the target before the state transition. |
newIncludedInStatisticsBoolean | Whether the new Review was taken into account in the rating statistics of the target after the state transition. |
target | |
forceBoolean | Whether State transition validations were turned off during the Transition State update action. |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |
Review Rating Set
idString | Unique identifier of the Message. Can be used to track which Messages have been processed. |
versionInt | Version of a resource. In case of Messages, this is always 1. |
sequenceNumberInt | 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. |
resourceVersionInt | Version of the resource on which the change or action was performed. |
typeString | "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. |
oldRatingFloat | |
newRatingFloat | |
includedInStatisticsBoolean | Whether the Review was taken into account in the ratings statistics of the target. |
target | |
createdAt | Date and time (UTC) the Message was generated. |
createdByBETA | IDs and references that created the Message. |
lastModifiedAt | Value of createdAt. |
lastModifiedByBETA | IDs and references that last modified the Message. |