Menu
categories
Query categories — supports a `where` predicate, `sort`, and `limit`/`offset` paging.
Use it in a workflow
- Add a step and choose the Commercetools connector.
- Pick the categories action (under Categories).
- Fill in the fields below, then reference the result from later steps as
{{categories.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 Categories($where: String, $sort: [String!], $limit: Int, $offset: Int) {
categories(where: $where, sort: $sort, limit: $limit, offset: $offset) {
offset
count
total
exists
results {
id
key
version
nameAllLocales {
locale
value
}
descriptionAllLocales {
locale
value
}
slugAllLocales {
locale
value
}
ancestorsRef {
typeId
id
}
ancestors
parentRef {
typeId
id
}
parent
orderHint
externalId
metaTitleAllLocales {
locale
value
}
metaKeywordsAllLocales {
locale
value
}
metaDescriptionAllLocales {
locale
value
}
stagedProductCount
childCount
children
createdAt
lastModifiedAt
assets {
id
key
sources
nameAllLocales
descriptionAllLocales
tags
custom
}
custom {
typeRef
type
}
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 {{categories.response.data.data.categories}}. If the API returns errors, the step fails and they are at {{categories.response.data.errors}}.
Need more? See the Commercetools guide for connection setup and behaviour shared by every action.
Was this page helpful?