Messages that represent a change or an action performed on a Store.
Store Messages
Store 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 | "StoreCreated" 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. |
name | The name of the Store that was created. |
languages Array of String | Languages of the Store that was created. Languages are represented as IETF language tags. |
countries Array of StoreCountry | |
distributionChannels Array of ChannelReference | Distribution Channels of the Store that was created. |
supplyChannels Array of ChannelReference | Supply Channels of the Store that was created. |
productSelections Array of ProductSelectionSetting | ProductSelectionSettings of the Store that was created. |
custom | Custom Fields on the Store 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. |
Store 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 | "StoreDeleted" 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. |
Store Languages 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 | "StoreLanguagesChanged" 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. |
addedLanguages Array of Locale | |
removedLanguages Array of Locale | |
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. |
Store Countries 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 | "StoreCountriesChanged" 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. |
addedCountries Array of StoreCountry | |
removedCountries Array of StoreCountry | |
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. |
Store 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 | "StoreNameSet" 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. |
name | |
nameAllLocales Array of LocalizedString | Names set for the Store in different locales. |
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. |
Store Product Selections 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 | "StoreProductSelectionsChanged" 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. |
addedProductSelections Array of ProductSelectionSetting | ProductSelectionSettings that were added to the Store. |
removedProductSelections Array of ProductSelectionSetting | ProductSelectionSettings that were removed from the Store. |
updatedProductSelections Array of ProductSelectionSetting | ProductSelectionSettings that were updated in the Store. |
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. |
Store Distribution Channels 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 | "StoreDistributionChannelsChanged" 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. |
addedDistributionChannels Array of ChannelReference | Product distribution Channels that have been added to the Store. |
removedDistributionChannels Array of ChannelReference | Product distribution Channels that have been removed from the Store. |
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. |
Store Supply Channels 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 | "StoreSupplyChannelsChanged" 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. |
addedSupplyChannels Array of ChannelReference | Inventory supply Channels that have been added to the Store. |
removedSupplyChannels Array of ChannelReference | Inventory supply Channels that have been removed from the Store. |
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. |