Reseller API Reference 1.2 Proprietary

⚠️ NOTE: While Reseller API v1.2 continues to work as expected, these docs will be removed in the near future as we shift focus to Reseller API v1.3, which adds expanded data structures and new capabilities like Content, Booking Questions, and Add-ons.

Check out our v1.3 docs and level up your integration to support even more partners and use cases.

Server

booking.redeam.io

Authentication

apiKey APIKeyHeader

Fields

Key	In
X-API-Key	Header

apiKey APISecretHeader

Fields

Key	In
X-API-Secret	Header

Suppliers

Endpoints

GET

/suppliers

GET

/suppliers/{supplier_id}

Retrieve a list of suppliers

Returns a list of suppliers.

Auth

Headers

X-Request-ID

string

Request ID for request tracking. An identifier unique to the request, which is passed from the reseller through Redeam to the operator. If the reseller does not provide a request ID, Redeam will generate an ID and return it to the reseller.

Query String

partner_id	string	Partner defined ID
code	string	Supplier code

GET /suppliers

 
curl --get \ --url 'https://booking.redeam.io/v1.2/suppliers' \ --header 'X-Request-ID: {X-Request-ID}' \ --header 'X-API-Key: {X-API-Key}' \ --header 'X-API-Secret: {X-API-Secret}' \ --data partner_id={partner_id} \ --data code={code}
Copy

Responses application/json

200

Retrieve a list of suppliers

object	object
meta	object	Request meta data
reqId	uuid	Request ID for request tracking. An identifier unique to the request, which is passed from the reseller through Redeam to the operator. If the reseller does not provide a request ID, Redeam will generate an ID and return it to the reseller.
suppliers14 fields	array[object]
businessType	array[string]	Key word or words that identify the type of business pattern: `^\w+$`
code	string	Code of the supplier. Every Supplier must have a unique Code.
contacts5 fields	array[object]	Supplier contact information.
email	string	Contact email address
name	string	Contact name
phone	string	Contact phone number pattern: `^\+\d[\d\s-]+$`
primary	boolean	Set to true, if this is the primary contact.
title	string	Contact title
description	string	A detailed overview of the supplier or operator, highlighting their offerings, background, and value proposition. This content is intended for display in full detail pages and should help users understand what makes the supplier unique.
ext	object	Extended data of the supplier
hours5 fields	array[object]	Hours of the supplier
dates	array[string]	Specific dates to which this rule applies
daysOfWeek	array[integer]	Applicable days of week. 0 is undefined, 1 is Monday, etc
times	array[object]	Open/Close times
close	string	Close time in UTC, 24-hour time, with 'HH:mm' format pattern: `^([01]?[0-9]\|2[0-3]):[0-5][0-9]$`
open	string	Open time in UTC, 24-hour time, with 'HH:mm' format pattern: `^([01]?[0-9]\|2[0-3]):[0-5][0-9]$`
timezone	string	IANA timezone string. If empty, then the open and close times are interpreted as UTC.
valid	object
from	date-time	Valid from time
until	date-time	Valid until time
id	uuid	ID of the supplier. This field can optionally be provided on create. If a valid UUID is provided on create, it will be saved as the object's ID. Otherwise, the object will receive a generated ID.
mainLocation9 fields	object
address6 fields	object
countryCode	string	ISO 3166-1 alpha-2 or alpha-3 country code. pattern: `^[A-Za-z]{3}$`
googlePlaceId	string	A Google Place ID.
locality	string	Locality is usually the address city
postalCode	string	PostalCode is the postal code, for example 94043
region	string	Region is usually a state/province
streetAddress	string	StreetAddress is a address line.
city	string	This field is DEPRECATED.
country	string	This field is DEPRECATED.
longLat	object
latitude	number	Latitude of the position
longitude	number	Longitude of the position
name	string	Name of the location
notes	string	Notes
state	string	This field is DEPRECATED.
utcOffset	string	This field is DEPRECATED.
website	string	Website
name	string	Common name for the supplier that may be displayed to the customer.
otherLocations9 fields	array[object]	Other locations of the supplier
address6 fields	object
countryCode	string	ISO 3166-1 alpha-2 or alpha-3 country code. pattern: `^[A-Za-z]{3}$`
googlePlaceId	string	A Google Place ID.
locality	string	Locality is usually the address city
postalCode	string	PostalCode is the postal code, for example 94043
region	string	Region is usually a state/province
streetAddress	string	StreetAddress is a address line.
city	string	This field is DEPRECATED.
country	string	This field is DEPRECATED.
longLat	object
latitude	number	Latitude of the position
longitude	number	Longitude of the position
name	string	Name of the location
notes	string	Notes
state	string	This field is DEPRECATED.
utcOffset	string	This field is DEPRECATED.
website	string	Website
partnerId	string	A Partner ID can be used to store a unique key in a partner's system.
title	string	Customer-facing name of the supplier, intended for display in UIs.
travelerTypes8 fields	array[object]	Traveler types of the supplier
ageBand	string	Age band of the traveler type Enum: `ADULT`,`ANY`,`CHILD`,`INFANT`,`SENIOR`,`STUDENT`,`UNKNOWN`,`YOUTH`
extensions	object	Extended data of the travelerType
maxAge	int32	Maximum age (inclusive) of the traveler type
minAge	int32	Minimum age (inclusive) of the traveler type
modifier	string	Optional traveler modifier. For most use cases, this can be omitted or set to 'NONE'. Enum: `EU_CITIZEN`,`GROUP`,`MILITARY`,`NONE`
name	string	Name of the traveler type, e.g. Diver, Observer, Adult, Military
title	string	Customer-facing title for specific unit/traveler.
description	string	Structured description of the age, membership or role of the traveler this price is intended for.
version	int32	Version of this object. Increments every update.

