Sign in

v1

latestOpenAPI 3.0.12026-07-26381328555.2 KB
Channel

Get Channel

Retrieves the details of an channel specified by the channel ID.

get/commerce/channels/{code}

Path parameters

codestring required

Unique identifier of the channel whose details you want.

Query parameters

responseFieldsstring

limits which fields are returned in the response body

Response

OK

codestring nullable

Code to uniquely identify the channel.

countryCodestring nullable

Country code of the channel.

groupCodestring nullable

Code to uniquely identify the channel group, if any that contains this channel.

namestring nullable

Friendly name of the channel.

regionstring nullable

Region of the channel.

siteIdsinteger[] nullable

A list of site Id's that this channel contains.

tenantIdinteger

Tenant that owns the channel.