Channels

Channels represent a source or destination of different entities. They can be used to model warehouses or stores.

Channels are used across the different APIs in commercetools Composable Commerce to connect different entities (like inventory or price) to some specific source or destination of entities. For example, inventory may be connected to a supply channel that would describe from which supplier a stock comes from. Price may also have connection to the channel. In this case, you can save the inventory pricing information from the specific channel into the system. Similarly, after the disposition process, line items can get supply channel information that would uniquely identify inventory entries that should be reserved.

Representations

Channel

ChannelDraft

ChannelPagedQueryResponse

ChannelReference

ChannelResourceIdentifier

ChannelRoleEnum

Channel

`id` String	Unique identifier of the Channel.
`version` Int	Current version of the Channel.
`key` String	User-defined unique identifier of the Channel.
`roles` Array of ChannelRoleEnum	Roles of the Channel.
`name` LocalizedString	Name of the Channel.
`description` LocalizedString	Description of the Channel.
`address` Address	Address where the Channel is located (for example, if the Channel is a physical store).
`reviewRatingStatistics` ReviewRatingStatistics	Statistics about the review ratings taken into account for the Channel.
`geoLocation` GeoJson	GeoJSON geometry object encoding the geo location of the Channel.
`custom` CustomFields	Custom Fields defined for the Channel.
`createdAt` DateTime	Date and time (UTC) the Channel was initially created.
`createdBy`BETA CreatedBy	IDs and references that created the Channel.
`lastModifiedAt` DateTime	Date and time (UTC) the Channel was last updated.
`lastModifiedBy`BETA LastModifiedBy	IDs and references that last modified the Channel.

ChannelDraft

`key` String	User-defined unique identifier for the Channel.
`roles` Array of ChannelRoleEnum	Roles of the Channel. Each channel must have at least one role. If not specified, then `InventorySupply` is assigned by default.
`name` LocalizedString	Name of the Channel.
`description` LocalizedString	Description of the Channel.
`address` BaseAddress	Address where the Channel is located.
`geoLocation` GeoJson	GeoJSON geometry object encoding the geo location of the Channel. Currently, only the Point type is supported.
`custom` CustomFieldsDraft	Custom fields defined for the Channel.

ChannelPagedQueryResponse

PagedQueryResult with results containing an array of Channel.

