commercetools icon

commercetools

Interact with the commercetools API. Operations are auto-generated from the official Postman collection.

Actions671

Zone → Update Zone by Key

AI-generated

Summary

Update a commercetools Zone identified by its unique key using a specified version and a list of update actions.

Inputs

  • Zone Key (required) — The unique key of the Zone to update.
  • Version (required) — The current version of the Zone for optimistic concurrency control.
  • Actions (UI) — A collection of update actions to apply to the Zone, such as adding or removing locations, changing the name, setting the description, or updating the key. Multiple actions can be specified.
  • Actions (JSON) — A raw JSON array of update actions that overrides the Actions (UI) if provided and not empty.

Output shape

a single record

Returns the updated Zone resource as a JSON object. Throws an error if the update fails due to version conflicts or other API issues.

Examples

Example 1: Update a Zone's name and add a location

Specify the Zone Key, current Version (e.g., 3), and include two Actions (UI): ChangeName with new name and AddLocation with a location JSON object.

Links

Discussion