customObjects

Query custom objects in a container — arbitrary JSON documents you store against the project.

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the customObjects action (under Custom).
Fill in the fields below, then reference the result from later steps as {{customobjects.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 CustomObjects($where: String, $sort: [String!], $limit: Int, $offset: Int, $container: String!) {
  customObjects(
    where: $where
    sort: $sort
    limit: $limit
    offset: $offset
    container: $container
  ) {
    offset
    count
    total
    exists
    results {
      container
      key
      value
      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

containerstringrequired

json

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

Response

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

offsetnumber

countnumber

totalstring

existsboolean

resultsarray<object>

containerobject

keyobject

valueobject

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?