Get Channel Group

Retrieves the details of an channel group specified by the code.

GET /commerce/channelgroups/{code}

Error

A valid request URL is required to generate request examples

200

{
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "code": "<string>",
  "name": "<string>",
  "tenantId": 123
}

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

200

application/json

Success

Used to group channels together to manage common channel information.

auditInfo · object

Show child attributes

code · string | null

Code to uniquely identify the channel.

name · string | null

Friendly name of the channel.

tenantId · integer<int32>

Tenant that owns the channel.