Menu
messages
Query the change/event message log (order state changes, price changes, etc.) with a `where` predicate and paging.
Use it in a workflow
- Add a step and choose the Commercetools connector.
- Pick the messages action (under Messages).
- Fill in the fields below, then reference the result from later steps as
{{messages.response.data}}.
Query
This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.
query Messages($where: String, $sort: [String!], $limit: Int, $offset: Int) {
messages(where: $where, sort: $sort, limit: $limit, offset: $offset) {
offset
count
total
exists
results {
id
type
sequenceNumber
resourceRef {
typeId
id
}
resourceVersion
userProvidedIdentifiers {
key
orderNumber
customerNumber
externalId
sku
slugAllLocales
}
payload {
type
}
version
createdAt
lastModifiedAt
createdBy {
isPlatformClient
clientId
externalUserId
anonymousId
customerRef
userRef
associateRef
attributedTo
}
lastModifiedBy {
isPlatformClient
clientId
externalUserId
anonymousId
customerRef
userRef
associateRef
attributedTo
}
}
}
}
Variables
Pass these as a JSON object in the step's Variables field.
{
"where": "string",
"sort": [
"string"
],
"limit": 0,
"offset": 0
}
Response
Read the result with {{messages.response.data.data.messages}}. If the API returns errors, the step fails and they are at {{messages.response.data.errors}}.
Need more? See the Commercetools guide for connection setup and behaviour shared by every action.
Was this page helpful?