Channel Management API 2.0.0

Redeam's Channel Management endpoints allows operators to manage their product distribution through Redeam's sales channels.

Redeam's Change Notification endpoints allows operators to request a targeted refresh of Redeam's cached product schema from the operator's booking system. Requests are processed first-in, first-out (FIFO), and may take several minutes to complete.

Server

https://operator.sandbox.redeam.io/v2

Sandbox Development Environment

https://operator.redeam.io/v2

Production

Authentication

apiKey ApiKeyAuth

Fields

Key	In
X-API-Key	Header

apiKey ApiSecretAuth

Fields

Key	In
X-API-Secret	Header

Channel Bindings

Manage the connections between channels & products

GET

/channels

GET

/suppliers/{supplierId}/products/{productId}/bindings

GET

/suppliers/{supplierId}/products/{productId}/bindings/{channelId}

PUT

/suppliers/{supplierId}/products/{productId}/bindings/{channelId}

DELETE

/suppliers/{supplierId}/products/{productId}/bindings/{channelId}

Returns a list of sales channels

This endpoint returns a list of sales channels and identifiers available to the authenticated user.

Auth

GET /channels

xxxxxxxxxx
 
curl --get \ --url 'https://operator.sandbox.redeam.io/v2/channels' \ --header 'X-API-Key: {X-API-Key}' \ --header 'X-API-Secret: {X-API-Secret}'
Copy

Responses

200

Returns a list of channels.

object	object
channels	array[object]
id	uuid	The sales channel's unique identifier.
name	string	The sales channel's name.
companyName	string	The name of the company associated with the sales channel.

Response

xxxxxxxxxx
 
{ "channels": [  {   "id": "{uuid}",   "name": "Online Tours & Travel",   "companyName": "FunTimes LLC."  } ]}
Copy

Returns a list of channel bindings

Returns a list of channel bindings for productId. Each binding will associate one or more product optionIds with a given sales channel.

Options that are bound to a given sales channel are said to be distributed through the channel and will potentially receive bookings from the channel.

Auth

Path Params

supplierId	string	Identifier of the Supplier, unique to the Operator's Booking System.
productId	string	Identifier of the Product, unique within the Supplier.

GET /suppliers/{supplierId}/products/{productId}/bindings

xxxxxxxxxx
 
curl --get \ --url 'https://operator.sandbox.redeam.io/v2/suppliers/Colorado%20Center%20for%20Cycling%20%26%20Canoes/products/Raft%20%26%20Relax%20Rental/bindings' \ --header 'X-API-Key: {X-API-Key}' \ --header 'X-API-Secret: {X-API-Secret}'
Copy

Responses

200

Returns an envelope with an array of channel bindings.

object	object
bindings	array[object]
channelId	uuid	The sales channel's unique identifier.
channelName	string	The sales channel's name.
optionIds	array[string]	One or more option IDs bound to the sales channel given by `channelId`.
productId	string	The ID of the parent product of the given `optionIds`.
productName	string	the name of the product given by `productId`.
supplierId	string	The ID of parent supplier of the given `productId`.
supplierName	string	the name of the supplier given by `supplierId`.

Response

xxxxxxxxxx
 
{ "bindings": [  {   "channelId": "{uuid}",   "channelName": "Online Tours & Travel",   "optionIds": [    "24 Hour Rental",    "48 Hour Rental"   ],   "productId": "dd0b861d-56c1-44ec-9306-46190f5ea9e7",   "productName": "Raft & Relax Rental",   "supplierId": "1872cf2b-414d-4ee0-b7af-7584a3223769",   "supplierName": "Colorado Center for Cycling & Canoes"  } ]}
Copy

Returns a channel binding

Returns the sales channel bindings the channel given by channelId.

Auth

GET /suppliers/{supplierId}/products/{productId}/bindings/{channelId}

xxxxxxxxxx
 
curl --get \ --url 'https://operator.sandbox.redeam.io/v2/suppliers/{supplierId}/products/{productId}/bindings/{channelId}' \ --header 'X-API-Key: {X-API-Key}' \ --header 'X-API-Secret: {X-API-Secret}'
Copy

