younifyd
Menu

message

A single change/event message by ID.

Use it in a workflow

  1. Add a step and choose the Commercetools connector.
  2. Pick the message action (under Message).
  3. Fill in the fields below, then reference the result from later steps as {{message.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.

graphql
query Message($id: String, $key: String) {
  message(id: $id, key: $key) {
    id
    type
    sequenceNumber
    resourceRef {
      typeId
      id
    }
    resourceVersion
    userProvidedIdentifiers {
      key
      orderNumber
      customerNumber
      externalId
      sku
      slugAllLocales {
        locale
        value
      }
    }
    payload {
      type
    }
    version
    createdAt
    lastModifiedAt
    createdBy {
      isPlatformClient
      clientId
      externalUserId
      anonymousId
      customerRef {
        typeId
        id
      }
      userRef {
        typeId
        id
      }
      associateRef {
        typeId
        id
      }
      attributedTo {
        clientId
        source
        userRef
      }
    }
    lastModifiedBy {
      isPlatformClient
      clientId
      externalUserId
      anonymousId
      customerRef {
        typeId
        id
      }
      userRef {
        typeId
        id
      }
      associateRef {
        typeId
        id
      }
      attributedTo {
        clientId
        source
        userRef
      }
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

idstring

Queries with specified ID

keystring

Queries with specified key

json
{
  "id": "string",
  "key": "string"
}

Response

Read the result with {{message.response.data.data.message}}. If the API returns errors, the step fails and they are at {{message.response.data.errors}}.

idstring
typestring
sequenceNumberstring
resourceRefobject
typeIdstring
idstring
resourceVersionstring
userProvidedIdentifiersobject
keystring
orderNumberstring
customerNumberstring
externalIdstring
skustring
slugAllLocalesarray<object>
payloadobject
typestring
versionstring
createdAtstring
lastModifiedAtstring
createdByobject
isPlatformClientboolean
clientIdstring
externalUserIdstring
anonymousIdstring
customerRefobject2 fields
userRefobject2 fields
associateRefobject2 fields
attributedToobject3 fields
lastModifiedByobject
isPlatformClientboolean
clientIdstring
externalUserIdstring
anonymousIdstring
customerRefobject2 fields
userRefobject2 fields
associateRefobject2 fields
attributedToobject3 fields

Need more? See the Commercetools guide for connection setup and behaviour shared by every action.

Was this page helpful?
message — Commercetools — Documentation