Channels

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

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

Representations

Channel

ChannelDraft

ChannelRoleEnum

ChannelRole enum describes the purpose and the type of this channel. Each channel can have one or more of following roles:

Query Channels

Endpoint: /{projectKey}/channels
Method: GET
OAuth2 Scopes: view_products:{projectKey}
Response Representation: PagedQueryResult with the results array of Channel
Query Parameters:

Get Channel by ID

Endpoint: /{projectKey}/channels/{id}
Method: GET
OAuth2 Scopes: view_products:{projectKey}
Response Representation: Channel

Create a Channel

Endpoint: /{projectKey}/channels
Method: POST
OAuth2 Scopes: manage_products:{projectKey}
Request Representation: ChannelDraft
Response Representation: Channel

Update Channel

Endpoint: /{projectKey}/channels/{id}
Method: POST
OAuth2 Scopes: manage_products:{projectKey}
Response Representation: Channel
Fields:

Update Actions
Please find below the individual update actions provided on this endpoint.


Change Key

Change Name

Change Description

Set Roles

Add Roles

Remove Roles

Set Address

Set Custom Type

This action sets or removes the custom type for an existing channel.

This action overwrites any existing custom type and fields.

Set CustomField

Set GeoLocation

Delete Channel

This request deletes channel only if it’s not referenced by other entities like inventory or LineItem.

Endpoint: /{projectKey}/channels/{id}
Method: DELETE
OAuth2 Scopes: manage_products:{projectKey} Query Parameters:

comments powered by Disqus