Store Messages

Messages that represent a change or an action performed on a Store.

Messages are available in a variety of Message Types specific to a resource. Common fields across all Message Types are represented by a base resource, Message.

You can access Messages either by querying the Messages API, or by subscribing to them with a Subscription. To query Messages using the API, you must enable the feature first.

Store Messages

Messages that represent a change or an action performed on a Store.

Store Created

Store Deleted

Store Languages Changed

Store Countries Changed

Store Name Set

Store Product Selections Changed

Store Distribution Channels Changed

Store Supply Channels Changed

Store Created

Generated after a successful Create Store request.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int	Version of a resource. In case of Messages, this is always `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	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`name` LocalizedString	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	Countries of the Store that was created.
`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` CustomFields	Custom Fields on the Store that was created.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Store Deleted

Generated after a successful Delete Store request.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int	Version of a resource. In case of Messages, this is always `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	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` UserProvidedIdentifiers	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 CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Store Languages Changed

Generated after a successful Set Languages update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int	Version of a resource. In case of Messages, this is always `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	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`addedLanguages` Array of Locale	Locales added to the Store after the Set Languages update action.
`removedLanguages` Array of Locale	Locales removed from the Store during the Set Languages update action.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Store Countries Changed

Generated after a successful Add Country, Remove Country, or Set Countries update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int	Version of a resource. In case of Messages, this is always `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	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`addedCountries` Array of StoreCountry	Countries added to the Store.
`removedCountries` Array of StoreCountry	Countries removed from the Store.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Store Name Set

Generated after a successful Set Name update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int	Version of a resource. In case of Messages, this is always `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	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` UserProvidedIdentifiers	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
`name` LocalizedString	Name of the Store set during the Set Name update action.
`nameAllLocales` Array of LocalizedString	Names set for the Store in different locales.
`createdAt` DateTime	Date and time (UTC) the Message was generated.
`createdBy`BETA CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Store Product Selections Changed

Generated by a successful Add Product Selection, Remove Product Selection, Set Product Selections, or Change Product Selections Active update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int	Version of a resource. In case of Messages, this is always `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	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` UserProvidedIdentifiers	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 CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Store Distribution Channels Changed

Generated after a successful Add Distribution Channel, Remove Distribution Channel, or Set Distribution Channels update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int	Version of a resource. In case of Messages, this is always `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	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` UserProvidedIdentifiers	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 CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.

Store Supply Channels Changed

Generated after a successful Add Supply Channel, Remove Supply Channel, or Set Supply Channels update action.

`id` String	Unique identifier of the Message. Can be used to track which Messages have been processed.
`version` Int	Version of a resource. In case of Messages, this is always `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	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` UserProvidedIdentifiers	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 CreatedBy	IDs and references that created the Message.
`lastModifiedAt` DateTime	Value of `createdAt`.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Message.