xxxxxxxxxx
 
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

object	object
channels	array[object]	The channels
activationDelay	string	Activation delay of the channel
companyName	string	Company name of the channel
config	object	Map of string to string, representing Channel configuration data. For example, a key of 'olci-required' with a value of 'true' or 'false' informs an API client about the Online Check-in status of the Channel.
ext	object	Extended data for channel
id	uuid	ID of the channel
logoUrl	string	Logo URL of the channel
name	string	Name of the channel
url	string	URL of the channel
meta	object	Request meta data
reqId	uuid	Request ID

401

List available channels

Response

xxxxxxxxxx
 
{ "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-ID

string

Request ID for request tracking.

Path Params

channel_id string

GET /channels/{channel_id}

xxxxxxxxxx
 
curl --get \ --url 'https://channel.redeam.io/v1.2/channels/%7Bchannel_id%7D' \ --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

object	object
channel	object	The channel
activationDelay	string	Activation delay of the channel
companyName	string	Company name of the channel
config	object	Map of string to string, representing Channel configuration data. For example, a key of 'olci-required' with a value of 'true' or 'false' informs an API client about the Online Check-in status of the Channel.
ext	object	Extended data for channel
id	uuid	ID of the channel
logoUrl	string	Logo URL of the channel
name	string	Name of the channel
url	string	URL of the channel
meta	object	Request meta data
reqId	uuid	Request ID

400

Get a single channel

401

Get a single channel

Response

xxxxxxxxxx
 
{ "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-ID

string

Request ID for request tracking.

Path Params

product_id	string
supplier_id	string

GET /suppliers/{supplier_id}/products/{product_id}/channels

xxxxxxxxxx
 
curl --get \ --url 'https://channel.redeam.io/v1.2/suppliers/%7Bsupplier_id%7D/products/%7Bproduct_id%7D/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

object	object
channelRates	array[object]	The ChannelRates
channel	object	The channel
activationDelay	string	Activation delay of the channel
companyName	string	Company name of the channel
config	object	Map of string to string, representing Channel configuration data. For example, a key of 'olci-required' with a value of 'true' or 'false' informs an API client about the Online Check-in status of the Channel.
ext	object	Extended data for channel
id	uuid	ID of the channel
logoUrl	string	Logo URL of the channel
name	string	Name of the channel
url	string	URL of the channel
priceAt	string	Price at time of Enum: `PRICE_AT_REDEMPTION`,`PRICE_AT_SALE`,`PRICE_AT_UNKNOWN`
priceTags	array[string]	Select of Price.Tags to offer on this channel
rateIds	array[string]	RateIDs to expose
valid	object	time range during which the rate applies
from	date-time	Valid from time
until	date-time	Valid until time
meta	object	Request meta data
reqId	uuid	Request ID

401

Channel listings for a product

404

Channel listings for a product

Response

xxxxxxxxxx
 
{ "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-ID

string

Request ID for request tracking.

Path Params

channel_id	string
product_id	string
supplier_id	string

DELETE /suppliers/{supplier_id}/products/{product_id}/channels/{channel_id}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://channel.redeam.io/v1.2/suppliers/%7Bsupplier_id%7D/products/%7Bproduct_id%7D/channels/%7Bchannel_id%7D' \ --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

xxxxxxxxxx
 
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-ID

string

Request ID for request tracking.

Path Params

channel_id	string
product_id	string
supplier_id	string

Request Body

object	object
meta	object	Request meta data
reqId	uuid	Request ID
priceAt	string	Price at time of Enum: `PRICE_AT_REDEMPTION`,`PRICE_AT_SALE`,`PRICE_AT_UNKNOWN`
priceTags	array[string]	Labels that must be present on a RatePrice in order to be visible
rateIds	array[string]	Rate IDs exposed on the channel
valid	object	time period the binding is valid for
from	date-time	Valid from time
until	date-time	Valid until time

POST /suppliers/{supplier_id}/products/{product_id}/channels/{channel_id}

xxxxxxxxxx
 
curl --request POST \ --url 'https://channel.redeam.io/v1.2/suppliers/%7Bsupplier_id%7D/products/%7Bproduct_id%7D/channels/%7Bchannel_id%7D' \ --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