updateZone

Update an existing zone — pass its current version and an array of update actions.

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the updateZone action (under Update).
Fill in the fields below, then reference the result from later steps as {{updatezone.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 UpdateZone($version: Long!, $actions: [ZoneUpdateAction!]!, $id: String, $key: String) {
  updateZone(version: $version, actions: $actions, id: $id, key: $key) {
    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.

versionstringrequired

actionsarray<object>required

addLocationobject1 fields

changeNameobject1 fields

removeLocationobject1 fields

setDescriptionobject1 fields

setKeyobject1 fields

idstring

Queries with specified ID

keystring

Queries with specified key

json

{
  "version": "string",
  "actions": [
    {
      "addLocation": {
        "location": "string"
      },
      "changeName": {
        "name": "string"
      },
      "removeLocation": {
        "location": "string"
      },
      "setDescription": {
        "description": "string"
      },
      "setKey": {
        "key": "string"
      }
    }
  ],
  "id": "string",
  "key": "string"
}

Response

Read the result with {{updatezone.response.data.data.updateZone}}. If the API returns errors, the step fails and they are at {{updatezone.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