Responses

200

Returns a channel binding.

object	object
binding	object
channelId	uuid	The sales channel's unique identifier.
channelName	string	The sales channel's name.
optionIds	array[string]	One or more option IDs bound to the sales channel given by `channelId`.
productId	string	The ID of the parent product of the given `optionIds`.
productName	string	the name of the product given by `productId`.
supplierId	string	The ID of parent supplier of the given `productId`.
supplierName	string	the name of the supplier given by `supplierId`.

Response

xxxxxxxxxx
 
{ "binding": {  "channelId": "{uuid}",  "channelName": "Online Tours & Travel",  "optionIds": [   "24 Hour Rental",   "48 Hour Rental"  ],  "productId": "dd0b861d-56c1-44ec-9306-46190f5ea9e7",  "productName": "Raft & Relax Rental",  "supplierId": "1872cf2b-414d-4ee0-b7af-7584a3223769",  "supplierName": "Colorado Center for Cycling & Canoes" }}
Copy

Upserts a channel binding

This endpoint either inserts a new a sales channel binding between a product and a sales channel, or updates an existing bindings.

NOTE: Updating an existing channel binding replaces its current state with the requested state; it does NOT append the requested state to the current state.

Auth

Request Body

The options IDs to be channel-bound to the given sales channel.

object	object
optionIds	array[string]	A list of option identifiers belonging to the requested supplier and product, to be bound against the requested channel.

PUT /suppliers/{supplierId}/products/{productId}/bindings/{channelId}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://operator.sandbox.redeam.io/v2/suppliers/{supplierId}/products/{productId}/bindings/{channelId}' \ --header 'X-API-Key: {X-API-Key}' \ --header 'X-API-Secret: {X-API-Secret}' \ --data '{  "optionIds": [    "TOUROPTION1",    "TOUROPTION2"  ]}'
Copy

Responses

200

Returns a channel binding.

object	object
binding	object
channelId	uuid	The sales channel's unique identifier.
channelName	string	The sales channel's name.
optionIds	array[string]	One or more option IDs bound to the sales channel given by `channelId`.
productId	string	The ID of the parent product of the given `optionIds`.
productName	string	the name of the product given by `productId`.
supplierId	string	The ID of parent supplier of the given `productId`.
supplierName	string	the name of the supplier given by `supplierId`.

Response

xxxxxxxxxx
 
{ "binding": {  "channelId": "{uuid}",  "channelName": "Online Tours & Travel",  "optionIds": [   "24 Hour Rental",   "48 Hour Rental"  ],  "productId": "dd0b861d-56c1-44ec-9306-46190f5ea9e7",  "productName": "Raft & Relax Rental",  "supplierId": "1872cf2b-414d-4ee0-b7af-7584a3223769",  "supplierName": "Colorado Center for Cycling & Canoes" }}
Copy

Deletes a channel binding

Removes the association between a product, its options, and a sales channel.

Auth

