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

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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​
Int64​

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​
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​
ProductSelectionSettings of the Store that was created.
custom​
Custom Fields on the Store that was created.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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​
Int64​

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​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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​
Int64​

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​
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​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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​
Int64​

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​
Countries added to the Store.
removedCountries​
Array of StoreCountry​
Countries removed from the Store.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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​
Int64​

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​
Name of the Store set during the Set Name update action.
nameAllLocales​
Array of LocalizedString​
Names set for the Store in different locales.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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​
Int64​

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​
ProductSelectionSettings that were added to the Store.
removedProductSelections​
ProductSelectionSettings that were removed from the Store.
updatedProductSelections​
ProductSelectionSettings that were updated in the Store.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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​
Int64​

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​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

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​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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​
Int64​

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​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Store Checkout URL Template Set

Generated after a successful Set Checkout Url Template update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"StoreCheckoutUrlTemplateSet"
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.
checkoutUrlTemplate​
String​
The checkoutUrlTemplate of the Store after the Set Checkout Url Template update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Store Order URL Template Set

Generated after a successful Set Order Url Template update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"StoreOrderUrlTemplateSet"
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.
orderUrlTemplate​
String​
The orderUrlTemplate of the Store after the Set Order Url Template update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Store Terms Of Service Url Set

Generated after a successful Set Terms Of Service Url update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"StoreTermsOfServiceUrlSet"
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.
termsOfServiceUrl​
String​
The termsOfServiceUrl of the Store after the Set Terms Of Service Url update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Store Privacy Policy Url Set

Generated after a successful Set Privacy Policy Url update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"StorePrivacyPolicyUrlSet"
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.
privacyPolicyUrl​
String​
The privacyPolicyUrl of the Store after the Set Privacy Policy Url update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Store Refund Policy Url Set

Generated after a successful Set Refund Policy Url update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"StoreRefundPolicyUrlSet"
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.
refundPolicyUrl​
String​
The refundPolicyUrl of the Store after the Set Refund Policy Url update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Store Shipping Policy Url Set

Generated after a successful Set Shipping Policy Url update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"StoreShippingPolicyUrlSet"
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.
shippingPolicyUrl​
String​
The shippingPolicyUrl of the Store after the Set Shipping Policy Url update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Store Imprint Url Set

Generated after a successful Set Imprint Url update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"StoreImprintUrlSet"
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.
imprintUrl​
String​
The imprintUrl of the Store after the Set Imprint Url update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Store Faq Url Set

Generated after a successful Set Faq Url update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"StoreFaqUrlSet"
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.
faqUrl​
String​
The faqUrl of the Store after the Set Faq Url update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.

Store Contact Url Set

Generated after a successful Set Contact Url update action.
id​
String​

Unique identifier of the Message. Can be used to track which Messages have been processed.

version​
Int64​
Version of a resource. In case of Messages, this is always 1.
sequenceNumber​
Int64​
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​
Int64​

Version of the resource on which the change or action was performed.

type​
String​
"StoreContactUrlSet"
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.
contactUrl​
String​
The contactUrl of the Store after the Set Contact Url update action.
createdAt​

Date and time (UTC) the Message was generated.

createdBy​BETA

IDs and references that created the Message.

lastModifiedAt​
Value of createdAt.
lastModifiedBy​BETA

IDs and references that last modified the Message.