states

Query workflow States (custom state-machine statuses) with a `where` predicate and paging.

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the states action (under States).
Fill in the fields below, then reference the result from later steps as {{states.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 States($where: String, $sort: [String!], $limit: Int, $offset: Int) {
  states(where: $where, sort: $sort, limit: $limit, offset: $offset) {
    offset
    count
    total
    exists
    results {
      id
      version
      key
      type
      roles
      nameAllLocales {
        locale
        value
      }
      descriptionAllLocales {
        locale
        value
      }
      builtIn
      transitionsRef {
        typeId
        id
      }
      transitions
      initial
      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.

wherestring

sortarray<string>

limitnumber

offsetnumber

json

{
  "where": "string",
  "sort": [
    "string"
  ],
  "limit": 0,
  "offset": 0
}

Response

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

offsetnumber

countnumber

totalstring

existsboolean

resultsarray<object>

idobject

versionobject

keyobject

typeobject

rolesobject

nameAllLocalesobject

descriptionAllLocalesobject

builtInobject

transitionsRefobject

transitionsobject

initialobject

createdAtobject

lastModifiedAtobject

createdByobject

lastModifiedByobject

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

Was this page helpful?