Menu
createCategory
Create a new category.
Use it in a workflow
- Add a step and choose the Commercetools connector.
- Pick the createCategory action (under Create).
- Fill in the fields below, then reference the result from later steps as
{{createcategory.response.data}}.
Query
This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.
mutation CreateCategory($draft: CategoryDraft!) {
createCategory(draft: $draft) {
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 {
uri
key
dimensions
contentType
}
nameAllLocales {
locale
value
}
descriptionAllLocales {
locale
value
}
tags
custom {
typeRef
type
}
}
custom {
typeRef {
typeId
id
}
type {
key
nameAllLocales
descriptionAllLocales
resourceTypeIds
id
version
createdAt
lastModifiedAt
createdBy
lastModifiedBy
}
}
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.
{
"draft": {
"name": [
{
"locale": "string",
"value": "string"
}
],
"slug": [
{
"locale": "string",
"value": "string"
}
],
"key": "string",
"description": [
{
"locale": "string",
"value": "string"
}
],
"custom": {
"typeId": "string",
"typeKey": "string",
"type": {
"typeId": "string",
"id": "string",
"key": "string"
},
"fields": [
"string"
]
},
"externalId": "string",
"metaTitle": [
{
"locale": "string",
"value": "string"
}
],
"metaDescription": [
{
"locale": "string",
"value": "string"
}
],
"metaKeywords": [
{
"locale": "string",
"value": "string"
}
],
"orderHint": "string",
"parent": {
"typeId": "string",
"id": "string",
"key": "string"
},
"assets": [
{
"name": "string",
"key": "string",
"description": "string",
"custom": "string",
"sources": "string",
"tags": "string",
"type": "string"
}
]
}
}
Response
Read the result with {{createcategory.response.data.data.createCategory}}. If the API returns errors, the step fails and they are at {{createcategory.response.data.errors}}.
Need more? See the Commercetools guide for connection setup and behaviour shared by every action.
Was this page helpful?