401

Unauthorized

503

The server is temporarily unavailable, either because the server is under maintenance, or overloaded (accepted too many requests in too short a time).

Response

 
{ "meta": {  "reqId": "5fd78809-4700-46d7-8386-3b8738117f4d" }, "suppliers": [  {   "businessType": [    "amusement_park"   ],   "code": "UQA_NYC",   "contacts": [    {     "email": "alice.smith@test.com",     "name": "Alice Smith",     "phone": "+1 (212) 867-5309",     "primary": true,     "title": "Account manager"    }   ],   "description": "Urban Quest Adventures turns city streets into interactive playgrounds. Our app-guided scavenger hunts and outdoor escape games combine local landmarks, puzzles, and storytelling to create unforgettable experiences in cities like New York, Chicago, and San Francisco.",   "ext": {    "marketRegions": "UK, Europe, US"   },   "hours": [    {     "dates": [      "2018-10-19T17:37:31-06:00"     ],     "daysOfWeek": [      1     ],     "times": [      {       "close": "10:20",       "open": "08:00"      }     ],     "timezone": "America/New_York",     "valid": {      "from": "2018-10-19T17:37:31-06:00",      "until": "2018-10-19T17:37:31-06:00"     }    }   ],   "id": "5fd78809-4700-46d7-8386-3b8738117f4d",   "mainLocation": {    "address": {     "countryCode": "USA",     "googlePlaceId": "ChIJrTLr-GyuEmsRBfy61i59si0",     "locality": "New York",     "postalCode": "10036",     "region": "NY",     "streetAddress": "123 Adventure Avenue"    },    "city": "DEPRECATED",    "country": "DEPRECATED",    "longLat": {     "latitude": 40.758,     "longitude": -73.9855    },    "name": "Urban Quest - NYC HQ",    "notes": "Main check-in point for all Manhattan quests.",    "state": "DEPRECATED",    "utcOffset": "DEPRECATED",    "website": "https://www.example.com"   },   "name": "Urban Quest Adventures Co.",   "otherLocations": [    {     "address": {      "countryCode": "USA",      "googlePlaceId": "ChIJT_-_gLGbwokR0r4e-8r-BgI",      "locality": "Brooklyn",      "postalCode": "11201",      "region": "NY",      "streetAddress": "789 Discovery Drive"     },     "city": "DEPRECATED",     "country": "DEPRECATED",     "longLat": {      "latitude": 40.6925,      "longitude": -73.9904     },     "name": "Brooklyn Quest Start Point",     "notes": "Meet by the large fountain.",     "state": "DEPRECATED",     "utcOffset": "DEPRECATED",     "website": "https://www.example.com"    }   ],   "partnerId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",   "title": "Urban Quest Adventures - Explore Cities Like Never Before",   "version": 1  } ]}
Copy

