createState

Create a new state.

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the createState action (under Create).
Fill in the fields below, then reference the result from later steps as {{createstate.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.

graphql

mutation CreateState($draft: StateDraft!) {
  createState(draft: $draft) {
    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 {
        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.

draftobjectrequired

keystringrequired

typestringrequired

One ofLineItemStateOrderStatePaymentStateProductStateQuoteRequestStateQuoteStateRecurringOrderStateReviewStateStagedQuoteState

namearray<object>2 fields

descriptionarray<object>2 fields

initialboolean

rolesarray<string>

transitionsarray<object>2 fields

json

{
  "draft": {
    "key": "string",
    "type": "LineItemState",
    "name": [
      {
        "locale": "string",
        "value": "string"
      }
    ],
    "description": [
      {
        "locale": "string",
        "value": "string"
      }
    ],
    "initial": false,
    "roles": [
      "Return"
    ],
    "transitions": [
      {
        "typeId": "string",
        "id": "string"
      }
    ]
  }
}

Response

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

idstring

versionstring

keystring

typestring

One ofLineItemStateOrderStatePaymentStateProductStateQuoteRequestStateQuoteStateRecurringOrderStateReviewStateStagedQuoteState

rolesarray<string>

nameAllLocalesarray<object>

localeobject

valueobject

descriptionAllLocalesarray<object>

localeobject

valueobject

builtInboolean

transitionsRefarray<object>

typeIdobject

idobject

transitionsarray<object>

initialboolean

createdAtstring

lastModifiedAtstring

createdByobject

isPlatformClientboolean

clientIdstring

externalUserIdstring

anonymousIdstring

customerRefobject2 fields

userRefobject2 fields

associateRefobject2 fields

attributedToobject3 fields

lastModifiedByobject