Global

Type Definitions

GPSLocation

GPS Location Object

Properties:
Name Type Description
lat String

GPS latitude
lng String

GPS Longitude
Source:
Type:
  • Object

Address

Address Object

Properties:
Name Type Description
addressOne string

Street Address first line of text
addressTwo string

Street Address second line of text
city string

City
state string

State
zipCode string

Zip/Postal Code
loc GPSLocation

Location
Source:
Type:
  • Object

Profile

Profile Object

Properties:
Name Type Description
companyName string
address Address
Source:
Type:
  • Object

Location

Location Object

Properties:
Name Type Description
telephone string
address Address
Source:
Type:
  • Object

Media

Media Object

Properties:
Name Type Description
mediaType string

MimeType of media
url string

URL of media
Source:
Type:
  • Object

MediaCollection

Media Collection

Properties:
Name Type Description
image Array.Media
video Array.Media
Source:
Type:
  • Object

RoomInfo

Room Object

Properties:
Name Type Description
count number

Number of rooms
bedType string

Bedding type
other string

Exta Information
Source:
Type:
  • Object

ValueUnit

Value and UUnit spec

Properties:
Name Type Description
unit string

A unit specification
value number

The number of units
Source:
Type:
  • Object

ProductInfo

ProductInfo type

Properties:
Name Type Description
include string
exclude string
whatToBring string
Source:

BedsAndSofas

bedsAndSofas type

Properties:
Name Type Description
isApartment boolean
count numeric
other string
Source:

Product

Product Object

Properties:
Name Type Description
productId string

A unique identifier for a product
productName string
productType 'accommodation' | 'non-accommodation'
productCode string
description string
notes string
coverImageUrl string
interconnectingRooms boolean
amenities string
roomCountInfo ValueUnit
media MediaCollection
roomSizeInfo ValueUnit
tourDuration ValueUnit
totalMaxPassengers number
totalMinPassengers number
totalDuration ValueUnit
tourDurationDoesNotApply boolean
productInfo ProductInfo
bedsAndSofas BedsAndSofas
Source:
Type:
  • Object

Booking

Booking Object

Properties:
Name Type Description
id string

Booking unique identifier.
status Cancelled | Active | Pending

The currrent booking status.
holder Holder

Booking holder information.
telephone string

Contact telephone.
supplierBookingId string

Booking Id for the supplier booking system
hotelId string

A HotelId if the booking is for an accommodation.
hotelName string

A Hotel Name if the booking is for an accommodation.
rooms Array.<BookingRoom>

Booking Room details.
start string

CheckIn.
end string

CheckOut.
bookingDate string

Date when the booking was created.
price numeric

Total price for the booking.
cancelPolicy CancelPolicy

Cancellation policies for the booking.
Source:
Type:
  • Object

BookingRoom

Booking Room

Properties:
Name Type Description
roomId string
description string
price numeric
Source:
Type:
  • Object

CancelPolicy

Cancel Policy

Properties:
Name Type Description
refundable boolean
cancelPenalties string
Source:
Type:
  • Object

Occupancy

Occupancy Object

Properties:
Name Type Description
paxes Array.<Pax>
Source:
Type:
  • Object

Pax

A Pax item with an age spec.

Properties:
Name Type Description
age number

Age in years of the pax when the startDate starts on local timezone.
Source:
Type:
  • Object

Availability

An availability return spec.

Properties:
Name Type Description
id string

An identifier that can be used to retrieve a quote.
Source:
Type:
  • Object

Holder

A booking holder spec.

Properties:
Name Type Description
name string

The booking's holder first name (s).
surname string

Surname / Last Name(s) for the booking holder.
email string

The booking's holder email.
Source:
Type:
  • Object

Quote

A quote return spec

Properties:
Name Type Description
id string

An identifier that can be used to create a booking.
Source:
Type:
  • Object

Passenger

Properties:
Name Type Attributes Description
firstName string

Passenger first name
lastName string

Passenger last name
passengerType PassengerType

Passenger type
age number <optional>

Passenger age
dob string <optional>

Date of birth (YYYY-MM-DD)
personId string <optional>

Unique identifier for the passenger
Source:
Type:
  • Object

RoomType

Source:
Type:
  • 'Single' | 'Double' | 'Twin' | 'Triple' | 'Quad' | 'Other'

PassengerType

Source:
Type:
  • 'Adult' | 'Child' | 'Infant'

PaxConfig

At least one of adults, children or infants must be provided

Properties:
Name Type Attributes Description
roomType RoomType <optional>

Room type
adults number <optional>

Number of adults
children number <optional>

Number of children
infants number <optional>

Number of infants
passengers Array.<Passenger> <optional>

List of passengers for this pax config
Source:
Type:
  • Object

PUDOInfo

Properties:
Name Type Attributes Description
time string <optional>

Travel time
location string <optional>

Location details
flightDetails string <optional>

Flight information
Source:
Type:
  • Object

ItineraryProductUnit

Properties:
Name Type Description
unitId RoomType | PassengerType

Unit identifier for Accommodation products, allowed values: 'Single', 'Double', 'Twin', 'Triple', 'Quad'; for Activity products, allowed values: 'Adult', 'Child', 'Infant'
unitName string

Unit name, can be the same as unitId
restrictions ItineraryUnitRestriction

Unit restrictions
Source:
Type:
  • Object

ItineraryUnitRestriction

Properties:
Name Type Attributes Description
allowed boolean

