SearchCtrl K
HomeChannel APIBooking APIPartner APIBooking API ReferencePartner API ReferenceChannel API Reference
Channel API Reference
Authentication
Channels
GETList available channels
GETGet a single channel
GETChannel listings for a product
DELETERemove a channel binding
POSTCreate a channel binding for a product
PUTUpdate a channel binding for a product
Products
POSTBulk create products
PUTBulk update products
GETBulk products callback
GETRetrieve a list of products
POSTCreate a product
DELETEDelete a product
GETRetrieve a single product
PUTUpdate a product
Rates
POSTBulk create rates
PUTBulk update rates
GETBulk rates callback
GETRetrieve a list of rates
POSTCreate a rate
DELETERemove a rate
GETRetrieve a single rate
PUTUpdate a rate
Suppliers
POSTBulk create suppliers
PUTBulk update suppliers
GETBulk suppliers callback
GETRetrieve a list of suppliers
POSTCreate a single supplier
DELETERemove a supplier
GETRetrieve a single supplier
PUTUpdate a supplier
Availabilities
GETRetrieve a list of availabilities
GETRetrieve a single availability
PUTSet availabilities for a given rate

Channel API Reference 1.2Proprietary

Description of the Channel API.

Server
channel.redeam.io
Server Variables

Authentication

apiKey APIKeyHeader
Fields
KeyIn
X-API-KeyHeader
apiKey APISecretHeader
Fields
KeyIn
X-API-SecretHeader

List available channels

Returns a list of channels.

Auth
Headers
X-Request-IDstring

Request ID for request tracking.

GET /channels
curl --get \
--url 'https://channel.redeam.io/v1.2/channels' \
--header 'X-Request-ID: {X-Request-ID}' \
--header 'X-API-Key: {X-API-Key}' \
--header 'X-API-Secret: {X-API-Secret}'
Copy
Responses application/json
200

List available channels

objectobject
channels8 fieldsarray[object]

The channels

metaobject

Request meta data

reqIduuid

Request ID

401

List available channels

Response
{
"channels": [
{
"activationDelay": "string",
"companyName": "string",
"config": {
"string": "string"
},
"ext": {
"string": "string"
},
"id": "5fd78809-4700-46d7-8386-3b8738117f4d",
"logoUrl": "https://example.com",
"name": "string",
"url": "https://example.com"
}
],
"meta": {
"reqId": "5fd78809-4700-46d7-8386-3b8738117f4d"
}
}
Copy

Get a single channel

Returns a channel.

Auth
Headers
X-Request-IDstring

Request ID for request tracking.

Path Params
channel_idstring
GET /channels/{channel_id}
curl --get \
--url 'https://channel.redeam.io/v1.2/channels/{channel_id}' \
--header 'X-Request-ID: {X-Request-ID}' \
--header 'X-API-Key: {X-API-Key}' \
--header 'X-API-Secret: {X-API-Secret}'
Copy
Responses application/json
200

Get a single channel

objectobject
channel8 fieldsobject

The channel

metaobject

Request meta data

reqIduuid

Request ID

400

Get a single channel

401

Get a single channel

Response
{
"channel": {
"activationDelay": "string",
"companyName": "string",
"config": {
"string": "string"
},
"ext": {
"string": "string"
},
"id": "5fd78809-4700-46d7-8386-3b8738117f4d",
"logoUrl": "https://example.com",
"name": "string",
"url": "https://example.com"
},
"meta": {
"reqId": "5fd78809-4700-46d7-8386-3b8738117f4d"
}
}
Copy

Channel listings for a product

Returns a list of product channels.

Auth
Headers
X-Request-IDstring

Request ID for request tracking.

Path Params
product_idstring
supplier_idstring
GET /suppliers/{supplier_id}/products/{product_id}/channels
curl --get \
--url 'https://channel.redeam.io/v1.2/suppliers/{supplier_id}/products/{product_id}/channels' \
--header 'X-Request-ID: {X-Request-ID}' \
--header 'X-API-Key: {X-API-Key}' \
--header 'X-API-Secret: {X-API-Secret}'
Copy
Responses application/json
200

Channel listings for a product

objectobject
channelRates5 fieldsarray[object]

The ChannelRates

metaobject

Request meta data

reqIduuid

Request ID

401

Channel listings for a product

404

Channel listings for a product

Response
{
"channelRates": [
{
"channel": {
"activationDelay": "string",
"companyName": "string",
"config": {
"string": "string"
},
"ext": {
"string": "string"
},
"id": "5fd78809-4700-46d7-8386-3b8738117f4d",
"logoUrl": "https://example.com",
"name": "string",
"url": "https://example.com"
},
"priceAt": "PRICE_AT_REDEMPTION",
"priceTags": [
"string"
],
"rateIds": [
"string"
],
"valid": {
"from": "2018-10-19T17:37:31-06:00",
"until": "2018-10-19T17:37:31-06:00"
}
}
],
"meta": {
"reqId": "5fd78809-4700-46d7-8386-3b8738117f4d"
}
}
Copy

Remove a channel binding

Revoke access to a Product for the specified Channel.

Auth
Headers
X-Request-IDstring

Request ID for request tracking.

Path Params
channel_idstring
product_idstring
supplier_idstring
DELETE /suppliers/{supplier_id}/products/{product_id}/channels/{channel_id}
curl --request DELETE \
--url 'https://channel.redeam.io/v1.2/suppliers/{supplier_id}/products/{product_id}/channels/{channel_id}' \
--header 'X-Request-ID: {X-Request-ID}' \
--header 'X-API-Key: {X-API-Key}' \
--header 'X-API-Secret: {X-API-Secret}'
Copy
Responses application/json
204

