Booking API Reference 1.2 Proprietary

Redeam Booking API.

Server

booking.redeam.io

Authentication

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.

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
suppliers	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.
contacts	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
ext	object	Extended data of the supplier
hours	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	Valid time range, if DaysOfWeek is specified
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.
mainLocation	object	Location of the supplier
address	object	Address of the location
countryCode	string	ISO 3366-1 alpha-3 format 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	Longitude and latitude of a location
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	Name of the supplier
otherLocations	array[object]	Other locations of the supplier
address	object	Address of the location
countryCode	string	ISO 3366-1 alpha-3 format 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	Longitude and latitude of a location
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.
travelerTypes	array[object]	Traveler types of the supplier
ageBand	string	Age band of the traveler type Enum: `ADULT`,`ANY`,`CHILD`,`INFANT`,`SENIOR`,`STUDENT`,`UNKNOWN`,`YOUTH`
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
version	int32	Version of this object. Increments every update.

401

Retrieve a list of suppliers

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": "string",   "contacts": [    {     "email": "alice.smith@test.com",     "name": "Alice Smith",     "phone": "+1 (212) 867-5309",     "primary": true,     "title": "Account manager"    }   ],   "ext": {    "string": "string"   },   "hours": [    {     "dates": [      "2018-10-19T17:37:31-06:00"     ],     "daysOfWeek": [      0     ],     "times": [      {       "close": "17:00",       "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": "string",     "postalCode": "94043",     "region": "string",     "streetAddress": "string"    },    "city": "DEPRECATED",    "country": "DEPRECATED",    "longLat": {     "latitude": 40.014984,     "longitude": -105.270546    },    "name": "string",    "notes": "string",    "state": "DEPRECATED",    "utcOffset": "DEPRECATED",    "website": "https://www.example.com"   },   "name": "string",   "otherLocations": [    {     "address": {      "countryCode": "USA",      "googlePlaceId": "ChIJrTLr-GyuEmsRBfy61i59si0",      "locality": "string",      "postalCode": "94043",      "region": "string",      "streetAddress": "string"     },     "city": "DEPRECATED",     "country": "DEPRECATED",     "longLat": {      "latitude": 40.014984,      "longitude": -105.270546     },     "name": "string",     "notes": "string",     "state": "DEPRECATED",     "utcOffset": "DEPRECATED",     "website": "https://www.example.com"    }   ],   "partnerId": "string",   "travelerTypes": [    {     "ageBand": "ADULT",     "maxAge": 99,     "minAge": 18,     "modifier": "EU_CITIZEN",     "name": "Adult"    }   ],   "version": 1  } ]}
Copy

Retrieve a single supplier

Returns a supplier.

Auth

Headers

X-Request-ID

string

Request ID for request tracking.

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
supplier	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.
contacts	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
ext	object	Extended data of the supplier
hours	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	Valid time range, if DaysOfWeek is specified
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.
mainLocation	object	Location of the supplier
address	object	Address of the location
countryCode	string	ISO 3366-1 alpha-3 format 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	Longitude and latitude of a location
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	Name of the supplier
otherLocations	array[object]	Other locations of the supplier
address	object	Address of the location
countryCode	string	ISO 3366-1 alpha-3 format 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	Longitude and latitude of a location
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.
travelerTypes	array[object]	Traveler types of the supplier
ageBand	string	Age band of the traveler type Enum: `ADULT`,`ANY`,`CHILD`,`INFANT`,`SENIOR`,`STUDENT`,`UNKNOWN`,`YOUTH`
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
version	int32	Version of this object. Increments every update.

401

Retrieve a single supplier

404

Retrieve a single supplier

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": "string",  "contacts": [   {    "email": "alice.smith@test.com",    "name": "Alice Smith",    "phone": "+1 (212) 867-5309",    "primary": true,    "title": "Account manager"   }  ],  "ext": {   "string": "string"  },  "hours": [   {    "dates": [     "2018-10-19T17:37:31-06:00"    ],    "daysOfWeek": [     0    ],    "times": [     {      "close": "17:00",      "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": "string",    "postalCode": "94043",    "region": "string",    "streetAddress": "string"   },   "city": "DEPRECATED",   "country": "DEPRECATED",   "longLat": {    "latitude": 40.014984,    "longitude": -105.270546   },   "name": "string",   "notes": "string",   "state": "DEPRECATED",   "utcOffset": "DEPRECATED",   "website": "https://www.example.com"  },  "name": "string",  "otherLocations": [   {    "address": {     "countryCode": "USA",     "googlePlaceId": "ChIJrTLr-GyuEmsRBfy61i59si0",     "locality": "string",     "postalCode": "94043",     "region": "string",     "streetAddress": "string"    },    "city": "DEPRECATED",    "country": "DEPRECATED",    "longLat": {     "latitude": 40.014984,     "longitude": -105.270546    },    "name": "string",    "notes": "string",    "state": "DEPRECATED",    "utcOffset": "DEPRECATED",    "website": "https://www.example.com"   }  ],  "partnerId": "string",  "travelerTypes": [   {    "ageBand": "ADULT",    "maxAge": 99,    "minAge": 18,    "modifier": "EU_CITIZEN",    "name": "Adult"   }  ],  "version": 1 }}
Copy