Channels
List channels and retrieve channel details using the Platform API.
2 min read
Channels are the export destinations for your data — for example, Google Shopping or Amazon.
Get
Use a GET request to list all channels for a site or retrieve a specific channel.
curl https://platform-api.productsup.io/platform/v2/sites/123/channelscurl https://platform-api.productsup.io/platform/v2/sites/123/channels/321{
"success": true,
"Channels": [
{
"id": "321",
"site_id": "123",
"channel_id": "111",
"name": "Criteo DE",
"export_name": "Criteo",
"links": [...]
},
{
"id": "541",
"site_id": "123",
"channel_id": "222",
"name": "Zanox DE",
"export_name": "FZanox",
"links": [...]
}
]
}Get all channels for a site
GET https://platform-api.productsup.io/platform/v2/sites/<siteId>/channels
| Field | Type | Description |
|---|---|---|
siteId | integer | Site to list channels for |
Get a channel by its identifier
GET https://platform-api.productsup.io/platform/v2/sites/<siteId>/channels/<channelId>
| Field | Type | Description |
|---|---|---|
siteId | integer | Site the channel belongs to |
channelId | integer | Channel to retrieve; use the site channel relation ID |
Response fields
| Field | Type | Description |
|---|---|---|
success | boolean | Indicates request status |
Channels | array | List of channels |
Channel fields
| Field | Type | Description |
|---|---|---|
id | integer | ID of the site channel relation |
site_id | integer | ID of the referenced site |
channel_id | integer | ID of the channel |
name | string | Name of the export as configured on the channel |
export_name | string | Generic name of the export in the Productsup system |
links | array | See link fields |
Links fields and values
| Name | Description |
|---|---|
self | Link to channel detail |
site | Link to site |
How is this guide?