Channel GET
URI
https://{DATACENTER}.brightpearlconnect.com/public-api/{ACCOUNT}/product-service/channel/{ID-SET} Refer to our documentation on URI syntax for more information on how to construct URIs.
Description
Returns channel information and relevant integration details if exists
Will return the channels in sorted order of channel id.
Example 1
Requesting all Channels.
Request URI
/channel/ Response
{
"response": [
{
"id": 1,
"name": "Department 1",
"channelTypeId": 2,
"channelBrandId": 1
},
{
"id": 2,
"name": "Channel Post Duplicate",
"channelTypeId": 1,
"channelBrandId": 1
},
{
"id": 3,
"name": "Ebay Channel",
"channelTypeId": 5,
"defaultWarehouseId": 3,
"contactGroupId": 1,
"defaultPriceListId": 1,
"channelBrandId": 2,
"warehouseIds": [
3
],
"integrationDetail": {
"installedIntegrationId": 1,
"configSetId": 2,
"providerCode": "ebay",
"integrationTypeCode": "MKP",
"active": true
}
},
{
"id": 4,
"name": "Channel 2",
"channelTypeId": 1,
"defaultWarehouseId": 3,
"contactGroupId": 1,
"defaultPriceListId": 1,
"channelBrandId": 2,
"warehouseIds": [
3
]
},
{
"id": 5,
"name": "Channel 3",
"channelTypeId": 1,
"defaultWarehouseId": 3,
"contactGroupId": 1,
"defaultPriceListId": 1,
"channelBrandId": 2,
"warehouseIds": [
3,
4,
5
]
}
]
}Example 2
Requesting Channels using an Id Set.
Request URI
/channel/1,4 Response
{
"response": [
{
"id": 1,
"name": "Department 1",
"channelTypeId": 2,
"channelBrandId": 1
},
{
"id": 4,
"name": "Channel 2",
"channelTypeId": 1,
"defaultWarehouseId": 3,
"contactGroupId": 1,
"defaultPriceListId": 1,
"channelBrandId": 2,
"warehouseIds": [
3
]
}
]
}