Skip to main content
GET
/
commerce
/
channels
/
{code}
Error
A valid request URL is required to generate request examples
{
  "tenantId": 123,
  "code": "<string>",
  "name": "<string>",
  "region": "<string>",
  "countryCode": "<string>",
  "groupCode": "<string>",
  "siteIds": [
    123
  ],
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
code
string
required

Unique identifier of the channel whose details you want.

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Response

Success

Channel used to group sites for commerce purposes.

​
tenantId
integer<int32>

Tenant that owns the channel.

​
code
string | null

Code to uniquely identify the channel.

​
name
string | null

Friendly name of the channel.

​
region
string | null

Region of the channel.

​
countryCode
string | null

Country code of the channel.

​
groupCode
string | null

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

​
siteIds
integer<int32>[] | null

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

​
auditInfo
object