createZone

Create a new zone.

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the createZone action (under Create).
Fill in the fields below, then reference the result from later steps as {{createzone.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 CreateZone($draft: CreateZone!) {
  createZone(draft: $draft) {
    name
    key
    description
    locations {
      country
      state
    }
    id
    version
    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

namestringrequired

keystring

descriptionstring

locationsarray<object>2 fields

json

{
  "draft": {
    "name": "string",
    "key": "string",
    "description": "string",
    "locations": [
      {
        "country": "string",
        "state": "string"
      }
    ]
  }
}

Response

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

namestring

keystring

descriptionstring

locationsarray<object>

countryobject

stateobject

idstring

versionstring

createdAtstring

lastModifiedAtstring

createdByobject

isPlatformClientboolean

clientIdstring

externalUserIdstring

anonymousIdstring

customerRefobject2 fields

userRefobject2 fields

associateRefobject2 fields

attributedToobject3 fields

lastModifiedByobject