JSON API Instructions

Usage

Please observe the following rules

Authorization

API Key

Most JSON methods require an API key to access an account. The API code can be set at the menu SETTINGS >> ACCOUNT >> ACCOUNT ACCESS.

The API key should be between 16 and 64 characters long and kept secure. Anyone who has access to it can view or potentially make changes in the account.

Prop Key

Access to a property and it's rooms requires a PROP key. The PROP key can be set at menu SETTINGS >> PROPERTY >> LINK >> PROPKEY

The PROP key should be between 16 and 64 characters long and kept secure.

Room Id

Changes to room items require the room Id to be specified. The room Id is a system generated number unique to each room.

Posting Data

Data should be posted and will be returned in JSON format. Examples of the data format are given for each method.

Booking status values

Cancelled 0
Confirmed 1
New 2
Request 3
Black 4
Inquiry 5

Channel apisource values

Refer to API V2 apiSourceId for the most current values
Direct 0
Booking Page 1
Bookit 2
NZAA 3
Laterooms 8
Airbnb Ical 10
Flipkey 12
Guestlink 13
Expedia 14
Wimdu 15
iCal Export 16
Agoda 17
Travelocity 18
Booking.com 19
Tripadvisor 20
iCal import 1 21
Budgetplaces 22
Tablethotels 23
Hostelworld 24
Visitscotland 25
Holidaylettings 26
Bedandbreakfast EU 27
iCal import 2 28
iCal import 3 29
Homeaway XML 30
Bedandbreakfast NL 31
Atraveo 32
Feratel 33
Webrooms NZ 34
Lastminute 35
Hotelbeds 36
Housetrip 37
Nineflats 38
Homeaway iCal 40
OTA 42
Trivago 43
Hostellinginternational 44
Airbnb XML 46
Tomas 50
Ostrovok 51
Bookeasy AU 52
Ctrip 53
Asiatravel 54
Tripadvisor Rentals 55
Traveloka 56
HRS 57
Google 58
Despegar 59
Vacationstay 63
Hostelsclub 64
eDreams Odigeo 66
Rezintel 70
Jomres 72
Goibibo 73
Hometogo 78
Google Calendar 80
Traum 83
Tiket 86
Mariott 87

Property type values

Apartment 1
Barn 2
Boat 3
Building 4
Bungalow 5
Cabin 6
Castle 7
Chacara 8
Chalet 9
Chateau 10
Condo 11
Cottage 12
Estate 13
Farmhouse 14
Guesthouse 15
Hotel 16
House 17
House Boat 18
Lodge 19
Mas 20
Mill 21
Mobile Home 22
Recreational Vehicle 23
Riad 24
Studio 25
Tower 26
Townhome 27
Villa 28
Yacht 29
Bed and Breakfast 30
Camping 31
Hostel 32
Caravan 33
Tour 34
Aparthotel 35
Boutique Hotel 36
Tent 37
Casa Particular 38
Cycladic House 39
Heritage Hotel 40
Resort 41
Serviced Apartment 42
Loft 43
Tree House 44

Room type values

Single 1
Double 2
Triple 3
Quadruple 4
Suite 5
Apartment 6
Family 7
Twin 8
Twin/Double 9
Bed in Dormitory 10
Dormitory room 11
Studio 12
Bungalow 13
Chalet 14
Holiday home 15
Villa 16
Mobile home 17
Tent 18
Camp site 19
Activity 20
Tour 21
Car rental 22