Retrieve a single supplier

Returns a supplier.

Auth

Headers

X-Request-ID

string

Path Params

supplier_id string

GET /suppliers/{supplier_id}

 
curl --get \ --url 'https://booking.redeam.io/v1.2/suppliers/{supplier_id}' \ --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

Retrieve a single supplier

object	object
meta	object	Request meta data
reqId	uuid	Request ID for request tracking. An identifier unique to the request, which is passed from the reseller through Redeam to the operator. If the reseller does not provide a request ID, Redeam will generate an ID and return it to the reseller.
supplier14 fields	object
businessType	array[string]	Key word or words that identify the type of business pattern: `^\w+$`
code	string	Code of the supplier. Every Supplier must have a unique Code.
contacts5 fields	array[object]	Supplier contact information.
email	string	Contact email address
name	string	Contact name
phone	string	Contact phone number pattern: `^\+\d[\d\s-]+$`
primary	boolean	Set to true, if this is the primary contact.
title	string	Contact title
description	string	A detailed overview of the supplier or operator, highlighting their offerings, background, and value proposition. This content is intended for display in full detail pages and should help users understand what makes the supplier unique.
ext	object	Extended data of the supplier
hours5 fields	array[object]	Hours of the supplier
dates	array[string]	Specific dates to which this rule applies
daysOfWeek	array[integer]	Applicable days of week. 0 is undefined, 1 is Monday, etc
times	array[object]	Open/Close times
close	string	Close time in UTC, 24-hour time, with 'HH:mm' format pattern: `^([01]?[0-9]\|2[0-3]):[0-5][0-9]$`
open	string	Open time in UTC, 24-hour time, with 'HH:mm' format pattern: `^([01]?[0-9]\|2[0-3]):[0-5][0-9]$`
timezone	string	IANA timezone string. If empty, then the open and close times are interpreted as UTC.
valid	object
from	date-time	Valid from time
until	date-time	Valid until time
id	uuid	ID of the supplier. This field can optionally be provided on create. If a valid UUID is provided on create, it will be saved as the object's ID. Otherwise, the object will receive a generated ID.
mainLocation9 fields	object
address6 fields	object
countryCode	string	ISO 3166-1 alpha-2 or alpha-3 country code. pattern: `^[A-Za-z]{3}$`
googlePlaceId	string	A Google Place ID.
locality	string	Locality is usually the address city
postalCode	string	PostalCode is the postal code, for example 94043
region	string	Region is usually a state/province
streetAddress	string	StreetAddress is a address line.
city	string	This field is DEPRECATED.
country	string	This field is DEPRECATED.
longLat	object
latitude	number	Latitude of the position
longitude	number	Longitude of the position
name	string	Name of the location
notes	string	Notes
state	string	This field is DEPRECATED.
utcOffset	string	This field is DEPRECATED.
website	string	Website
name	string	Common name for the supplier that may be displayed to the customer.
otherLocations9 fields	array[object]	Other locations of the supplier
address6 fields	object
countryCode	string	ISO 3166-1 alpha-2 or alpha-3 country code. pattern: `^[A-Za-z]{3}$`
googlePlaceId	string	A Google Place ID.
locality	string	Locality is usually the address city
postalCode	string	PostalCode is the postal code, for example 94043
region	string	Region is usually a state/province
streetAddress	string	StreetAddress is a address line.
city	string	This field is DEPRECATED.
country	string	This field is DEPRECATED.
longLat	object
latitude	number	Latitude of the position
longitude	number	Longitude of the position
name	string	Name of the location
notes	string	Notes
state	string	This field is DEPRECATED.
utcOffset	string	This field is DEPRECATED.
website	string	Website
partnerId	string	A Partner ID can be used to store a unique key in a partner's system.
title	string	Customer-facing name of the supplier, intended for display in UIs.
travelerTypes8 fields	array[object]	Traveler types of the supplier
ageBand	string	Age band of the traveler type Enum: `ADULT`,`ANY`,`CHILD`,`INFANT`,`SENIOR`,`STUDENT`,`UNKNOWN`,`YOUTH`
extensions	object	Extended data of the travelerType
maxAge	int32	Maximum age (inclusive) of the traveler type
minAge	int32	Minimum age (inclusive) of the traveler type
modifier	string	Optional traveler modifier. For most use cases, this can be omitted or set to 'NONE'. Enum: `EU_CITIZEN`,`GROUP`,`MILITARY`,`NONE`
name	string	Name of the traveler type, e.g. Diver, Observer, Adult, Military
title	string	Customer-facing title for specific unit/traveler.
description	string	Structured description of the age, membership or role of the traveler this price is intended for.
version	int32	Version of this object. Increments every update.