Whether the unit is available
minAge number <optional>

Minimum age requirement
maxAge number <optional>

Maximum age requirement
Source:
Type:
  • Object

ItineraryProductOption

Properties:
Properties
Name Type Attributes Description
optionId string

Option identifier, this identifier should be unique in a sense that it should be able to represent the option and the product. For example, if in your system the option identifier are 1, 2, 3, say the productId is '123', the optionId you provided to us should be something like '123-1' or '123-2' etc.
optionName string

Option name
lastUpdateTimestamp number <optional>

Last update time
serviceType string

Type of service, one of 'Accommodation', 'Activity', 'Transfer'
extras Array.<Extra>

Extras allowed for this product option
units Array.<ItineraryProductUnit>

Available units
restrictions Object

Aggregated restrictions of each unit for this product option
Name Type Attributes Description
roomTypeRequired boolean <optional>

Whether room type is required, if it's required, our IA tool will check if the roomType in the paxConfigs matches the roomType allowed in the option
Adult ItineraryUnitRestriction <optional>

restrictions for adult
Child ItineraryUnitRestriction <optional>

restrictions for child
Infant ItineraryUnitRestriction <optional>

restrictions for infant
Single ItineraryUnitRestriction <optional>

restrictions for Single room type
Double ItineraryUnitRestriction <optional>

restrictions for Double room type
Twin ItineraryUnitRestriction <optional>

restrictions for Twin room type
Triple ItineraryUnitRestriction <optional>

restrictions for Triple room type
Quad ItineraryUnitRestriction <optional>

restrictions for Quad room type
Source:
Type:
  • Object

ItineraryProduct

An itinerary product contains two levels: product, option. For accommodation products, the product is the hotel, the option is the room name (Deluxe Room, Ocean View Room, etc). For activity products, the product is the Tour Company, the option is the activity type (e.g. Full Day, Half Day, etc). Specific data examples will be provided in the tutorial page.

Properties:
Name Type Attributes Description
productId string

ItineraryProduct identifier
productName string

ItineraryProduct name
serviceTypes Array.<string> <optional>

Types of services offered: ['Accommodation', 'Activity', 'Transfer']
options Array.<ItineraryProductOption>

Available options
Source:
Type:
  • Object

CustomFieldValue

Properties:
Name Type Description
id string

Custom Field identifier
value string

Field value
Source:
Type:
  • Object

Extra

Properties:
Name Type Description
id string

Extra identifier
name string

Extra name
Source:
Type:
  • Object

ItineraryServiceLine

Properties:
Name Type Attributes Description
serviceLineId string

Service line identifier
optionId string

Option identifier
optionName string

Option name
supplierName string <optional>

Supplier name
supplierId string <optional>

Supplier id
startDate string

Start date (YYYY-MM-DD)
paxConfigs Array.<PaxConfig>

List of pax configs for this service line
paxList Array.<Passenger>

List of passengers for this service line
Source:
Type:
  • Object

ItineraryBooking

Properties:
Name Type Description
bookingId string

Unique booking identifier
name string

Booking name
bookingStatus string

Booking status
ref string

Booking reference
agentRef string

external booking reference
totalPrice string

Total price of the booking
travelDate string

Start Date of travel (YYYY-MM-DD)
enteredDate string

Date of booking (YYYY-MM-DD)
serviceLines Array.<ItineraryServiceLine>

Booked service lines
Source:
Type:
  • Object

CreateItineraryCustomField

/**

Properties:
Properties
Name Type Attributes Description
id string

Custom Field identifier
label string

Custom Field label
type CustomFieldTypes

Custom Field type
isPerService boolean <optional>

Whether the custom field is per service, or per entire booking/quote
options Array.<Object> <optional>

Options if the type is extended-option
Name Type Description
value Object

Option value
label Object

Option label
Source:
Type:
  • 'yes-no' | 'short' | 'long' | 'count' | 'extended-option'

SearchAvailabilityForItineraryResponse

Properties:
Name Type Attributes Description
bookable boolean

Whether the product is bookable
rates Array <optional>

If there are multiple rates, they will be returned in this array
rates[].rateId string

It's ok if you don't use such a thing as rateId in your internal system, but you can use it to package important information so we can make a booking. For example, you can do jwt.encode({ foo: 'bar' }, secret) and send it to us here, and later when we make a booking, we send the rateId to you so you can decode it and get the foo: 'bar' information.
rates[].externalRateText string <optional>

Combined rate description
Source:
Type:
  • Object

AddServiceToItineraryResponse

Properties:
Properties
Name Type Description
message string

Error message
booking object

Booking object
Name Type Description
id string

Booking identifier from your system
reference string

Reference number from your system
linePrice string

Price of the booking line
lineId string

Line identifier from your system
Source:
Type:
  • Object

Allotment

Allotment Object /**

Properties:
Name Type Description
name string

The name of the allotment.
description string

A description of the allotment.
appliesTo string

Specifies what the allotment applies to.
splitCode string

The code used to split the allotment.
unitType string

The type of unit used for the allotment.
date Date

The date associated with the allotment using the input format.
release string

The release period of the allotment as specified in the day inventory.
max number

The maximum quantity allowed for the allotment as specified in the day inventory.
booked number

The booked quantity of the allotment as specified in the day inventory.
request boolean

Indicates whether requests are allowed for the allotment, based on the day inventory.
keyPaths Array.<string>

An array of key paths generated by combining supplier code and product codes.
Source:
Type:
  • Object