commercetools icon

commercetools

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

Actions671

Channel → Create Channel

AI-generated

Summary

Create a new channel in the commercetools platform with specified key, roles, localized name, description, and optional address and geo-location details.

Inputs

  • Key (required) — Unique identifier for the new channel.
  • Roles (required) — JSON array defining the various roles assigned to the channel.
  • Name (required) — Localized JSON object specifying the name of the channel, e.g., { "en": "Name" }.
  • Description (required) — Localized JSON object describing the channel.
  • Address › Key — Key identifier for the channel's address.
  • Address › Country — Country of the channel's address.
  • Address › First Name — First name for the channel's address contact.
  • Address › Last Name — Last name for the channel's address contact.
  • Address › Street Name — Street name of the channel's address.
  • Address › Street Number — Street number for the channel's address.
  • Address › Postal Code — Postal code of the channel's address.
  • Address › City — City for the channel's address.
  • Address › State — State for the channel's address.
  • Address › Phone — Phone number for the channel's address contact.
  • Address › Email — Email for the channel's address contact.
  • Geo Location › Type — Type of geo location, e.g., Point.
  • Geo Location › Coordinates — JSON array of coordinates for the geo location, e.g., [longitude, latitude].

Output shape

a single JSON object representing the created channel resource.

The returned JSON contains all details of the newly created channel as returned by the commercetools API.

Examples

Example 1: Create a simple sales channel

Specify a unique key, the roles the channel will have, localized name and description, and optionally provide address and geo location details for the channel.

Links

Discussion