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.
Sandbox Development Environment
Production
Channel Bindings
Manage the connections between channels & products
Returns a list of sales channels
This endpoint returns a list of sales channels and identifiers available to the authenticated user.
Returns a list of channels.
Returns a list of channel bindings
Returns a list of channel bindings for productId
. Each binding will associate one or more product optionId
s 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.
Returns an envelope with an array of channel bindings.
Returns a channel binding
Returns the sales channel bindings the channel given by channelId
.
Returns a channel binding.
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.
The options IDs to be channel-bound to the given sales channel.
Returns a channel binding.
Deletes a channel binding
Removes the association between a product, its options, and a sales channel.
The binding was successfully deleted.
Change Notifications
Push product schema changes to Redeam
List all submitted change notifications.
Provides a list of all previously submitted change notifications.
List of change notification requests
The server was unable to authenticate the user with the provided credentials.
The request was attempted without authentication credentials. Unauthenticated access to this endpoint is forbidden.
A server error occurred while processing the request.
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 365 days of availabilities if no date range is supplied
The details and current status of the newly created or requested change notification request.
One or more of the request parameters are missing or invalid.
The server was unable to authenticate the user with the provided credentials.
The request was attempted without authentication credentials. Unauthenticated access to this endpoint is forbidden.
A server error occurred while processing the request.
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.
The details and current status of the newly created or requested change notification request.
The server was unable to authenticate the user with the provided credentials.
The request was attempted without authentication credentials. Unauthenticated access to this endpoint is forbidden.
A server error occurred while processing the request.
Fetch a change notification.
Returns the details and current status of a specific change notification request.
The details and current status of the newly created or requested change notification request.
The server was unable to authenticate the user with the provided credentials.
The request was attempted without authentication credentials. Unauthenticated access to this endpoint is forbidden.
The requested resource could not be located.
A server error occurred while processing the request.
Cron Reports
For full OBS syncronizations which are triggered automatically by Redeam at regular intervals, these endpoints report on when the run finished, and any errors that occurred.
Full OBS syncronizations pull in all current supplier, product, and availability data from the partner's Operating Booking System. Price schedule data is not synced; price schedule change notifications are required to pull up-to-date price schedule information.
Fetches a list of error reports.
Enumerates a truncated version of all error reports from the past 60 days for the user within the provided parameters.
Truncated reports do not contain errors; only identifiers and associated metadata. To access the errors inside of a report record, use the GET /cron/reports/{id}
endpoint.
A list of cron reports.
Client parameters failed validation.
An internal error has occurred.
Fetches an error report by its identifier.
Endpoint returns the full error report, including all associated errors. Records which do not include an errorReport
field did not produce any errors.
Returns the record identified by id
.
The provided id
is not a valid, positive integer.
The requested record was not found.
An internal error has occurred.