Documentation

Messages Query HTTP API

A message represents a change or an action performed on a resource (like an Order or a Product). Messages can be pulled via the HTTP REST API described here. Pulling through the REST API needs to be activated manually. Messages can also be pushed into a Message Queue by defining a Subscription

Enable feature

To optimize the performance of your project, the messages are not persisted on the REST API per default. The REST API feature needs to be explicitly enabled in the Settings > Developer Settings section of Merchant Center, or by using the Change Messages Configuration update action.

Get Message by ID

Endpoint: /{projectKey}/messages/{id}
Method: GET
OAuth 2.0 Scopes: view_messages:{projectKey} (or, deprecated: view_orders:{projectKey})
Response Representation: Message

Query Messages

Endpoint: /{projectKey}/messages
Method: GET
OAuth 2.0 Scopes: view_messages:{projectKey} (or, deprecated: view_orders:{projectKey})
Response Representation: PagedQueryResult with results containing an array of Message
Query Parameters: