commercetools icon

commercetools

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

Actions671

Channel → Delete Channel by Key

AI-generated

Summary

Delete a commercetools Channel by its unique key with a specified version to ensure concurrency control.

Inputs

  • Channel Key (required) — The unique key identifying the Channel to delete.
  • Version (required) — The current version of the Channel resource to ensure correct deletion and avoid conflicts.

Output shape

a single JSON object representing the deleted Channel resource response from the commercetools API, or an error object if the deletion fails.

The operation sends a DELETE HTTP request with the specified Channel key and version as a query parameter. The version number is mandatory and used for concurrency control. Errors throw NodeApiError unless continueOnFail is enabled, which returns an error object per item.

Examples

Example 1: Delete a Channel with key 'my-channel' at version 3

Set 'Channel Key' to 'my-channel', 'Version' to 3, then execute the node to delete that specific version of the Channel.

Links

Discussion