Suppliers, Products & Rates
Redeam connects Resellers to Suppliers that have a commercial agreement by channel binding the Supplier and the Reseller, Channel binding is a process that makes the Supplier's products visible to the Reseller's API requests. If you do not see the Suppliers or the Products you are expecting please contact the Supplier or your Redeam Integration Manager for assistance.
In the Get Supplier call the Supplier is identified by a name
and id
. Only the id
field needs to be unique and is used to identify the Supplier, the name
does not need to be unique.
curl --request GET https://booking.sandbox.redeam.io/v1.2/suppliers \
--header "X-API-Key: ******" \
--header "X-API-Secret: ******" \
--header "X-Request-ID: 591115b0-4412-485a-8617-a0a805b5a5d0"
{
"meta": {
"reqId": "591115b0-4412-485a-8617-a0a805b5a5d0"
},
"suppliers": [
{
"businessType": [],
"code": "WWW",
"contacts": [],
"ext": {},
"id": "1ab0c295-1d16-4b5e-8719-9e7eeb13b3c6",
"mainLocation": {
"name": "Wisconsin",
"notes": "",
"website": ""
},
"name": "Wisconsin Widget World",
"version": 2
}
]
}
Any museum entry, river cruise, walking tour or show is a product offered by a Supplier that can have one or multiple rates for one or multiple traveller types. All this information is returned as part of the product.
curl --request GET https://booking.sandbox.redeam.io/v1.2/suppliers/1ab0c295-1d16-4b5e-8719-9e7eeb13b3c6/products \
--header "X-API-Key: ******" \
--header "X-API-Secret: ******" \
--header "X-Request-ID: d5a6a185-820a-45da-96dc-f341d540b730"
{ }
In addition to the name
and ID
fields, each product also contains the supplierId
Each rate has a name
and Id
field which are both assigned to the productId
. The rate object is larger than the product object and is defined by several more fields.
curl --request GET https://booking.sandbox.redeam.io/v1.2/suppliers/1ab0c295-1d16-4b5e-8719-9e7eeb13b3c6/products/f591d348-f702-453b-8a3f-5bdfe456fa90/rates \
--header "X-API-Key: ******" \
--header "X-API-Secret: ******" \
--header "X-Request-ID: 0390bcdb-90b1-4d87-84b1-a5c790eff1b5"
{ }
Rate Type
There are three different rate types: FreeSale, Pass and Reserved.
FreeSale tickets and entry passes are available during the opening hours of the attraction and there is no specific entry time. Pass rates are used for products where access is granted multiple times, whereas FreeSale and Reserved rates are normally single-use.
Reserved rates can be with or without capacity depending on the requirements and inventory defined by the Supplier and always require a hold to ensure that the availability for a certain date and time does not change between the availability check and the booking request. Bookings can however be rejected, if there is insufficient capacity at the requested date and time.
Pass rates represent a rate type that can be valid for more than one product. This type is not currently being used by any Supplier. If you receive a Rate Type = Pass or you believe you should be, please contact your Redeam Integration Manager for support.
Cancelable
Most products are cancelable which is indicated by a boolean cancelable
= true or cancelable
= false. Please note that this does not refer to a hold which can always be canceled.
Hours
The rate.hours
are used to define the available times for the product, the product operating hours the traveler is able to enter the attraction.
Rate.valid
is used to determine when the rate is available for purchase. Bookings can only occur within the defined valid from
and valid until
attributes. Some suppliers setup products ahead of their validity date for visibility and preparation. Please note and enforce the validity dates.
An example for this would be if a Supplier sets up 2 different rates: General Admission ticket for 2023 and 2024.
name: General Admission
code: GA2023
valid: 2023-01-01 to 2023-12-31
name: General Admission
code: GA2024
valid: 2024-01-01 to 2024-12-31
They are available to be booked the entire year, but there are specific days and times the product is available in that year.
rate.hours[0]
- Monday, Tuesday, Wednesday, Thursday
- 5:00pm to 7:00pm
- valid: 2023-01-01 to 2023-12-31
Please note that the value of the timezone
field is always communicated in UTC and should be used to convert to the local time of the product location.
Prices
Each Rate object has an array of prices for each travelerType
. These prices should not be used at this time. Prices provided for this product are found in Price Schedule. More pricing information is detailed in Pricing.
Please note that rates from Price Schedule rates ALWAYS supersede Rate prices.