Remove a channel binding

No response body
400

Remove a channel binding

401

Remove a channel binding

404

Remove a channel binding

Response
No response
Copy

Create a channel binding for a product

Grants a Channel access to sell a Supplier's Product, at one of the provided Rates.

A list of priceTags may be provided to filter the RatePrices visible to this Channel. All priceTags must be present in a RatePrice's labels for it to be visible to the Channel.

Auth
Headers
X-Request-IDstring

Request ID for request tracking.

Path Params
channel_idstring
product_idstring
supplier_idstring
Request Body
objectobject
metaobject

Request meta data

reqIduuid

Request ID

priceAtstring

Price at time of

Enum: PRICE_AT_REDEMPTION,PRICE_AT_SALE,PRICE_AT_UNKNOWN

priceTagsarray[string]

Labels that must be present on a RatePrice in order to be visible

rateIdsarray[string]

Rate IDs exposed on the channel

validobject

time period the binding is valid for

fromdate-time

Valid from time

untildate-time

Valid until time

POST /suppliers/{supplier_id}/products/{product_id}/channels/{channel_id}
curl --request POST \
--url 'https://channel.redeam.io/v1.2/suppliers/{supplier_id}/products/{product_id}/channels/{channel_id}' \
--header 'X-Request-ID: {X-Request-ID}' \
--header 'X-API-Key: {X-API-Key}' \
--header 'X-API-Secret: {X-API-Secret}' \
--data '{
"meta": {
"reqId": "5fd78809-4700-46d7-8386-3b8738117f4d"
},
"priceAt": "PRICE_AT_REDEMPTION",
"priceTags": [
"string"
],
"rateIds": [
"string"
],
"valid": {
"from": "2018-10-19T17:37:31-06:00",
"until": "2018-10-19T17:37:31-06:00"
}
}'
Copy
Responses application/json
201

Create a channel binding for a product

objectobject
channelRates5 fieldsarray[object]

The ChannelRates

metaobject

Request meta data

reqIduuid

Request ID

204

Create a channel binding for a product

400

Create a channel binding for a product

401

Create a channel binding for a product

404

Create a channel binding for a product

409

Create a channel binding for a product

Response
{
"channelRates": [
{
"channel": {
"activationDelay": "string",
"companyName": "string",
"config": {
"string": "string"
},
"ext": {
"string": "string"
},
"id": "5fd78809-4700-46d7-8386-3b8738117f4d",
"logoUrl": "https://example.com",
"name": "string",
"url": "https://example.com"
},
"priceAt": "PRICE_AT_REDEMPTION",
"priceTags": [
"string"
],
"rateIds": [
"string"
],
"valid": {
"from": "2018-10-19T17:37:31-06:00",
"until": "2018-10-19T17:37:31-06:00"
}
}
],
"meta": {
"reqId": "5fd78809-4700-46d7-8386-3b8738117f4d"
}
}
Copy

Update a channel binding for a product

Updates a Channel's access to a Supplier's Product.

Auth
Headers
X-Request-IDstring

Request ID for request tracking.

Path Params
channel_idstring
product_idstring
supplier_idstring
Request Body
objectobject
metaobject

Request meta data

reqIduuid

Request ID

priceAtstring

Price at time of

Enum: PRICE_AT_REDEMPTION,PRICE_AT_SALE,PRICE_AT_UNKNOWN

priceTagsarray[string]

Labels that must be present on a RatePrice in order to be visible

rateIdsarray[string]

Rate IDs exposed on the channel

validobject

time period the binding is valid for

fromdate-time

Valid from time

untildate-time

Valid until time

PUT /suppliers/{supplier_id}/products/{product_id}/channels/{channel_id}
curl --request PUT \
--url 'https://channel.redeam.io/v1.2/suppliers/{supplier_id}/products/{product_id}/channels/{channel_id}' \
--header 'X-Request-ID: {X-Request-ID}' \
--header 'X-API-Key: {X-API-Key}' \
--header 'X-API-Secret: {X-API-Secret}' \
--data '{
"meta": {
"reqId": "5fd78809-4700-46d7-8386-3b8738117f4d"
},
"priceAt": "PRICE_AT_REDEMPTION",
"priceTags": [
"string"
],
"rateIds": [
"string"
],
"valid": {
"from": "2018-10-19T17:37:31-06:00",
"until": "2018-10-19T17:37:31-06:00"
}
}'
Copy
Responses application/json
200

Update a channel binding for a product

objectobject
channelRates5 fieldsarray[object]

The ChannelRates

metaobject

Request meta data

reqIduuid

Request ID

400

Update a channel binding for a product

401

Update a channel binding for a product

404

Update a channel binding for a product

Response
{
"channelRates": [
{
"channel": {
"activationDelay": "string",
"companyName": "string",
"config": {
"string": "string"
},
"ext": {
"string": "string"
},
"id": "5fd78809-4700-46d7-8386-3b8738117f4d",
"logoUrl": "https://example.com",
"name": "string",
"url": "https://example.com"
},
"priceAt": "PRICE_AT_REDEMPTION",
"priceTags": [
"string"
],
"rateIds": [
"string"
],
"valid": {
"from": "2018-10-19T17:37:31-06:00",
"until": "2018-10-19T17:37:31-06:00"
}
}
],
"meta": {
"reqId": "5fd78809-4700-46d7-8386-3b8738117f4d"
}
}
Copy