extensions

Query API Extensions (synchronous update hooks) with a `where` predicate and paging.

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the extensions action (under Extensions).
Fill in the fields below, then reference the result from later steps as {{extensions.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 Extensions($where: String, $sort: [String!], $limit: Int, $offset: Int) {
  extensions(where: $where, sort: $sort, limit: $limit, offset: $offset) {
    offset
    count
    total
    exists
    results {
      key
      destination {
        type
      }
      triggers {
        resourceTypeId
        actions
        condition
      }
      timeoutInMs
      dependenciesRef {
        typeId
        id
      }
      additionalContext {
        includeOldResource
      }
      expansionPaths
      id
      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.

wherestring

sortarray<string>

limitnumber

offsetnumber

json

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

Response

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

offsetnumber

countnumber

totalstring

existsboolean

resultsarray<object>

keyobject

destinationobject

triggersobject

timeoutInMsobject

dependenciesRefobject

additionalContextobject

expansionPathsobject

idobject

versionobject

createdAtobject

lastModifiedAtobject

createdByobject

lastModifiedByobject

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

Was this page helpful?