Overview
The Channel Management API is provided by Redeam for clients to manage the connections between a supplier's products and one or more sales channels.
Before new channel bindings can be created, the Redeam system must first cache the operator's catalog (suppliers & products) so that connections can be made between the catalog & channels through Redeam.
Redeam will query for new or updated catalog information at least once a day. Updates can be requested earlier through Change Notifications.
Channel Bindings
The association between a channel and one or more product options is called a Channel Binding.
Product options which are not bound to a channel will not be visible or bookable through that channel..
A call to this endpoint requires that the following fields be specified in the request:
| Field Name | Type | Description |
|---|---|---|
channelId | string | The channel's identifier (see GET /channelsAPI endpoint) |
channelName | string | The channel's name (see GET /channelsAPI endpoint) |
optionIds | array[string] | A list of one or more product options to make visible on the provided channel |
productId | string | The product identifier to make visible on this channel |
productName | string | The name of the product to make visible on this channel (must match the Product object's name field) |
supplierId | string | The supplier identifier to make visible on this channel |
supplierName | string | The name of the supplier to make visible on this channel (must match the Supplier object's name field) |
Change Notifications
When an operator adds or changes their catalog, Redeam must update its cached catalog data. This update will occur automatically once a day - however, in the event that catalog data has been changed significantly, or new data has been added that must be bound, it may be necessary to request a catalog cache update immediately.
New change notification requests may be sent through the POST /notifications endpoint with a valid supplierId and productId. This request will enqueue a task with Redeam's system to update the catalog cache with all options and units underneath the requested supplier & product.
New requests will always return with a status of WAITING. The status of a change notification request can be checked through the GET /notifications endpoint. The request will transition to WORKING once it starts being processed, and then SUCCEEDED or FAILED if any errors are encountered.