401

Unauthorized

404

Not Found

503

The server is temporarily unavailable, either because the server is under maintenance, or overloaded (accepted too many requests in too short a time).

Response

 
{ "meta": {  "reqId": "5fd78809-4700-46d7-8386-3b8738117f4d" }, "supplier": {  "businessType": [   "amusement_park"  ],  "code": "UQA_NYC",  "contacts": [   {    "email": "alice.smith@test.com",    "name": "Alice Smith",    "phone": "+1 (212) 867-5309",    "primary": true,    "title": "Account manager"   }  ],  "description": "Urban Quest Adventures turns city streets into interactive playgrounds. Our app-guided scavenger hunts and outdoor escape games combine local landmarks, puzzles, and storytelling to create unforgettable experiences in cities like New York, Chicago, and San Francisco.",  "ext": {   "marketRegions": "UK, Europe, US"  },  "hours": [   {    "dates": [     "2018-10-19T17:37:31-06:00"    ],    "daysOfWeek": [     1    ],    "times": [     {      "close": "10:20",      "open": "08:00"     }    ],    "timezone": "America/New_York",    "valid": {     "from": "2018-10-19T17:37:31-06:00",     "until": "2018-10-19T17:37:31-06:00"    }   }  ],  "id": "5fd78809-4700-46d7-8386-3b8738117f4d",  "mainLocation": {   "address": {    "countryCode": "USA",    "googlePlaceId": "ChIJrTLr-GyuEmsRBfy61i59si0",    "locality": "New York",    "postalCode": "10036",    "region": "NY",    "streetAddress": "123 Adventure Avenue"   },   "city": "DEPRECATED",   "country": "DEPRECATED",   "longLat": {    "latitude": 40.758,    "longitude": -73.9855   },   "name": "Urban Quest - NYC HQ",   "notes": "Main check-in point for all Manhattan quests.",   "state": "DEPRECATED",   "utcOffset": "DEPRECATED",   "website": "https://www.example.com"  },  "name": "Urban Quest Adventures Co.",  "otherLocations": [   {    "address": {     "countryCode": "USA",     "googlePlaceId": "ChIJT_-_gLGbwokR0r4e-8r-BgI",     "locality": "Brooklyn",     "postalCode": "11201",     "region": "NY",     "streetAddress": "789 Discovery Drive"    },    "city": "DEPRECATED",    "country": "DEPRECATED",    "longLat": {     "latitude": 40.6925,     "longitude": -73.9904    },    "name": "Brooklyn Quest Start Point",    "notes": "Meet by the large fountain.",    "state": "DEPRECATED",    "utcOffset": "DEPRECATED",    "website": "https://www.example.com"   }  ],  "partnerId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",  "title": "Urban Quest Adventures - Explore Cities Like Never Before",  "version": 1 }}
Copy