commercetools icon

commercetools

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

Actions671

Channel → Get Channel by Key

AI-generated

Summary

Retrieve a commercetools Channel resource by its unique key within a project.

Inputs

  • Channel Key (required) — The unique string key identifying the Channel to retrieve.
  • Filters — Optional query parameter 'expand' to control expansion of referenced resources in the response.

Output shape

a single Channel JSON object representing the Channel identified by the given key.

The operation returns the Channel data as JSON. Optional 'expand' query parameter can be provided to include expanded references. Errors are thrown if the Channel key is not found or request fails.

Examples

Example 1: Retrieve a Channel by its key with optional expansion

Set 'Channel Key' to the target key value and optionally provide an 'expand' string to include related expanded resources in the response.

Links

Discussion