Quick Start

The Redeam and Partner APIs are documented in a machine-readable format via a OpenAPI (AKA Swagger) files. Depending on your implementation language, you may be able to code-generate an SDK to ease implementation. To learn more about the available parameters and endpoints, see the Channel API Reference and Partner API Reference.

Channel API

Partner API

Meta

Represented in JSON as the meta field, this object is included in all request/response bodies and includes a Request ID (reqId) to allow for cross-system request tracing.

Channel API Implementation Tasks

View Available Channels

Resellers are typically associated with a specific channel in the Redeam API. Some resellers, however, may choose to offer multiple channels. Channels can also be owned by suppliers.

To view a list of available channels, send a GET request to /channels.

Notes:

• The activationDelay in the response indicates the amount of time required to activate a new channel listing. Depending on the reseller, it may take several days for Redeam to complete and verify the mapping and configuration.
• The channel_id in the response is required in order to create a channel binding or remove a product.

Add Suppliers

Supplier records are maintained by a ticketing or reservation system. When adding a supplier, include as much detail as possible. Some resellers require information such as location in order to sell a product.

To add a supplier, send a POST request to /suppliers.

Notes:

• The ext field in the request allows you to annotate a supplier with your own internal IDs. This will assist during the mapping of Redeam's IDs to your own.
• The supplier_id in the response is required in order to view a supplier or update a supplier record.

Add Products

Products must include one or more rates before they can be listed on a channel. When adding a product, include as much detail as possible. Some resellers require information such as Open Hours in order to sell a product.

To add a product, send a POST request to /suppliers/{supplier_id}/products.

Notes:

• The ext field allows you to annotate a product with your own internal IDs. This will assist during the mapping of Redeam's IDs to your own.
• To add a product without displaying it to resellers, set the product_status field to DRAFT.
• The product_id value in the response is required in order to update a product record or delete a product.

Add Rates

Rates must include a list of suggested (Retail) and contractual (Net) prices for each TravelerType. Each rate/TravelerType can include multiple prices for different currencies.

Rates also include details, such as:

• type (Freesale, Reserved)
• hours
• holdable
• cancelable
• refundable
• minTravelers
• maxTravelers
• cutoff

To add a rate, send a POST request to /suppliers/{supplier_id}/products/{product_id}/rates.

Notes:

• The labels field allows you to add one or more tags to a price. Tags can be used to reference specific prices when creating a channel binding. This comes in handy when associating a specific set of rates and prices with a channel listing.
• The hours field allows you to add a list of Open Hours rules that can be used to override the default hours specified in the product record.
• The rate_id value in the response is required in order to update a rate record or delete a rate.

Create ChannelBindings

ChannelBindings must include a priceAt rule with a value of either SALE or REDEMPTION.

To create a channel listing, send a PUT request to /suppliers/{supplier_id}/products/{product_id}/channels/{channel_id}.

Notes:

• You can use the priceTags and rateIds arrays to select a specific set of rates/prices. The priceTags array identifies which labels to include for the rates specified in the rateIds array.
• The activationDelay in the response indicates the amount of time required to activate a new channel listing. Depending on the reseller, it may take several days for Redeam to complete and verify the mapping and configuration.

Partner API Implementation Tasks

The Partner API consists of the following endpoints:

• /availabilities
• /bookings
• /holds

The /bookings and /holds endpoints must be implemented by the supplier's ticketing or reservation system.

Product Availability Checks

The following endpoints must be implemented if any of the products or rates offered to resellers are of type RESERVED:

• /availability
• /availabilities

Redeam will poll the /availabilities endpoint and maintain a hosted cache for fast response times to resellers. Redeam will also proxy last-minute availability checks by resellers using the /availability endpoint.