`limit` Int	Number of results requested.
`offset` Int	Number of elements skipped.
`count` Int	Actual number of results returned.
`total` Int	Total number of results matching the query. This number is an estimation that is not strongly consistent. This field is returned by default. For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`. When the results are filtered with a Query Predicate, `total` is subject to a limit.
`results` Array of Channel	Channels matching the query.

ChannelReference

Reference to a Channel.

`id` String	Unique identifier of the referenced Channel.
`typeId` ReferenceTypeId	`"channel"` References a Channel.
`obj` Channel	Contains the representation of the expanded Channel. Only present in responses to requests with Reference Expansion for Channels.

ChannelResourceIdentifier

ResourceIdentifier to a Channel. Either id or key is required. If both are set, an InvalidJsonInput error is returned.

`id` String	Unique identifier of the referenced Channel. Required if `key` is absent.
`key` String	User-defined unique identifier of the referenced Channel. Required if `id` is absent.
`typeId` ReferenceTypeId	`"channel"` References a Channel.

ChannelRoleEnum

Describes the purpose and type of the Channel. A Channel can have one or more roles.

InventorySupply: Channel can be used to track inventory entries (for example, Channels with this role can be treated as warehouses).
ProductDistribution: Channel can be used to expose Products to a specific distribution Channel. The Channel can be used by a Cart to select a Product Price.
OrderExport: Channel can be used to track order export activities.
OrderImport: Channel can be used to track order import activities.
Primary: This role can be combined with the other roles (for example, with InventorySupply). If used, the Channel is considered as the primary or main channel among Channels of the same type.

# Get Channel

by ID

GET

https://api.{region}.commercetools.com/{projectKey}/channels/{id}

OAuth 2.0 Scopes:

view_products:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`id` String	`id` of the Channel.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Response:

200Channelasapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/channels/{id} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

200 Response Example: Channeljson

{
  "id": "ac390383-370f-43f8-a534-db1604cb96a8",
  "key": "commercetools",
  "version": 1,
  "roles": ["InventorySupply"],
  "createdAt": "2015-05-28T09:48:35.023Z",
  "lastModifiedAt": "2015-05-28T09:48:35.023Z"
}

Query Channels

GET

https://api.{region}.commercetools.com/{projectKey}/channels

OAuth 2.0 Scopes:

view_products:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.

Query parameters:

`where` QueryPredicate	The parameter can be passed multiple times.
`/^var[.][a-zA-Z0-9]+$/` Any string parameter matching this regular expression	Predicate parameter values. The parameter can be passed multiple times.
`sort` Sort	The parameter can be passed multiple times.
`expand` Expansion	The parameter can be passed multiple times.
`limit` Int	Number of results requested.
`offset` Int	Number of elements skipped.
`withTotal` Boolean	Controls the calculation of the total number of query results. Set to `false` to improve query performance when the `total` is not needed. Default: `true`

Response:

200ChannelPagedQueryResponseasapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/channels -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

200 Response Example: ChannelPagedQueryResponsejson

{
  "limit": 20,
  "offset": 0,
  "count": 2,
  "total": 2,
  "results": [
    {
      "id": "ac390383-370f-43f8-a534-db1604cb96a8",
      "key": "channel1",
      "version": 1,
      "roles": ["InventorySupply"],
      "createdAt": "2015-05-28T09:48:35.023Z",
      "lastModifiedAt": "2015-05-28T09:48:35.023Z"
    },
    {
      "id": "51323ad2-89f2-4233-b9be-f15c049769c8",
      "key": "channel2",
      "version": 2,
      "roles": ["InventorySupply"],
      "createdAt": "2017-01-10T06:51:08.866Z",
      "lastModifiedAt": "2017-01-10T06:51:08.924Z"
    }
  ]
}

Check if Channel exists

by ID

HEAD

https://api.{region}.commercetools.com/{projectKey}/channels/{id}

Checks if a Channel exists for a given id. Returns a 200 OK status if the Channel exists or a 404 Not Found otherwise.

OAuth 2.0 Scopes:

view_products:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`id` String	`id` of the Channel.

Response:

200

Request Example:cURL

curl --head https://api.{region}.commercetools.com/{projectKey}/channels/{id} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

by Query Predicate

HEAD

https://api.{region}.commercetools.com/{projectKey}/channels

Checks if a Channel exists for a given Query Predicate. Returns a 200 OK status if any Channels match the Query Predicate or a 404 Not Found otherwise.

OAuth 2.0 Scopes:

view_products:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.

Query parameters:

where

QueryPredicate

Query Predicates on Channels are limited to Text, Enum, Boolean, Number, Date, Time, and DateTime attribute types.

The parameter can be passed multiple times.

Response:

200

Request Example:cURL

curl --head https://api.{region}.commercetools.com/{projectKey}/channels -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

Create Channel

POST

https://api.{region}.commercetools.com/{projectKey}/channels

OAuth 2.0 Scopes:

manage_products:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Request Body:ChannelDraftasapplication/json

Response:

201Channelasapplication/json

Request Example:cURL

curl https://api.{region}.commercetools.com/{projectKey}/channels -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}' \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "key" : "commercetools",
  "roles" : [ "InventorySupply" ]
}
DATA

201 Response Example: Channeljson

{
  "id": "ac390383-370f-43f8-a534-db1604cb96a8",
  "key": "commercetools",
  "version": 1,
  "roles": ["InventorySupply"],
  "createdAt": "2015-05-28T09:48:35.023Z",
  "lastModifiedAt": "2015-05-28T09:48:35.023Z"
}

Update Channel

by ID

POST

https://api.{region}.commercetools.com/{projectKey}/channels/{id}

OAuth 2.0 Scopes:

manage_products:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`id` String	`id` of the Channel.

Query parameters:

expand

Expansion

The parameter can be passed multiple times.

Request Body:

application/json

`version` Int	Expected version of the Channel on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.
`actions` Array of ChannelUpdateAction	Update actions to be performed on the Channel.

Response:

200Channelasapplication/json

Request Example:cURL

curl https://api.{region}.commercetools.com/{projectKey}/channels/{id} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}' \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "version" : 1,
  "actions" : [ {
    "action" : "changeName",
    "name" : {
      "en" : "New Name"
    }
  } ]
}
DATA

200 Response Example: Channeljson

{
  "id": "ac390383-370f-43f8-a534-db1604cb96a8",
  "key": "commercetools",
  "version": 1,
  "roles": ["InventorySupply"],
  "createdAt": "2015-05-28T09:48:35.023Z",
  "lastModifiedAt": "2015-05-28T09:48:35.023Z"
}

Update actions

Set Custom Type in Address

Set CustomField in Address

Set GeoLocation

Change Key

`action` String	`"changeKey"`
`key` String	New value to set. Must not be empty.

Example: json

{
  "action": "changeKey",
  "key": "myNewChannelKey"
}

Change Name

`action` String	`"changeName"`
`name` LocalizedString	New value to set. Must not be empty.

Example: json

{
  "action": "changeName",
  "name": {
    "en": "new Channel Name EN",
    "de": "new Channel Name DE"
  }
}

Change Description

`action` String	`"changeDescription"`
`description` LocalizedString	New value to set. Must not be empty.

Example: json

{
  "action": "changeDescription",
  "description": {
    "en": "new Description EN",
    "de": "new Description DE"
  }
}

Set Roles

`action` String	`"setRoles"`
`roles` Array of ChannelRoleEnum	Value to set. If not specified, then `InventorySupply` is assigned by default.

Example: json

{
  "action": "setRoles",
  "roles": ["ProductDistribution", "Primary"]
}

Add Roles

`action` String	`"addRoles"`
`roles` Array of ChannelRoleEnum	Value to append to the array.

Example: json

{
  "action": "addRoles",
  "roles": ["InventorySupply"]
}

Remove Roles

`action` String	`"removeRoles"`
`roles` Array of ChannelRoleEnum	Value to remove from the array.

Example: json

{
  "action": "removeRoles",
  "roles": ["InventorySupply"]
}

Set Address

`action` String	`"setAddress"`
`address` BaseAddress	Value to set. If empty, any existing value will be removed.

Example: json

{
  "action": "setAddress",
  "address": {
    "key": "exampleKey",
    "title": "My Address",
    "salutation": "Mr.",
    "firstName": "Example",
    "lastName": "Person",
    "streetName": "Example Street",
    "streetNumber": "4711",
    "additionalStreetInfo": "Backhouse",
    "postalCode": "80933",
    "city": "Exemplary City",
    "region": "Exemplary Region",
    "state": "Exemplary State",
    "country": "DE",
    "company": "My Company Name",
    "department": "Sales",
    "building": "Hightower 1",
    "apartment": "247",
    "pOBox": "2471",
    "phone": "+49 89 12345678",
    "mobile": "+49 171 2345678",
    "email": "email@example.com",
    "fax": "+49 89 12345679",
    "additionalAddressInfo": "no additional Info",
    "externalId": "Information not needed"
  }
}

Set Custom Type

`action` String	`"setCustomType"`
`type` TypeResourceIdentifier	Defines the Type that extends the Channel with Custom Fields. If absent, any existing Type and Custom Fields are removed from the Channel.
`fields` FieldContainer	Sets the Custom Fields fields for the Channel.

Example: json

{
  "action": "setCustomType",
  "type": {
    "id": "{{type-id}}",
    "typeId": "type"
  },
  "fields": {
    "exampleStringTypeField": "TextString"
  }
}

Set CustomField

`action` String	`"setCustomField"`
`name` String	Name of the Custom Field.
`value` CustomFieldValue	If `value` is absent or `null`, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If `value` is provided, it is set for the field defined by `name`.

Example: json

{
  "action": "setCustomField",
  "name": "ExampleStringTypeField",
  "value": "TextString"
}

Set Custom Type in Address

`action` String	`"setAddressCustomType"`
`type` TypeResourceIdentifier	Defines the Type that extends the `address` with Custom Fields. If absent, any existing Type and Custom Fields are removed from the `address`.
`fields` FieldContainer	Sets the Custom Fields fields for the `address`.

Example: json

{
  "action": "setAddressCustomType",
  "type": {
    "id": "{{type-id}}",
    "typeId": "type"
  },
  "fields": {
    "exampleStringTypeField": "TextString"
  }
}

Set CustomField in Address

`action` String	`"setAddressCustomField"`
`name` String	Name of the Custom Field.
`value` CustomFieldValue	Specifies the format of the value of the Custom Field defined by `name`. If `value` is absent or `null`, this field will be removed, if it exists. Removing a field that does not exist returns an InvalidOperation error.

Example: json

{
  "action": "setAddressCustomField",
  "name": "ExampleStringTypeField",
  "value": "TextString"
}

Set GeoLocation

`action` String	`"setGeoLocation"`
`geoLocation` GeoJson	Value to set.

Example: json

{
  "action": "setGeoLocation",
  "geoLocation": {
    "type": "Point",
    "coordinates": [48.163569, 11.558663]
  }
}

Delete Channel

A Channel can only be deleted if it is not referenced by an InventoryEntry, a LineItem, a Store, a Price, a StandalonePrice, or a CartDiscountValueGiftLineItem.

by ID

DELETE

https://api.{region}.commercetools.com/{projectKey}/channels/{id}

Returns a ReferenceExists error if other resources reference the Channel to be deleted.

OAuth 2.0 Scopes:

manage_products:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`id` String	`id` of the Channel.

Query parameters:

`version` Int	Last seen version of the resource.
`expand` Expansion	The parameter can be passed multiple times.

Response:

200Channelasapplication/json

Request Example:cURL

curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/channels/{id}?version={version} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'

200 Response Example: Channeljson

{
  "id": "ac390383-370f-43f8-a534-db1604cb96a8",
  "key": "commercetools",
  "version": 1,
  "roles": ["InventorySupply"],
  "createdAt": "2015-05-28T09:48:35.023Z",
  "lastModifiedAt": "2015-05-28T09:48:35.023Z"
}