DELETE /suppliers/{supplierId}/products/{productId}/bindings/{channelId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://operator.sandbox.redeam.io/v2/suppliers/{supplierId}/products/{productId}/bindings/{channelId}' \ --header 'X-API-Key: {X-API-Key}' \ --header 'X-API-Secret: {X-API-Secret}'
Copy

Responses

204

The binding was successfully deleted.

No response body

Response

xxxxxxxxxx
 
No response
Copy

Change Notifications

Push product schema changes to Redeam

/notifications/price-schedule

GET

/notifications/{requestId}

Submit a catalog change notification.

Issues a change notification to Redeam, performing an immediate poll of the operator's booking system for a given Supplier and Product, including the next 90 days of availabilities.

Auth

Query String

supplierId	string	Identifier of the Supplier, unique to the Operator's Booking System.
productId	string	Identifier of the Product, unique within the Supplier.
startDate	string	If provided, availability requests for this change notification will begin on this date (YYYY-MM-DD), inclusive. It is an error to use this parameter without specifying a valid endDate. Overrides the default 90-day period.
endDate	string	Availability requests for this change notification will end on this date (YYYY-MM-DD), exclusive. It is an error to use this parameter without specifying a valid startDate. Overrides the default 90-day period.

POST /notifications

xxxxxxxxxx
 
curl --request POST \ --url 'https://operator.sandbox.redeam.io/v2/notifications' \ --header 'X-API-Key: {X-API-Key}' \ --header 'X-API-Secret: {X-API-Secret}' \ --data supplierId={supplierId} \ --data productId={productId} \ --data startDate={startDate} \ --data endDate={endDate}
Copy

Responses

201

The details and current status of the newly created or requested change notification request.

object	object
notification	object
id	uuid	The assigned unique identifier of this change notification request.
createRequest	object
supplierId	string	Identifier of the Supplier, unique to the Operator's Booking System.
productId	string	Identifier of the Product, unique within the Supplier.
inserted	date-time	Time in RFC 3339 format when Redeam initially received the change notification request.
beganWorking	date-time	Start time in RFC 3339 format of processing on this change notification. Only present when Status is not `WAITING`.
finishedWorking	date-time	Time in RFC 3339 format when processing finished. Only present when Status is `SUCCEEDED` or `FAILED`.
mode	string	The `standard` or default mode of operation re-caches objects and availability information for a supplier & product (including all options & units under the product). `price-schedule` mode indicates that only the price schedule should be re-cached, by fetching data from the price schedule endpoint using the provided supplier & product IDs as parameters. `any` is a wildcard that matches any mode. Enum: `any`,`standard`,`price-schedule` Default: any
status	string	The current status of the change notification request. A description of the different status values and their meanings can be found below. `WAITING`: The change notification request is queued for processing. `WORKING`: The request is currently being processed. `SUCCEEDED`: The request has been completely processed. `FAILED`: An error was encountered while processing the request. Contact Redeam support for more information. `PARTIAL_FAILURE`: A portion of the requested product / price schema could not be cached successfully. Contact Redeam support for more information. Enum: `WAITING`,`WORKING`,`SUCCEEDED`,`FAILED`,`PARTIAL_FAILURE`

Expand

400

One or more of the request parameters are missing or invalid.

401

The server was unable to authenticate the user with the provided credentials.

403

The request was attempted without authentication credentials. Unauthenticated access to this endpoint is forbidden.

500

A server error occurred while processing the request.

Response

xxxxxxxxxx
 
{ "notification": {  "id": "65be327b-2fdc-4d99-9535-831ad3d671e6",  "createRequest": {   "supplierId": "Colorado Center for Cycling & Canoes",   "productId": "Raft & Relax Rental"  },  "inserted": "2006-01-02T15:04:05Z",  "beganWorking": "2006-01-02T15:04:05Z",  "finishedWorking": "2006-01-02T15:04:05Z",  "mode": "{string}",  "status": "{string}" }}
Copy

List all submitted change notifications.

Provides a list of all previously submitted change notifications.

Auth

Query String

limit	integer	Maximum number of results to return
offset	integer	The number of results to skip (starting from the first result) in the return Combined with limit, this may be used to page results through multiple requests.
requestId	string	Identifier of the notification request, returned upon creation.
supplierId	string	Only return notifications requested for this supplier.
productId	string	Only return notifications requested for this product.
mode	string	Only return notifications in the specified mode. Enum: `any`,`standard`,`price-schedule` Default: any
status	string	Only return notifications currently in this status. Enum: `WAITING`,`WORKING`,`SUCCEEDED`,`FAILED`,`PARTIAL_FAILURE`

GET /notifications

xxxxxxxxxx
 
curl --get \ --url 'https://operator.sandbox.redeam.io/v2/notifications' \ --header 'X-API-Key: {X-API-Key}' \ --header 'X-API-Secret: {X-API-Secret}' \ --data limit={limit} \ --data offset={offset} \ --data requestId={requestId} \ --data supplierId={supplierId} \ --data productId={productId} \ --data mode=any \ --data status={status}
Copy

Responses

200

List of change notification requests

object	object
notifications	array[object]
id	uuid	The assigned unique identifier of this change notification request.
createRequest	object
supplierId	string	Identifier of the Supplier, unique to the Operator's Booking System.
productId	string	Identifier of the Product, unique within the Supplier.
inserted	date-time	Time in RFC 3339 format when Redeam initially received the change notification request.
beganWorking	date-time	Start time in RFC 3339 format of processing on this change notification. Only present when Status is not `WAITING`.
finishedWorking	date-time	Time in RFC 3339 format when processing finished. Only present when Status is `SUCCEEDED` or `FAILED`.
mode	string	The `standard` or default mode of operation re-caches objects and availability information for a supplier & product (including all options & units under the product). `price-schedule` mode indicates that only the price schedule should be re-cached, by fetching data from the price schedule endpoint using the provided supplier & product IDs as parameters. `any` is a wildcard that matches any mode. Enum: `any`,`standard`,`price-schedule` Default: any
status	string	The current status of the change notification request. A description of the different status values and their meanings can be found below. `WAITING`: The change notification request is queued for processing. `WORKING`: The request is currently being processed. `SUCCEEDED`: The request has been completely processed. `FAILED`: An error was encountered while processing the request. Contact Redeam support for more information. `PARTIAL_FAILURE`: A portion of the requested product / price schema could not be cached successfully. Contact Redeam support for more information. Enum: `WAITING`,`WORKING`,`SUCCEEDED`,`FAILED`,`PARTIAL_FAILURE`

Expand

401

The server was unable to authenticate the user with the provided credentials.

403

The request was attempted without authentication credentials. Unauthenticated access to this endpoint is forbidden.

500

A server error occurred while processing the request.

Response

xxxxxxxxxx
 
{ "notifications": [  {   "id": "65be327b-2fdc-4d99-9535-831ad3d671e6",   "createRequest": {    "supplierId": "Colorado Center for Cycling & Canoes",    "productId": "Raft & Relax Rental"   },   "inserted": "2006-01-02T15:04:05Z",   "beganWorking": "2006-01-02T15:04:05Z",   "finishedWorking": "2006-01-02T15:04:05Z",   "mode": "{string}",   "status": "{string}"  } ]}
Copy

Submit a price schedule change notification

Issues a request for Redeam to pull and re-cache the latest available information from the partner's price-schedule endpoint.

Auth

Query String

supplierId	string	Identifier of the Supplier, unique to the Operator's Booking System.
productId	string	Identifier of the Product, unique within the Supplier.
startDate	string	Starting date for the requested price schedule change. If not provided, or left blank, defaults to today's date.
endDate	string	Ending date for the requested price schedule change. If not provided, or left blank, defaults to one year after the startDate.

POST /notifications/price-schedule

xxxxxxxxxx
 
curl --request POST \ --url 'https://operator.sandbox.redeam.io/v2/notifications/price-schedule' \ --header 'X-API-Key: {X-API-Key}' \ --header 'X-API-Secret: {X-API-Secret}' \ --data supplierId={supplierId} \ --data productId={productId} \ --data startDate={startDate} \ --data endDate={endDate}
Copy

Responses

201

The details and current status of the newly created or requested change notification request.

object	object
notification	object
id	uuid	The assigned unique identifier of this change notification request.
createRequest	object
supplierId	string	Identifier of the Supplier, unique to the Operator's Booking System.
productId	string	Identifier of the Product, unique within the Supplier.
inserted	date-time	Time in RFC 3339 format when Redeam initially received the change notification request.
beganWorking	date-time	Start time in RFC 3339 format of processing on this change notification. Only present when Status is not `WAITING`.
finishedWorking	date-time	Time in RFC 3339 format when processing finished. Only present when Status is `SUCCEEDED` or `FAILED`.
mode	string	The `standard` or default mode of operation re-caches objects and availability information for a supplier & product (including all options & units under the product). `price-schedule` mode indicates that only the price schedule should be re-cached, by fetching data from the price schedule endpoint using the provided supplier & product IDs as parameters. `any` is a wildcard that matches any mode. Enum: `any`,`standard`,`price-schedule` Default: any
status	string	The current status of the change notification request. A description of the different status values and their meanings can be found below. `WAITING`: The change notification request is queued for processing. `WORKING`: The request is currently being processed. `SUCCEEDED`: The request has been completely processed. `FAILED`: An error was encountered while processing the request. Contact Redeam support for more information. `PARTIAL_FAILURE`: A portion of the requested product / price schema could not be cached successfully. Contact Redeam support for more information. Enum: `WAITING`,`WORKING`,`SUCCEEDED`,`FAILED`,`PARTIAL_FAILURE`

Expand

401

The server was unable to authenticate the user with the provided credentials.

403

The request was attempted without authentication credentials. Unauthenticated access to this endpoint is forbidden.

500

A server error occurred while processing the request.

Response

xxxxxxxxxx
 
{ "notification": {  "id": "65be327b-2fdc-4d99-9535-831ad3d671e6",  "createRequest": {   "supplierId": "Colorado Center for Cycling & Canoes",   "productId": "Raft & Relax Rental"  },  "inserted": "2006-01-02T15:04:05Z",  "beganWorking": "2006-01-02T15:04:05Z",  "finishedWorking": "2006-01-02T15:04:05Z",  "mode": "{string}",  "status": "{string}" }}
Copy

Fetch a change notification.

Returns the details and current status of a specific change notification request.

Auth

Path Params

requestId

string

Identifier of the change notification to retrieve.

GET /notifications/{requestId}

xxxxxxxxxx
 
curl --get \ --url 'https://operator.sandbox.redeam.io/v2/notifications/a87062d3-4310-4405-8c2a-1b69829652d6' \ --header 'X-API-Key: {X-API-Key}' \ --header 'X-API-Secret: {X-API-Secret}'
Copy

Responses

200

The details and current status of the newly created or requested change notification request.

object	object
notification	object
id	uuid	The assigned unique identifier of this change notification request.
createRequest	object
supplierId	string	Identifier of the Supplier, unique to the Operator's Booking System.
productId	string	Identifier of the Product, unique within the Supplier.
inserted	date-time	Time in RFC 3339 format when Redeam initially received the change notification request.
beganWorking	date-time	Start time in RFC 3339 format of processing on this change notification. Only present when Status is not `WAITING`.
finishedWorking	date-time	Time in RFC 3339 format when processing finished. Only present when Status is `SUCCEEDED` or `FAILED`.
mode	string	The `standard` or default mode of operation re-caches objects and availability information for a supplier & product (including all options & units under the product). `price-schedule` mode indicates that only the price schedule should be re-cached, by fetching data from the price schedule endpoint using the provided supplier & product IDs as parameters. `any` is a wildcard that matches any mode. Enum: `any`,`standard`,`price-schedule` Default: any
status	string	The current status of the change notification request. A description of the different status values and their meanings can be found below. `WAITING`: The change notification request is queued for processing. `WORKING`: The request is currently being processed. `SUCCEEDED`: The request has been completely processed. `FAILED`: An error was encountered while processing the request. Contact Redeam support for more information. `PARTIAL_FAILURE`: A portion of the requested product / price schema could not be cached successfully. Contact Redeam support for more information. Enum: `WAITING`,`WORKING`,`SUCCEEDED`,`FAILED`,`PARTIAL_FAILURE`

Expand

401

The server was unable to authenticate the user with the provided credentials.

403

The request was attempted without authentication credentials. Unauthenticated access to this endpoint is forbidden.

404

The requested resource could not be located.

500

A server error occurred while processing the request.

Response

xxxxxxxxxx
 
{ "notification": {  "id": "65be327b-2fdc-4d99-9535-831ad3d671e6",  "createRequest": {   "supplierId": "Colorado Center for Cycling & Canoes",   "productId": "Raft & Relax Rental"  },  "inserted": "2006-01-02T15:04:05Z",  "beganWorking": "2006-01-02T15:04:05Z",  "finishedWorking": "2006-01-02T15:04:05Z",  "mode": "{string}",  "status": "{string}" }}
Copy