API

To use these functions, API access must be allowed in the menu SETTINGS >> ACCOUNT >> ACCOUNT ACCESS.

Usage

Please observe the following guidelines when using the API

Calls should be designed to send and recieve only the minimum required data.
Only one API call at a time is allowed, You must wait for the first call to complete before starting the next API call.
Multiple calls should be spaced with a few seconds delay between each call.
API calls should be used sparingly and kept to the minimum required for reasonable business usage.
Excessive usage within a 5 minute period will cause your account to be blocked without warning.
We reserve the right to disable any access we consider to be making excessive use of the API functions at our complete discretion and without warning.

CSV

Use these to download or upload data using a CSV file.

OTA

Build an interface to a booking page or PMS system

JSON_HotelAvail Get availability and price (JSON)

OTA_HotelAvail Get availability and price (XML)

OTA_HotelRes Save a booking (XML)

JSON

Functions based on JSON data format

getBookings - get bookings for a property

setBooking - add or modify bookings for a property

getAvailabilities - get a price and availability for a specific booking request

getDescriptions - get descriptive information suitable for constructing a booking page

createAccount - create a new sub account

getAccount - get information about an account

setAccount - modify an account

createProperties - create a new property in an account

getProperties - get a summary of properties in an account

getProperty - get detail of one property

setProperty - modify a property

getPropertyContent - get descriptive information about a property

setPropertyContent - modifiy descriptive information of a property

getRoomDates - get availability, restrictins and daily prices

setRoomDates - modify availability, restrictins and daily prices

getDailyPriceSetup - get daily price setuo information

setDailyPriceSetup - modify daily price setup information

getRates - get rates

setRate - modify a rate

setRates - modify a set of rates

getRateLinks - get the price linking information between rates

setRateLinks - modify the price linking between rates

getInvoicees - get invoicees for an account

setInvoicees - modify invoicees for an account

getInvoices - get invoices

getMessages - get OTA messages

setMessage - send an OTA message

createStripeSession - create a Stripe session to use in your own Stripe checkout session.

getV2RefreshToken - create an API V2 refresh token from API V1 credentials.

XML

Functions based on XML data format
Use the JSON functions for new designs. These XML functions are depreciated.

Common Error Codes

Error Code	Error Meaning
1009	Not allowed for this role
1010	No write access
1016	Usage limit exceeded in last 5 minutes
1020	Usage limit exceeded in last 5 minutes
1021	Account has no credit
1022	Not whitelisted