Stayntouch Connect API documentation version 2.0

https://api.stayntouch.com/connect

Overview

Welcome to the Stayntouch Connect API documentation. Stayntouch Connect provides 3rd party applications read & write access to hotel data within the Stayntouch PMS. All 3rd party vendors need to sign NDA with Stayntouch before getting access to sandbox environment. The OAuth 2.0 standard is used by Stayntouch Connect. Hotels must grant 3rd party applications access to their data.

Here you can find the latest changes and additions for the API’s and Webhooks.

/accounts

/accounts get post

get

Returns a paginated list of accounts filtered by the input parameters. Accounts for requested hotel is returned.

post

Create a new Company/Travel Agent Account for the provided Hotel

Returns a paginated list of accounts filtered by the input parameters. Accounts for requested hotel is returned.

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier
type: (string)
Possible values are COMPANY, TRAVELAGENT
page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: Account
- id: required(integer)
  Identifier
- account_number: (string)
  Unique number for Company/Travel agent
- type: required(one of COMPANY, TRAVELAGENT)
  A type of the account
- name: required(string)
  A name of Company/Travel agent
- address: (object)
  Account address
  - id: required(integer)
    Identifier
  - address_line1: (string)
    Address 1
  - address_line2: (string)
    Address 2
  - address_line3: (string)
    Address 3
  - city: (string)
    City Name
  - state: (string)
    State Name
  - postal_code: (string)
    Postal Code
  - country_code: (string)
    Country Code (ISO 3166-1 alpha-2)
- ar_number: (string)
  Account receivable number
- hotel_id: required(integer)
  Hotel identifier
- is_global: required(boolean)
  A flag indicating if the Account is global or not
- tax_number: (string)
  A tax id number
- phone: (string)
  The Phone number.
- fax: (string)
  The Fax number.
- email: (string)
  The Email address.
- web_page: (string)
  The web_page link.
- commision: (object)
  For travel agents if the system needs to calculate a commission on items to be paid to the agency. Can be a % of the transaction or a fixed amount.
  - on: (boolean)
    A flag indicating if the commission is enabled or not.
  - type: (string)
    The commision type can be "percent" or "amount".
  - value: (string)
    The amount value or percent value based on the type selected.
- primary_contact: (object)
  The main contact person for the agency or company.
  - first_name: (string)
    The first name of main contact person.
  - last_name: (string)
    The last name of main contact person.
  - job_title: (string)
    The job title of main contact person.
  - phone: (string)
    The phone number of main contact person.
  - email: (string)
    The email address of main contact person.
total_count: (integer)

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Create a new Company/Travel Agent Account for the provided Hotel

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(integer)
Hotel Identifier
account_number: (string)
Unique number for Company/Travel agent
type: required(one of COMPANY, TRAVELAGENT)
A type of the account
name: required(string)
A name of Company/Travel agent
address: (object)
Account address
- id: required(integer)
  Identifier
- address_line1: (string)
  Address 1
- address_line2: (string)
  Address 2
- address_line3: (string)
  Address 3
- city: (string)
  City Name
- state: (string)
  State Name
- postal_code: (string)
  Postal Code
- country_code: (string)
  Country Code (ISO 3166-1 alpha-2)
ar_number: (string)
Account receivable number
is_global: (boolean)
A flag indicating if the Account is global or not
tax_number: (string)
The company’s tax ID or VAT number or similar
phone: (string)
The Phone number.
fax: (string)
The Fax number.
email: (string)
The Email address.
web_page: (string)
The web_page link.
commission: (object)
For travel agents if the system needs to calculate a commission on items to be paid to the agency. Can be a % of the transaction or a fixed amount.
- on: (boolean)
  A flag indicating if the commission is enabled or not.
- type: (string)
  The commision type can be "percent" or "amount".
- value: (string)
  The amount value or percent value based on the type selected.
primary_contact: (object)
The main contact person for the agency or company.
- first_name: (string)
  The first name of main contact person.
- last_name: (string)
  The last name of main contact person.
- job_title: (string)
  The job title of main contact person.
- phone: (string)
  The phone number of main contact person.
- email: (string)
  The email address of main contact person.

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (Integer)
Identifier of the created Account

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/accounts/{id} get

get

Show Account by its identifier.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Account Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer)
Identifier
account_number: (string)
Unique number for Company/Travel agent
type: required(one of COMPANY, TRAVELAGENT)
A type of the account
name: required(string)
A name of Company/Travel agent
address: (object)
Account address
- id: required(integer)
  Identifier
- address_line1: (string)
  Address 1
- address_line2: (string)
  Address 2
- address_line3: (string)
  Address 3
- city: (string)
  City Name
- state: (string)
  State Name
- postal_code: (string)
  Postal Code
- country_code: (string)
  Country Code (ISO 3166-1 alpha-2)
ar_number: (string)
Account receivable number
hotel_id: required(integer)
Hotel identifier
is_global: required(boolean)
A flag indicating if the Account is global or not
tax_number: (string)
A tax id number
phone: (string)
The Phone number.
fax: (string)
The Fax number.
email: (string)
The Email address.
web_page: (string)
The web_page link.
commision: (object)
For travel agents if the system needs to calculate a commission on items to be paid to the agency. Can be a % of the transaction or a fixed amount.
- on: (boolean)
  A flag indicating if the commission is enabled or not.
- type: (string)
  The commision type can be "percent" or "amount".
- value: (string)
  The amount value or percent value based on the type selected.
primary_contact: (object)
The main contact person for the agency or company.
- first_name: (string)
  The first name of main contact person.
- last_name: (string)
  The last name of main contact person.
- job_title: (string)
  The job title of main contact person.
- phone: (string)
  The phone number of main contact person.
- email: (string)
  The email address of main contact person.

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/accounts/{id} put

put

Update the Account by its identifier

Secured by oauth_2_0

URI Parameters

id: required(integer)
Account Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(integer)
Hotel Identifier
account_number: (string)
Unique number for Company/Travel agent
name: required(string)
A name of Company/Travel agent
address: (object)
Account address
- id: required(integer)
  Identifier
- address_line1: (string)
  Address 1
- address_line2: (string)
  Address 2
- address_line3: (string)
  Address 3
- city: (string)
  City Name
- state: (string)
  State Name
- postal_code: (string)
  Postal Code
- country_code: (string)
  Country Code (ISO 3166-1 alpha-2)
ar_number: (string)
Account receivable number
is_global: (boolean)
A flag indicating if the Account is global or not
tax_number: (string)
A tax id number
phone: (string)
The Phone number.
fax: (string)
The Fax number.
email: (string)
The Email address.
web_page: (string)
The web_page link.
commission: (object)
For travel agents if the system needs to calculate a commission on items to be paid to the agency. Can be a % of the transaction or a fixed amount.
- on: (boolean)
  A flag indicating if the commission is enabled or not.
- type: (string)
  The commision type can be "percent" or "amount".
- value: (string)
  The amount value or percent value based on the type selected.
primary_contact: (object)
The main contact person for the agency or company.
- first_name: (string)
  The first name of main contact person.
- last_name: (string)
  The last name of main contact person.
- job_title: (string)
  The job title of main contact person.
- phone: (string)
  The phone number of main contact person.
- email: (string)
  The email address of main contact person.

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (Integer)
Identifier of the created Account

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/accounts/{id}/accounts_receivable post get

post

Create AR Detail for provided Hotel and Account

get

Show AR details of the provided account identifier

Create AR Detail for provided Hotel and Account

Secured by oauth_2_0

URI Parameters

id: required(integer)
Account Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(integer)
Hotel Identifier
number: required(integer)
A number or other data used to identify the account.
allow_direct_debit: required(boolean)
Value of true allows the front desk to check bills out to this account.
payment_due_days: (integer)
How many days after billing are bills due to be paid.
notes: (array)
Any notes needed to be added about the AR account.
billing: (object)
BillingAddress
- is_primary: required(boolean)
  If true use the data entered here for the billing address. If false use account's main address.
- address_line1: (string)
  Address 1
- address_line2: (string)
  Address 2
- address_line3: (string)
  Address 3
- city: (string)
  City Name
- state: (string)
  State Name
- postal_code: (string)
  Postal Code
- country: (string)
  Country Code (ISO 3166-1 alpha-2)
billing_contact: (object)
BillingContact
- is_primary: required(boolean)
  If true use the data entered here for contact. If false use accounts main contact data.
- first_name: (string)
  First name of billing contact.
- last_name: (string)
  Last or family name of billing contact.
- email: (string)
  Email for billing contact.
- phone: (Integer)
  Phone number for billing contact.
- job_title: (string)
  Job title for billing contact.

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

number: required(integer)
A number or other data used to identify the account.
allow_direct_debit: required(boolean)
Value of true allows the front desk to check bills out to this account.
payment_due_days: (integer)
How many days after billing are bills due to be paid.
notes: (array)
Any notes needed to be added about the AR account.
billing: (object)
BillingAddress
- is_primary: required(boolean)
  If true use the data entered here for the billing address. If false use account's main address.
- address_line1: (string)
  Address 1
- address_line2: (string)
  Address 2
- address_line3: (string)
  Address 3
- city: (string)
  City Name
- state: (string)
  State Name
- postal_code: (string)
  Postal Code
- country: (string)
  Country Code (ISO 3166-1 alpha-2)
billing_contact: (object)
BillingContact
- is_primary: required(boolean)
  If true use the data entered here for contact. If false use accounts main contact data.
- first_name: (string)
  First name of billing contact.
- last_name: (string)
  Last or family name of billing contact.
- email: (string)
  Email for billing contact.
- phone: (Integer)
  Phone number for billing contact.
- job_title: (string)
  Job title for billing contact.

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Show AR details of the provided account identifier

Secured by oauth_2_0

URI Parameters

id: required(integer)
Account Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

number: required(integer)
A number or other data used to identify the account.
allow_direct_debit: required(boolean)
Value of true allows the front desk to check bills out to this account.
payment_due_days: (integer)
How many days after billing are bills due to be paid.
notes: (array)
Any notes needed to be added about the AR account.
billing_address: (object)
BillingAddress
- is_primary: required(boolean)
  If true use the data entered here for the billing address. If false use account's main address.
- address_line1: (string)
  Address 1
- address_line2: (string)
  Address 2
- address_line3: (string)
  Address 3
- city: (string)
  City Name
- state: (string)
  State Name
- postal_code: (string)
  Postal Code
- country: (string)
  Country Code (ISO 3166-1 alpha-2)
billing_contact: (object)
BillingContact
- is_primary: required(boolean)
  If true use the data entered here for contact. If false use accounts main contact data.
- first_name: (string)
  First name of billing contact.
- last_name: (string)
  Last or family name of billing contact.
- email: (string)
  Email for billing contact.
- phone: (Integer)
  Phone number for billing contact.
- job_title: (string)
  Job title for billing contact.

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/addons

/addons get post

get

Returns a paginated list of addons filtered by the input parameters. Addons for requested hotel is returned.

post

Create Addon for the provided hotel

Returns a paginated list of addons filtered by the input parameters. Addons for requested hotel is returned.

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier
page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: Addon
- id: required(integer)
  Identifier
- name: required(string)
  Addon Name
- description: required(string)
  Description of Addon
- amount: required(float)
  Addon price
- amount_type: required(one of ADULT, CHILD, FLAT, PERSON, ROOM)
  Addon price Type
- post_type: required(one of STAY, WEEKLY, NIGHT, LAST_NIGHT)
  Post Type
- post_type_description: required(one of Nightly, Every Week, First Night, Post on Last Night)
  Post Type Description
- post_days: required(array)
  List of weekdays (order according to ISO-8601 standard). Only returned when Post Type is STAY.
- charge_code_id: required(integer)
  Associated Charge Code
- charge_group_id: required(integer)
  Associated Charge Group
- currency_code: required(string)
  Associated Currency Code (ISO 4217 Format)
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Create Addon for the provided hotel

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(integer)
Hotel Identifier
name: required(string)
Name
description: required(string)
Description
amount: required(float)
Amount
amount_type: required(one of ADULT, CHILD, FLAT, PERSON, ROOM)
Amount Type
post_type: required(one of STAY, WEEKLY, NIGHT)
Post Type
charge_code_id: required(integer)
Associated Charge Code
charge_group_id: required(integer)
Associated Charge Group
currency_code: required(string)
Associated Currency Code (ISO 4217 Format)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (Integer)
Identifier of the created Addon

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/addons/{id} get

get

Show the details of a addon by its identifier.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Addon Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer)
Identifier
name: required(string)
Addon Name
description: required(string)
Description of Addon
from_date: required(date)
This is the starting date that an addon is available for, this may be a null value in that there is no starting date; it is available as there is no set starting date
to_date: required(date)
This is the last date that an addon can be used, this may be a null value in that there is not an end date currently set.
amount: required(float)
Addon price on current business date
date_ranges: required(array of object)
Addon date ranges
Items: items
- from_date: required(date)
  Start date from which the addon amount applies, only dates that include current business date or future dates will display
- to_date: required(date)
  End date from which the addon amount applies, only dates that include current business date or future dates will display
- sets: required(array of object)
  Date range sets
  Items: items
  - amount: required(float)
    Addon price during the displayed date range and days of the week
  - post_days: required(array)
    Days of the week that the addon amount applies to.
allowance: required(boolean)
Indicator if this is an allowance posting
value: required(float)
The value of the addon if it is an allowance, this will be null if the allowance item is false
allowed_for_consumption: required(integer)
The IDs for the charge codes that are allowed for consumption if the item is an allowance
amount_type: required(one of ADULT, CHILD, FLAT, PERSON, ROOM)
Addon price Type
post_type: required(one of STAY, WEEKLY, NIGHT, LAST_NIGHT)
Post Type
post_type_description: required(one of Nightly, Every Week, First Night, Post on Last Night)
Post Type Description
post_days: required(array)
List of weekdays (order according to ISO-8601 standard). Only returned when Post Type is STAY.
charge_code_id: required(integer)
Associated Charge Code
charge_group_id: required(integer)
Associated Charge Group
currency_code: required(string)
Associated Currency Code (ISO 4217 Format)
consume_next_day: required(boolean)
Indicator if this is to be consumed the next day (an example is a nightly breakfast )
parking_addon: required(boolean)
Indicator if used for parking (may have other functionality)
rate_only: required(boolean)
Indicates if true that this may only be added to rates and not directly to a reservation
reservation_only: required(boolean)
Indicates that this may only be attached to a reservation. It cannot be included in a rate
exclude_from_rate: required(boolean)
Indicates that this addon may not be used for reservations if certain rates are selected.
rates_excluded: required(array of )
list of rates excluded
inventory: required(integer)
If there are a set number of addons that can be sold, the number allowed

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/addons/{id} put

put

Update addon by its identifier.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Addon Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(integer)
Hotel Identifier
name: (string)
Name
description: (string)
Description
amount: (float)
Amount
amount_type: (one of ADULT, CHILD, FLAT, PERSON, ROOM)
Amount Type
post_type: (one of STAY, WEEKLY, NIGHT)
Post Type
charge_code_id: (integer)
Associated Charge Code
charge_group_id: (integer)
Associated Charge Group
currency_code: required(string)
Associated Currency Code (ISO 4217 Format)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (Integer)
Identifier of the updated Addon

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/bills

/bills/{id}/invoice get

get

Show Invoice of the provided bill.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Bill Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

number: required(string)
Invoice number
folio_number: (string)
Invoice folio number
ar_invoice_number: (string)
Accounts Receivable number
mod_invoice_number: (string)
OCR/KID Number
currency_code: required(string)
Hotel's Currency Code
issue_date: (date)
Invoice issue date
payment_due_date: (date)
The date on which a payment or invoice is scheduled to be received by the nominee
hotel: required(object)
Hotel details
- id: required(integer)
  Hotel identifier
- code: required(string)
  Hotel code
- name: required(string)
  Name of the hotel
reservation: (object)
Reservation associated with the bill
- id: (integer)
  Reservation identifier
- primary_guest_name: (string)
  Primary guest's full name
- room_number: (string)
  Room number
- confirmation_number: (string)
  Reservation confirmation number
posting_account: (object)
Posting Account associated with the bill
- id: (integer)
  Posting Account identifier
- name: (string)
  Name of the Posting Account
- number: (string)
  Posting Account Number
account: (object)
Account associated with the bill
- name: (string)
  Company/Travel Agent name
- ar_number: (string)
  Account Receivable number
- organization_identifier: (string)
  Organization Identifier
- corporate_id: (string)
  Corporate Identifier
- tax_id: (string)
  Tax Identifier
- e_invoice_address: (string)
  Electronic Invoice Address
- address: (object)
  Address associated with the account
  - line1: (string)
    Address First Line
  - line2: (string)
    Address Second Line
  - line3: (string)
    Address Third Line
  - city: (string)
    City name
  - state: (string)
    State name
  - country: (string)
    Country name
  - postal_code: (string)
    Postal code number
transactions: (array of object)
Financial Transactions associated with the bill
Items: items
- items: (array of object)
  Transaction line items
  Items: items
  - description: (string)
    Description of the charge code associated with the transaction
  - code: (string)
    Charge Code associated with the transaction
  - reference_text: (string)
    Reference text
  - reference_number: (string)
    Reference number
  - amount: (number)
    Transaction amount
  - is_inclusive: (boolean)
    Whether the transaction is inclusive or not
  - date: (date)
    Transaction date
  - taxes: (array of object)
    Taxes associated with the transaction
    Items: items
    description: (string)
    Description of the charge code associated with the tax transaction
    code: (string)
    Charge Code associated with the tax transaction
    reference_text: (string)
    Reference text
    reference_number: (string)
    Reference number
    amount: (number)
    Transaction amount
    date: (date)
    Transaction date
    is_inclusive: (boolean)
    Whether the tax is inclusive or not
    percent: (number)
    VAT percentage
    flat_amount: (number)
    Flat amount
    type: (one of ADULT, CHILD, FLAT, PERSON, ROOM)
    Amount type
- code: (string)
  Charge Code associated with the transaction
- description: (string)
  Description of the charge code associated with the transaction
- total_amount: (number)
  Total revenue amount for this posting with included taxes. Excluded taxes need to be picked up from “taxes”
payable_amount: (number)
Summary of line items and taxes

Example:

{
  "number": "326977",
  "folio_number": null,
  "ar_invoice_number": null,
  "mod_invoice_number": "3269776",
  "currency_code": "AUD",
  "issue_date": "2022-08-09",
  "payment_due_date": "2022-08-09",
  "hotel": {
    "id": 317,
    "code": "SNTRC",
    "name": "Rover Connect Test Hotel - CHAMS"
  },
  "reservation": {
    "id": 2937646,
    "primary_guest_name": "gee addon",
    "room_number": "305",
    "confirmation_number": "818853"
  },
  "transactions": [
    {
      "items": [
        {
          "description": "Room Charge",
          "code": "1000",
          "reference_text": null,
          "reference_number": null,
          "amount": "11.00",
          "is_inclusive": false,
          "date": "2022-08-09",
          "taxes": [
            {
              "description": "Sales tax",
              "code": "7002",
              "reference_text": null,
              "reference_number": null,
              "amount": "20.00",
              "date": "2022-08-09",
              "is_inclusive": false,
              "percent": null,
              "flat_amount": "20.00",
              "type": "ROOM"
            }
          ]
        },
        {
          "description": "Valet Parking",
          "code": "5500",
          "reference_text": null,
          "reference_number": null,
          "amount": "160.00",
          "is_inclusive": true,
          "date": "2022-08-09",
          "taxes": [
            {
              "description": "20% VAT",
              "code": "7001",
              "reference_text": null,
              "reference_number": null,
              "amount": "40.00",
              "date": "2022-08-09",
              "is_inclusive": true,
              "percent": "20.00",
              "flat_amount": null,
              "type": "FLAT"
            }
          ]
        }
      ],
      "code": "1000",
      "description": "Room Charge",
      "total_amount": "211.00"
    },
    {
      "items": [
        {
          "description": "NEW Charge Code",
          "code": "1111",
          "reference_text": "",
          "reference_number": null,
          "amount": "23.18",
          "is_inclusive": false,
          "date": "2022-08-09",
          "taxes": [
            {
              "description": "10% VAT",
              "code": "7010",
              "reference_text": "",
              "reference_number": null,
              "amount": "2.32",
              "date": "2022-08-09",
              "is_inclusive": true,
              "percent": "10.00",
              "flat_amount": null,
              "type": "FLAT"
            }
          ]
        }
      ],
      "code": "1111",
      "description": "NEW Charge Code",
      "total_amount": "25.50"
    },
    {
      "items": [
        {
          "description": "City Tax  7% tourist Tax",
          "code": "950",
          "reference_text": "",
          "reference_number": null,
          "amount": "1.62",
          "is_inclusive": false,
          "date": "2022-08-09",
          "taxes": []
        }
      ],
      "code": "950",
      "description": "City Tax  7% tourist Tax",
      "total_amount": "1.62"
    }
  ],
  "payable_amount": "258.12"
}

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/cancellation_policies

/charge_codes

/charge_codes/{id}/basic_taxes get

get

Returns the charge code information and its basic taxes. For tax charge code, it will return its tax specific information

Secured by oauth_2_0

URI Parameters

id: required(string)

Query Parameters

id: required(integer)
Charge Code Identifier
hotel_id: required(integer)
Hotel Identifier

HTTP status code 200

Body

Media type: application/json - Charge Code with basic taxes information

Type: object

Properties

id: required(integer)
Charge Code Identifier
charge_code: required(string)
Code of Charge Code
description: required(string)
Description of charge code
taxes: required(array of object)
Taxes linked to the charge code (Can be up to 6 at the moment). If none are linked then no data is returned in this section
Items: items
- is_inclusive: required(boolean)
  Indicates if the tax present is included or excluded in the charge_code
- charge_code_id: required(string)
  Charge code identifier for the associated tax
- charge_code: required(string)
  Description of the tax charge code
- percentage: (string)
  Tax percentage. Only one of percentage or flat_amount will be available in a charge code, we will return only one of these fields based on the setup in the PMS
- flat_amount: (string)
  Flat tax amount. Only one of percentage or flat_amount will be available in a charge code, we will return only one of these fields based on the setup in the PMS
- tax_calculation_rule: (string)
  Tax calculation rule associated with the charge code. ChargeCodeBaseAmount calculates taxes based on the charge code value only, it is not a tax on tax. ChargeCodePlusTax calculates this tax based on the charge code value and also on top of the previously listed taxes. Expected values - 'ChargeCodeBaseAmount' or 'ChargeCodeplusTax 1 & 2 & 3 & 4 & 5 &.....N' where N is the total number of charge codes that should be added on top of base charge code amount
- amount_type: required(one of ADULT, CHILD, PERSON, FLAT, ROOM)
  Amount type value
- post_type: required(one of STAY, NIGHT)
  Posting rhythm
- charge_code_type: required(one of TAX, TOURIST_TAX)
  Charge code type

Example:

{
  "id": 12345,
  "charge_code": "1000",
  "description": "Accommodation",
  "taxes": [
    {
      "is_inclusive": false,
      "charge_code_id": 12346,
      "charge_code": "9000",
      "charge_code_description": "2%-Tax",
      "percentage": "2.0",
      "tax_calculation_rule": "ChargeCodeBaseAmount",
      "amount_type": "FLAT",
      "post_type": "NIGHT",
      "charge_code_type": "TAX"
    },
    {
       "is_inclusive": false,
       "charge_code_id": 12347,
       "charge_code": "9001",
       "charge_code_description": "3%-Tax",
       "flat_amount": "20.0",
       "tax_calculation_rule": "ChargeCodeplusTax 1",
       "amount_type": "FLAT",
       "post_type": "NIGHT",
       "charge_code_type": "TOURIST_TAX"
    }
  ]
}

Media type: application/json - Tax/Tourist Tax Charge Code with tax related information

Type: object

Properties

id: required(integer)
Charge Code Identifier
charge_code: required(string)
Code of Charge Code
charge_code_type: required(one of TAX, TOURIST_TAX)
Type of Charge Code
description: required(string)
Description of charge code
tax_percentage: (string)
Tax percentage. Only one of percentage or flat_amount will be available in a charge code, we will return only one of these fields based on the setup in the PMS
tax_flat_amount: (string)
Tax flat amount. Only one of percentage or flat_amount will be available in a charge code, we will return only one of these fields based on the setup in the PMS
amount_type: required(one of ADULT, CHILD, PERSON, FLAT, ROOM)
Amount Type value
post_type: required(one of STAY, NIGHT)
Posting rhythm

Example:

{
  "id": 112233,
  "charge_code": "5000",
  "description": "Per Person Tax",
  "tax_flat_amount": "2.0",
  "amount_type": "FLAT",
  "post_type": "NIGHT",
  "charge_code_type": "TAX"
}

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/deposit_policies

/groups

/groups get post

get

Returns a paginated list of groups filtered by the input parameters. Groups for requested hotel is returned.

post

Create a new Group for the provided Hotel

Returns a paginated list of groups filtered by the input parameters. Groups for requested hotel is returned.

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier
code: (string)
Group Code
name: (string)
Group Name. This should search for names that contain this should not be an exact match of the name
date: (date)
Could be any date between the start and end date of the group
page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: Group
- id: required(integer)
  Group Identifier
- hotel_id: required(integer)
  Identifier of the Hotel Object
- code: (string)
  The code for the newly created Group
- name: required(string)
  Group name
- from_date: required(date-only)
  The starting date of the Group
- to_date: required(date-only)
  The end date of the Group
- shoulder_days_beginning: required(integer)
  The number of days prior to start date that group can book
- shoulder_days_end: required(integer)
  The number of days after to the end date that group can book
- rate_id: (integer)
  The Group rate to be attached to the Group. Can be nil if Group with custom rate.
- release_date: (date-only)
  The release date of the Group Block
- first_name: (string)
  The first name of the contact person
- last_name: (string)
  The last name of the contact person
- email: (string)
  Email of the contact person.
- phone: (string)
  The Phone number of the contact person.
- country: (string)
  Country Code of the Group
- nationality: (string)
  Country Code of nationality of the Group
- created_date: (date-only)
  Date when the Group is created
- updated_date: (date-only)
  Date when the Group is updated
- hold_status: required(string)
  The Group Hold Status.
- market_segment_code: (string)
  The market segment code to be attached to the Group.
- segment_code: (string)
  The segment code to be attached to the Group.
- source_code: (string)
  The source code to be attached to the Group.
- booking_origin_code: (string)
  The booking origin code to be attached to the Group.
- reservation_type_code: (string)
  The reservation type code to be attached to the Group.
- company: (object)
  The company object which needs to be attached to the Group.
  - id: required(integer)
    Identifier
  - account_number: (string)
    Unique number for Company/Travel agent
  - type: required(one of COMPANY, TRAVELAGENT)
    A type of the account
  - name: required(string)
    A name of Company/Travel agent
  - address: (object)
    Account address
    - id: required(integer)
      Identifier
    - address_line1: (string)
      Address 1
    - address_line2: (string)
      Address 2
    - address_line3: (string)
      Address 3
    - city: (string)
      City Name
    - state: (string)
      State Name
    - postal_code: (string)
      Postal Code
    - country_code: (string)
      Country Code (ISO 3166-1 alpha-2)
  - ar_number: (string)
    Account receivable number
  - hotel_id: required(integer)
    Hotel identifier
  - is_global: required(boolean)
    A flag indicating if the Account is global or not
  - tax_number: (string)
    A tax id number
  - phone: (string)
    The Phone number.
  - fax: (string)
    The Fax number.
  - email: (string)
    The Email address.
  - web_page: (string)
    The web_page link.
  - commision: (object)
    For travel agents if the system needs to calculate a commission on items to be paid to the agency. Can be a % of the transaction or a fixed amount.
    - on: (boolean)
      A flag indicating if the commission is enabled or not.
    - type: (string)
      The commision type can be "percent" or "amount".
    - value: (string)
      The amount value or percent value based on the type selected.
  - primary_contact: (object)
    The main contact person for the agency or company.
    - first_name: (string)
      The first name of main contact person.
    - last_name: (string)
      The last name of main contact person.
    - job_title: (string)
      The job title of main contact person.
    - phone: (string)
      The phone number of main contact person.
    - email: (string)
      The email address of main contact person.
- travel_agent: (object)
  The travel agent object which needs to be attached to the Group.
  - id: required(integer)
    Identifier
  - account_number: (string)
    Unique number for Company/Travel agent
  - type: required(one of COMPANY, TRAVELAGENT)
    A type of the account
  - name: required(string)
    A name of Company/Travel agent
  - address: (object)
    Account address
    - id: required(integer)
      Identifier
    - address_line1: (string)
      Address 1
    - address_line2: (string)
      Address 2
    - address_line3: (string)
      Address 3
    - city: (string)
      City Name
    - state: (string)
      State Name
    - postal_code: (string)
      Postal Code
    - country_code: (string)
      Country Code (ISO 3166-1 alpha-2)
  - ar_number: (string)
    Account receivable number
  - hotel_id: required(integer)
    Hotel identifier
  - is_global: required(boolean)
    A flag indicating if the Account is global or not
  - tax_number: (string)
    A tax id number
  - phone: (string)
    The Phone number.
  - fax: (string)
    The Fax number.
  - email: (string)
    The Email address.
  - web_page: (string)
    The web_page link.
  - commision: (object)
    For travel agents if the system needs to calculate a commission on items to be paid to the agency. Can be a % of the transaction or a fixed amount.
    - on: (boolean)
      A flag indicating if the commission is enabled or not.
    - type: (string)
      The commision type can be "percent" or "amount".
    - value: (string)
      The amount value or percent value based on the type selected.
  - primary_contact: (object)
    The main contact person for the agency or company.
    - first_name: (string)
      The first name of main contact person.
    - last_name: (string)
      The last name of main contact person.
    - job_title: (string)
      The job title of main contact person.
    - phone: (string)
      The phone number of main contact person.
    - email: (string)
      The email address of main contact person.
- posting_account_id: (string)
  Posting Account ID for the group.
- room_rates: (object)
  Array of rate configuration for the Group.
  - room_type_id: required(integer)
    The room type id for which the rate is configured
  - currency_code: required(string)
    Currency code. ISO 4217 code
  - group_id: required(integer)
    Group identifier
  - single: required(float)
    The amount against single occupancy
  - double: required(float)
    The amout against double occupancy
  - extra_adult: required(float)
    The amount for extra adult occupancy
- inventories: (object)
  Array of group inventories for the specified date range
  - id: required(integer)
    Group inventory identifier
  - date: required(date-only)
    Date for which the inventory should be saved.
  - room_type_id: required(integer)
    The room type identifier.
  - group_id: required(integer)
    Group identifier
  - blocked: required(object)
    The blocked inventory counts for the group
    - single: required(integer)
      The blocked count against the single occupancy
    - double: required(integer)
      The blocked count against the double occupancy
    - triple: (integer)
      The blocked count against the triple occupancy
    - quadruple: (integer)
      The blocked count against the quadruple occupancy
  - pickup: required(object)
    The occupancy counts of the group
    - single: required(integer)
      The pickup count against the single occupancy
    - double: required(integer)
      The pickup count against the double occupancy
    - triple: (integer)
      The pickup count against the triple occupancy
    - quadruple: (integer)
      The pickup count against the quadruple occupancy
  - available: required(object)
    The available inventory counts for the group
    - single: required(integer)
      The available count against the single occupancy
    - double: required(integer)
      The available count against the double occupancy
    - triple: (integer)
      The available count against the triple occupancy
    - quadruple: (integer)
      The available count against the quadruple occupancy
- revenue: (object)
  Array of revenue details generated by the group
  - amount: (float)
    The amount of revenue generated
  - charge_code_type: (string)
    The charge code type for which the revenue is posted
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Create a new Group for the provided Hotel

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier

Body

Media type: application/json

Type: object

Properties

hotel_id: required(Integer)
Identifier of the Hotel Object
code: required(string)
Group code, only alphanumeric characters allowed.
name: required(string)
The name of the new Group
from_date: required(date-only)
The starting date of the Group, a maximum 32 consecutive nights applies.
to_date: required(date-only)
The end date of the Group, a maximum 32 consecutive nights applies.
rate_id: (Integer)
The Group rate to be attached to the Group. Can be nil if Group with custom rate.
release_date: (date-only)
The release date of the Group Block
first_name: required(string - if Synxis integration is active in the hotel)
The first name of the person for contact.
last_name: required(string - if Synxis integration is active in the hotel)
The last name of the person for contact.
email: (string)
Email of the contact person.
phone: (Integer)
The Phone number of the contact person.
country: (string)
Country Code of the Group
nationality: (string)
Country Code of nationality of the Group
hold_status: required(string)
The Group Hold Status.
market_segment_code: (string)
Use Market Name from get/hotels/{id}/markets which will be attached to the group.
source_code: (string)
The source code to be attached to the Group.
booking_origin_code: (string)
The booking origin code to be attached to the Group.
reservation_type_code: (string)
The reservation type code to be attached to the Group.
shoulder_days_beginning: (integer)
The number of days prior to start date that group can book. Cannot be greater than 5.
shoulder_days_end: (integer)
The number of days after to the end date that group can book. Cannot be greater than 5.
company: (object)
The company object which needs to attached to the Group.
- id: required(Integer)
  The identifier of the company account.
- account_number: required(string)
  The account number of the account.
travel_agent: (object)
The travel agent object which needs to attached to the Group.
- id: required(Integer)
  The identifier of the travel agent account.
- account_number: required(string)
  The account number of the account.
room_rates: (object)
Array of rate configuration for the Group.
- room_type_id: required(Integer)
  The room type id for which the rate is configured
- group_id: (integer)
  Group identifier
- single: required(string)
  The amount against single occupancy
- double: required(string)
  The amout against double occupancy
- extra_adult_amount: (string)
  The amount for extra adult
inventories: (object)
Array of group inventories for the specified date range
- date: required(date-only)
  Date for which the inventory should be saved.
- room_type_id: required(Integer)
  The room type identifier.
- blocked: required(object)
  The blocked inventory counts for the group
  - single: required(Integer)
    The blocked count against the single occupancy
  - double: required(Integer)
    The blocked count against the double occupancy
  - triple: (Integer)
    The blocked count against the triple occupancy
  - quadruple: (Integer)
    The blocked count against the quadruple occupancy

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (Integer)
Identifier of the created Group

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/groups/{id} get put

get

Show Group by its identifier.

put

Update the Group by its identifier

Show Group by its identifier.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Group Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer)
Group Identifier
hotel_id: required(integer)
Identifier of the Hotel Object
code: (string)
The code for the newly created Group
name: required(string)
Group name
from_date: required(date-only)
The starting date of the Group
to_date: required(date-only)
The end date of the Group
shoulder_days_beginning: required(integer)
The number of days prior to start date that group can book
shoulder_days_end: required(integer)
The number of days after to the end date that group can book
rate_id: (integer)
The Group rate to be attached to the Group. Can be nil if Group with custom rate.
release_date: (date-only)
The release date of the Group Block
first_name: (string)
The first name of the contact person
last_name: (string)
The last name of the contact person
email: (string)
Email of the contact person.
phone: (string)
The Phone number of the contact person.
country: (string)
Country Code of the Group
nationality: (string)
Country Code of nationality of the Group
created_date: (date-only)
Date when the Group is created
updated_date: (date-only)
Date when the Group is updated
hold_status: required(string)
The Group Hold Status.
market_segment_code: (string)
The market segment code to be attached to the Group.
segment_code: (string)
The segment code to be attached to the Group.
source_code: (string)
The source code to be attached to the Group.
booking_origin_code: (string)
The booking origin code to be attached to the Group.
reservation_type_code: (string)
The reservation type code to be attached to the Group.
company: (object)
The company object which needs to be attached to the Group.
- id: required(integer)
  Identifier
- account_number: (string)
  Unique number for Company/Travel agent
- type: required(one of COMPANY, TRAVELAGENT)
  A type of the account
- name: required(string)
  A name of Company/Travel agent
- address: (object)
  Account address
  - id: required(integer)
    Identifier
  - address_line1: (string)
    Address 1
  - address_line2: (string)
    Address 2
  - address_line3: (string)
    Address 3
  - city: (string)
    City Name
  - state: (string)
    State Name
  - postal_code: (string)
    Postal Code
  - country_code: (string)
    Country Code (ISO 3166-1 alpha-2)
- ar_number: (string)
  Account receivable number
- hotel_id: required(integer)
  Hotel identifier
- is_global: required(boolean)
  A flag indicating if the Account is global or not
- tax_number: (string)
  A tax id number
- phone: (string)
  The Phone number.
- fax: (string)
  The Fax number.
- email: (string)
  The Email address.
- web_page: (string)
  The web_page link.
- commision: (object)
  For travel agents if the system needs to calculate a commission on items to be paid to the agency. Can be a % of the transaction or a fixed amount.
  - on: (boolean)
    A flag indicating if the commission is enabled or not.
  - type: (string)
    The commision type can be "percent" or "amount".
  - value: (string)
    The amount value or percent value based on the type selected.
- primary_contact: (object)
  The main contact person for the agency or company.
  - first_name: (string)
    The first name of main contact person.
  - last_name: (string)
    The last name of main contact person.
  - job_title: (string)
    The job title of main contact person.
  - phone: (string)
    The phone number of main contact person.
  - email: (string)
    The email address of main contact person.
travel_agent: (object)
The travel agent object which needs to be attached to the Group.
- id: required(integer)
  Identifier
- account_number: (string)
  Unique number for Company/Travel agent
- type: required(one of COMPANY, TRAVELAGENT)
  A type of the account
- name: required(string)
  A name of Company/Travel agent
- address: (object)
  Account address
  - id: required(integer)
    Identifier
  - address_line1: (string)
    Address 1
  - address_line2: (string)
    Address 2
  - address_line3: (string)
    Address 3
  - city: (string)
    City Name
  - state: (string)
    State Name
  - postal_code: (string)
    Postal Code
  - country_code: (string)
    Country Code (ISO 3166-1 alpha-2)
- ar_number: (string)
  Account receivable number
- hotel_id: required(integer)
  Hotel identifier
- is_global: required(boolean)
  A flag indicating if the Account is global or not
- tax_number: (string)
  A tax id number
- phone: (string)
  The Phone number.
- fax: (string)
  The Fax number.
- email: (string)
  The Email address.
- web_page: (string)
  The web_page link.
- commision: (object)
  For travel agents if the system needs to calculate a commission on items to be paid to the agency. Can be a % of the transaction or a fixed amount.
  - on: (boolean)
    A flag indicating if the commission is enabled or not.
  - type: (string)
    The commision type can be "percent" or "amount".
  - value: (string)
    The amount value or percent value based on the type selected.
- primary_contact: (object)
  The main contact person for the agency or company.
  - first_name: (string)
    The first name of main contact person.
  - last_name: (string)
    The last name of main contact person.
  - job_title: (string)
    The job title of main contact person.
  - phone: (string)
    The phone number of main contact person.
  - email: (string)
    The email address of main contact person.
posting_account_id: (string)
Posting Account ID for the group.
room_rates: (object)
Array of rate configuration for the Group.
- room_type_id: required(integer)
  The room type id for which the rate is configured
- currency_code: required(string)
  Currency code. ISO 4217 code
- group_id: required(integer)
  Group identifier
- single: required(float)
  The amount against single occupancy
- double: required(float)
  The amout against double occupancy
- extra_adult: required(float)
  The amount for extra adult occupancy
inventories: (object)
Array of group inventories for the specified date range
- id: required(integer)
  Group inventory identifier
- date: required(date-only)
  Date for which the inventory should be saved.
- room_type_id: required(integer)
  The room type identifier.
- group_id: required(integer)
  Group identifier
- blocked: required(object)
  The blocked inventory counts for the group
  - single: required(integer)
    The blocked count against the single occupancy
  - double: required(integer)
    The blocked count against the double occupancy
  - triple: (integer)
    The blocked count against the triple occupancy
  - quadruple: (integer)
    The blocked count against the quadruple occupancy
- pickup: required(object)
  The occupancy counts of the group
  - single: required(integer)
    The pickup count against the single occupancy
  - double: required(integer)
    The pickup count against the double occupancy
  - triple: (integer)
    The pickup count against the triple occupancy
  - quadruple: (integer)
    The pickup count against the quadruple occupancy
- available: required(object)
  The available inventory counts for the group
  - single: required(integer)
    The available count against the single occupancy
  - double: required(integer)
    The available count against the double occupancy
  - triple: (integer)
    The available count against the triple occupancy
  - quadruple: (integer)
    The available count against the quadruple occupancy
revenue: (object)
Array of revenue details generated by the group
- amount: (float)
  The amount of revenue generated
- charge_code_type: (string)
  The charge code type for which the revenue is posted

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Update the Group by its identifier

Secured by oauth_2_0

URI Parameters

id: required(integer)
Group Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(Integer)
Identifier of the Hotel Object
code: required(string)
The code for the newly created Group
name: required(string)
The name of the new Group
from_date: required(date-only)
The starting date of the Group, a maximum 32 consecutive nights applies.
to_date: required(date-only)
The end date of the Group, a maximum 32 consecutive nights applies.
rate_id: (Integer)
The Group rate to be attached to the Group. Can be nil if Group with custom rate.
release_date: (date-only)
The release date of the Group Block
first_name: (string)
The first name of the person for contact.
last_name: (string)
The last of the of the persion for contact
email: (string)
Email of the contact person.
phone: (Integer)
The Phone number of the contact person.
hold_status: required(string)
The Group Hold Status.
market_segment_code: (string)
Use Market Name from get/hotels/{id}/markets which will be attached to the group.
source_code: (string)
The source code to be attached to the Group.
booking_origin_code: (string)
The booking origin code to be attached to the Group.
reservation_type_code: (string)
The reservation type code to be attached to the Group.
company
travel_agent
shoulder_days_beginning: (integer)
The number of days prior to start date that group can book. Cannot begreater than 5.
shoulder_days_end: (integer)
The number of days after to the end date that group can book. Cannot be greater than 5.
room_rates: (object)
Array of rate configuration for the Group.
- room_type_id: required(Integer)
  The room type id for which the rate is configured
- group_id: (integer)
  Group identifier
- single: required(string)
  The amount against single occupancy
- double: required(string)
  The amout against double occupancy
- extra_adult_amount: (string)
  The amount for extra adult
inventories: (object)
Array of group inventories for the specified date range
- date: required(date-only)
  Date for which the inventory should be saved.
- room_type_id: required(Integer)
  The room type identifier.
- blocked: required(object)
  The blocked inventory counts for the group
  - single: required(Integer)
    The blocked count against the single occupancy
  - double: required(Integer)
    The blocked count against the double occupancy
  - triple: (Integer)
    The blocked count against the triple occupancy
  - quadruple: (Integer)
    The blocked count against the quadruple occupancy

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (Integer)
Identifier of the updated Group

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/groups/{id}/notes get post

get

Get the paginated notes for the group.

post

Post notes to the group

Get the paginated notes for the group.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Group Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: Note
- id: (integer)
  Identifier
- description: (string)
  Description
- created_at: (datetime-only)
  Created at timestamp
total_count: (integer)

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Post notes to the group

Secured by oauth_2_0

URI Parameters

id: required(integer)
Group Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

notes: (array of object)
Group notes
Items: items
- description: required(string)
  Note description

Example:

{
  "notes": [
    {
      "description": "Test Desc 1"
    },
    {
      "description": "Test Desc 2"
    },
    {
      "description": "Test Desc 3"
    }
  ]
}

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/groups/{id}/cancel put

put

Cancel Group by its identifier.

Secured by oauth_2_0

URI Parameters

id: required(string)

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (integer)
Identifier of the cancelled Group

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/groups/{id}/room_rates get put

get

Returns a list of room rates of a group filtered by the input parameters.

put

Update room custom daily rates of a group.

Secured by oauth_2_0

URI Parameters

id: required(string)

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

room_rates: required(object)
Array of objects
- from_date: required(date)
  The start of date range for which the update is to be applied.
- to_date: required(date)
  The end of date range for which the update is to be applied
- room_type_id: required(integer)
  The room type identifier
- single: required(string)
  The rate for 1 person for the room.
- double: required(string)
  The rate for 2 people for the room.
- extra_adult_amount: (string)
  The amount added to the double rate for each person more than 2 in the room.

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (integer)
Identifier of the updated Group

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/guests

/guests get post

get

Returns a paginated list of guest details filtered by the input parameters.

post

Create guest details for the hotel chain.

Returns a paginated list of guest details filtered by the input parameters.

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

first_name: (string)
First Name of Guest
last_name: (string)
Last Name of Guest
city: (string)
City of Guest
email: (string)
Email of Guest
membership_no: (string)
Membership card number of Guest
query: (string)
Search text
page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: Guest
- id: required(integer)
  Identifier
- is_primary: (boolean)
  Is Primary Guest(Returned only when the object belongs to the Reservation object)
- first_name: (string)
  Guest's First name
- last_name: required(string)
  Guest's Last Name
- email: (string)
  Guest's Email address
- address: (object)
  Guest's address
  - id: required(integer)
    Identifier
  - address_line1: (string)
    Address 1
  - address_line2: (string)
    Address 2
  - address_line3: (string)
    Address 3
  - city: (string)
    City Name
  - state: (string)
    State Name
  - postal_code: (string)
    Postal Code
  - country_code: (string)
    Country Code (ISO 3166-1 alpha-2)
- birthday: (date-only)
  Guest's birthday
- is_vip: required(boolean)
  Is VIP Guest
- title: (string)
  Guest's Title
- works_at: (string)
  Guest's Company
- job_title: (string)
  Guest's Job Title
- nationality: (string)
  Guest's Nationality Country Code (ISO)
- home_phone: (string)
  Guest's home phone number
- language: (string)
  Guest's language. ISO 639-1
- opted_promotional_emails: required(boolean)
  Opted for promotional emails
- mobile_phone: (string)
  Guest's mobile number
- is_flagged: (boolean)
  Is flagged guest
- flagged_reason: (string)
  Reason guest was flagged. Only returned when value is present.
- memberships: (array of GuestMembership)
  Guest Memberships
  Items: GuestMembership
  - id: required(integer)
    Guest membership identifier
  - code: (string)
    Membership program code
  - membership_id: required(string)
    Membership Identifier
  - type: required(one of FFP, HLP)
    Membership Program Type - Frequent Flyer Program or Hotel Loyalty Program
  - level: (object)
    Membership Level Details
    id: (integer)
    Membership level identifier
    name: (string)
    Membership level name
- likes: (array of object)
  Likes
  Items: items
  - category: (string)
    category
  - names: (array of string)
    Array of likes
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Create guest details for the hotel chain.

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

first_name: (string)
First Name
last_name: required(string)
Last Name
email: (string)
Email
address: (object)
Address
- id: required(integer)
  Identifier
- address_line1: (string)
  Address 1
- address_line2: (string)
  Address 2
- address_line3: (string)
  Address 3
- city: (string)
  City Name
- state: (string)
  State Name
- postal_code: (string)
  Postal Code
- country_code: (string)
  Country Code (ISO 3166-1 alpha-2)
birthday: (date-only)
Birthday (yyyy-mm-dd format)
is_vip: (boolean)
VIP Guest
title: (string)
Title
works_at: (string)
Company
job_title: (string)
Job Title
nationality: (string)
Nationality Country Code (ISO 3166-1 alpha-2)
home_phone: (string)
Home Phone
language: (string)
Language Code (ISO 639-1)
opted_promotional_emails: (boolean)
Opted for promotional emails
mobile_phone: (string)
Mobile Phone
gender: (one of MALE, FEMALE)
Gender
vehicle_registration_number: (string)
Vehicle registration number
vehicle_country_code: (string)
Vehicle Country Code (ISO-3166-1 alpha-2)
is_flagged: (boolean)
Is flagged
flagged_reason: (string)
Reason for flagging guest
notes: (array of object)
Guest notes
Items: items
- description: required(string)
  Note description

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (Integer)
Identifier of the created Guest Detail

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/guests/{id}/memberships get post

get

Get the paginated guest memberships.

post

Create a new guest membership.

Get the paginated guest memberships.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Guest Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: GuestMembership
- id: required(integer)
  Guest membership identifier
- code: (string)
  Membership program code
- membership_id: required(string)
  Membership Identifier
- type: required(one of FFP, HLP)
  Membership Program Type - Frequent Flyer Program or Hotel Loyalty Program
- level: (object)
  Membership Level Details
  - id: (integer)
    Membership level identifier
  - name: (string)
    Membership level name
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Create a new guest membership.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Guest Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier

Body

Media type: application/json

Type: object

Properties

code: required(string)
Membership Program Code
membership_id: required(integer)
Membership Identifier
type: required(one of FFP, HLP)
Membership Program Type - Frequent Flyer Program or Hotel Loyalty Program
level_id: (integer)
Membership Level Identifier

Example:

{
  "code": "TESTCODE",
  "membership_id": 1847,
  "type": "HLP",
  "level_id": 461
}

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (integer)
Identifier of the created guest membership.

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/guests/{id}/likes post

post

Save guest likes.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Guest Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(integer)
Hotel Identifier
likes: required(array)
Array of like IDs

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

likes: required(array)
Array of like IDs & Names

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels

/hotels get

get

Returns a paginated list of hotels filtered by the input parameters.

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

code: (string)
Hotel Code
page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: Hotel
- id: (integer)
  Identifier
- code: (string)
  Code
- name: (string)
  Name
- uuid: (string)
  UUID
- check_in_time: (time-only)
  Check In Time
- check_out_time: (time-only)
  Check Out Time
- address: (object)
  Address
  - address1: (string)
    Address 1
  - address2: (string)
    Address 2
  - address3: (string)
    Address 3
  - city: (string)
    City
  - state: (string)
    State
  - postal_code: (string)
    Postal Code
  - country: (string)
    Country Code (ISO)
- phone: (string)
  Hotel Phone
- main_contact: (object)
  Main Contact
  - first_name: (string)
    First Name
  - last_name: (string)
    Last Name
  - email: (string)
    Email
  - phone: (string)
    Phone
- currency_code: (string)
  Currency Code
- timezone: required(string)
  Hotel Timezone
- brand: (string)
  Hotel Brand
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/addons get

get

Returns a paginated list of addons filtered by the input parameters.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: Addon
- id: required(integer)
  Identifier
- name: required(string)
  Addon Name
- description: required(string)
  Description of Addon
- amount: required(float)
  Addon price
- amount_type: required(one of ADULT, CHILD, FLAT, PERSON, ROOM)
  Addon price Type
- post_type: required(one of STAY, WEEKLY, NIGHT, LAST_NIGHT)
  Post Type
- post_type_description: required(one of Nightly, Every Week, First Night, Post on Last Night)
  Post Type Description
- post_days: required(array)
  List of weekdays (order according to ISO-8601 standard). Only returned when Post Type is STAY.
- charge_code_id: required(integer)
  Associated Charge Code
- charge_group_id: required(integer)
  Associated Charge Group
- currency_code: required(string)
  Associated Currency Code (ISO 4217 Format)
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/charge_codes get

get

Returns a paginated list of charge codes filtered by the input parameters.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: ChargeCode
- id: required(integer)
  Identifier
- charge_code: required(string)
  Charge Code name
- description: required(string)
  Description of charge code
- charge_code_type: required(one of TAX, PAYMENT, ADDON, OTHERS, ROOM, FEES, AR_MANUAL_BALANCE, TOURIST_TAX, AR_MANUAL_CREDIT, FNB)
  Charge Code Type Value
- amount: required(float)
  Amount for the charge code
- post_type: required(one of STAY, NIGHT, WEEKLY, EVERY_X_STARTING_Y, CERTAIN_NIGHTS, LAST_NIGHT, STAY_EXCEPT_ARRIVAL, STAY_EXCEPT_LAST, EXCLUDE_FIRST_AND_LAST, CUSTOM)
  Post Type Value
- amount_type: required(one of ADULT, CHILD, PERSON, FLAT, ROOM)
  Amount Type Value
- amount_symbol: required(one of amount, percent)
  Amount Symbol Value
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/charge_groups get

get

Returns a paginated list of charge groups filtered by the input parameters.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: ChargeGroup
- id: required(integer)
  Identifier
- charge_group: required(string)
  Charge group name
- description: required(string)
  Charge group description
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/credit_card_types get

get

Returns a list of credit card types for hotel.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: CreditCardType
- code: (string)
  Credit Card Scheme Code
- name: (string)
  Credit Card Scheme Name

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/languages get

get

Returns the paginated guest languages set up for a given hotel.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: Language
- language: required(string)
  ISO code for guest language
- is_default: required(boolean)
  Flag indicating whether the language is the default used by the hotel
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/markets get

get

Returns a paginated list of markets filtered by the input parameters.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: Market
- id: required(integer)
  Identifier
- name: required(string)
  Name
- active: required(boolean)
  Is active for the property
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/payment_types get

get

Returns a paginated list of payment types filtered by the input parameters.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: PaymentType
- description: (string)
  Payment Type Description
- active: (boolean)
  Active
- code: (string)
  Code
- linked_reservation_type: (string)
  Reservation Type Linked
- is_credit_card: (boolean)
  Is Credit Card
- rover_payment_only: (boolean)
  Rover Payment Only
- web_payment_only: (boolean)
  Web Payment Only
- restrict_post: (boolean)
  Restrict Post
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/queue_details get

get

Returns the queue details for the hotel and by room type.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

room_type_id: (integer)
Room Type Identifier

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: QueueDetail
- total_queue_count: (integer)
  Total Queued Reservation Count
- total_available_count: (integer)
  Total Available Room Count
- room_types: (array of object)
  Items: items
  - id: (integer)
    Room Type Identifier
  - queue_count: (integer)
    Queued Reservation Count
  - available_count: (integer)
    Available Room Count

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/rates get

get

Returns a paginated list of rates filtered by the input parameters.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

code: (string)
Rate Code
channel_rates_only: (boolean)
When provided "true", returns only the rates tagged in defined channel manager.
integration: (String)
Specify the Channel Manager where you want to retrieve the rates from. For eg; "IBE"=Internet Booking Engine. Please check with integrations team for the correct integration channel.
page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: Rate
- id: required(integer)
  Identifier
- code: required(string)
  Rate Code
- name: required(string)
  Rate Name
- description: required(string)
  Description
- currency_code: required(string)
  Currency Code
- type: required(object)
  Rate Type
  - id: required(integer)
    Identifier
  - name: required(string)
    Rate Type name
  - classification: required(one of PUBLIC, CORPORATE, GROUP)
    Rate type classification
  - active: required(boolean)
    Whether the rate type is active for the property
- charge_code: required(object)
  Charge Codes
  - id: required(integer)
    Identifier
  - charge_code: required(string)
    Charge Code name
  - description: required(string)
    Description of charge code
  - charge_code_type: required(one of TAX, PAYMENT, ADDON, OTHERS, ROOM, FEES, AR_MANUAL_BALANCE, TOURIST_TAX, AR_MANUAL_CREDIT, FNB)
    Charge Code Type Value
  - amount: required(float)
    Amount for the charge code
  - post_type: required(one of STAY, NIGHT, WEEKLY, EVERY_X_STARTING_Y, CERTAIN_NIGHTS, LAST_NIGHT, STAY_EXCEPT_ARRIVAL, STAY_EXCEPT_LAST, EXCLUDE_FIRST_AND_LAST, CUSTOM)
    Post Type Value
  - amount_type: required(one of ADULT, CHILD, PERSON, FLAT, ROOM)
    Amount Type Value
  - amount_symbol: required(one of amount, percent)
    Amount Symbol Value
- based_on_rate: (object)
  Based on Rate (Value requires when this rate is child or contract)
  - id: required(integer)
    Identifier
  - name: required(string)
    Based on Rate name
  - based_on_type: (one of amount, percent)
    Based on Type (Value requires when this rate is child or contract)
  - based_on_value: (string)
    Based on Value (Value requires when this rate is child or contract)
- discount_allowed: (boolean)
  Whether the rate is allowed discount
- active: required(boolean)
  Whether the rate is active for the property
- tax_inclusive_or_exclusive: (one of inclusive, exclusive, multiple)
  Rate Tax type
- suppress_rate: (boolean)
  Whether the rate is suppressed
- market_segment_code: (string)
  Market Segment Code
- source_code: (string)
  Source Code
- booking_origin_code: (string)
  Booking Origin Code
- commissionable: (boolean)
  Whether the rate is commissionable
- commission_type: (string)
  Commission Type (Value requires when is_commission_on is true)
- commission_value: (string)
  Commission value (Value requires when is_commission_on is true)
- commission_post_type: (one of STAY, WEEKLY, NIGHT, EVERY_X_STARTING_Y, CERTAIN_NIGHTS, LAST_NIGHT, STAY_EXCEPT_ARRIVAL, STAY_EXCEPT_LAST, EXCLUDE_FIRST_AND_LAST, CUSTOM)
  Commission post type (Value requires when is_commission_on is true)
- end_date: (date-only)
  Rate End Date
- deposit_policy: (object)
  Deposit policy for the rate
  - id: required(integer)
    Identifier
  - name: required(string)
    Deposit Policy name
  - description: (string)
    Deposit Policy description
- cancellation_policy: (object)
  Cancellation policy for the rate
  - id: required(integer)
    Identifier
  - name: required(string)
    Cancellation Policy name
  - description: (string)
    Cancellation Policy description
- addons: (array of object)
  Array of Rate Addons
  Items: RateAddon
  - id: required(integer)
    Identifier
  - name: required(string)
    Addon Name
  - description: required(string)
    Description of Addon
  - amount: required(float)
    Addon price
  - amount_type: required(one of ADULT, CHILD, FLAT, PERSON, ROOM)
    Addon price Type
  - post_type: required(one of STAY, WEEKLY, NIGHT, LAST_NIGHT)
    Post Type
  - post_type_description: required(one of Nightly, Every Week, First Night, Post on Last Night)
    Post Type Description
  - post_days: required(array)
    List of weekdays (order according to ISO-8601 standard). Only returned when Post Type is STAY.
  - charge_code_id: required(integer)
    Associated Charge Code
  - charge_group_id: required(integer)
    Associated Charge Group
  - currency_code: required(string)
    Associated Currency Code (ISO 4217 Format)
  - included_in_rate: (boolean)
    Indicates that the add-on is included in the rate
- room_types: required(object)
  Array of Room Types belonging to this rate
  - id: required(integer)
    Identifier
  - name: required(string)
    Room Type name
- hourly_rate: (boolean)
  Whether the rate is hourly
- fixed_rate: (boolean)
  Whether the rate is fixed
- public_rate: (boolean)
  Whether the rate is public
- member: (boolean)
  Whether the rate is for member
- pms_only: (boolean)
  Whether the rate is for pms only
- channel_only: (boolean)
  Whether the rate is for channel only
- prepaid_commission: (boolean)
  Whether the rate is prepaid commission
- rate_shown_on_guest_bill: (boolean)
  Whether the rate is showing on guest bill
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/room_types get

get

Returns a paginated list of room types filtered by the input parameters.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

code: (string)
Room Type Code
page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: RoomType
- id: (integer)
  Identifier
- code: (string)
  Code
- name: (string)
  Name
- description: (string)
  Description
- max_occupancy: (integer)
  Max Occupancy
- image_url: (string)
  Image URL
- suite: (boolean)
  Is a suite room type
- pseudo: (boolean)
  Is a pseudo room type
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/rooms get

get

Returns a paginated list of rooms filtered by the input parameters.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

number: (string)
Room Number
room_type_id: (integer)
Room Type Identifier
page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: Room
- id: (integer)
  Identifier
- number: (string)
  Room Number
- room_type_id: (integer)
  Room Type Identifier
- status: (one of CLEAN, INSPECTED, DIRTY, PICKUP)
  Current Housekeeping status of room
- service_status: (one of IN_SERVICE, OUT_OF_ORDER, OUT_OF_SERVICE)
  Current service status of room
- occupied: (boolean)
  Is the room currently occupied
- max_occupancy: (integer)
  Maximum occupancy
- floor: (object)
  Floor information
  - number: (string)
    Floor number
  - description: (string)
    Floor description
- features: (array of any)
  Array of features assigned to the room
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/sources get

get

Returns a paginated list of sources filtered by the input parameters.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: Source
- id: required(integer)
  Identifier
- code: required(string)
  Source Code
- description: required(string)
  Source Description
- active: required(boolean)
  Is active for the property
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/origins get

get

Returns a paginated list of booking origins filtered by the input parameters.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: Origin
- id: required(integer)
  Identifier
- name: required(string)
  Booking origin code
- active: required(boolean)
  Is active for the property
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/memberships get

get

Returns a paginated list of memberships filtered by the input parameters.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: Membership
- id: required(integer)
  Identifier
- name: required(string)
  Membership name
- description: required(string)
  Membership description
- type: required(one of FFP, HLP)
  Type of membership
- levels: (array of object)
  Membership levels
  Items: items
  - id: (integer)
    Membership Level Identifier
  - name: (string)
    Name of the level
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/rate_types get

get

Returns a paginated list of rate types filtered by the input parameters.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: RateType
- id: required(integer)
  Identifier
- name: required(string)
  Name
- classification: required(one of PUBLIC, CORPORATE, GROUP)
  Rate classification
- is_active: (boolean)
  Is active for the property
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/deposit_policies get

get

Returns a paginated list of deposit policies filtered by the input parameters.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: DepositPolicy
- id: required(integer)
  Deposit Policy Identifier
- name: required(string)
  Deposit Policy Name
- description: (string)
  Description
- apply_to_all_bookings: (boolean)
  Flag that decides the policy should be applied to all bookings or not
- allow_editing: (boolean)
  Flag that decides the policy should be editable or not
- do_not_apply_if_routing: (boolean)
  Flag that decides the policy should be applied if routing enabled or not
- schedules: (array of DepositPolicySchedule)
  Array of deposit policy schedules
  Items: DepositPolicySchedule
  - amount: required(number)
    Amount for the schedule
  - amount_type: required(one of amount, percent, day)
    Amount Type for the schedule
  - post_type: required(one of CUSTOM, STAY, NIGHT, LAST_NIGHT, WEEKDAY, WEEKEND)
    Post Type for the schedule
  - advance_days: required(integer)
    Advance days
  - auto_charge_on_due_date: (boolean)
    Auto charge on due date
  - max_no_nights: (integer)
    Maximum number of nights
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/cancellation_policies get

get

Returns a paginated list of deposit policies filtered by the input parameters.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: CancellationPolicy
- id: (integer)
  Cancellation Policy Identifier
- name: (string)
  Cancellation Policy Name
- description: (string)
  Description
- amount_type: (one of amount, percent, day)
  Amount Type for the Policy
- amount: (number)
  Amount for the Policy
- advance_days: (integer)
  Advance days for cancellation
- advance_time: (string)
  Advance time for cancellation
- charge_code_id: (integer)
  Charge Code Identifier
- post_type: (one of CUSTOM, STAY, NIGHT, LAST_NIGHT, WEEKDAY, WEEKEND)
  Post type for Cancellation (Considered only if amount_type is 'percent')
- apply_to_all_bookings: (boolean)
  Flag that decides the policy should be applied to all bookings or not
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/hourly_availability get

get

Returns hourly availability based on requested parameters. (Only single rate and its room type information will be returned in the response). This is applicable only for the hotels that supports hourly functionality.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

from_date_time: required(time-only)
From Date Time - Format - "YYYY-MM-DD HH:MM". Time should be in hotel time zone.
to_date_time: required(time-only)
End Date Time - Format - "YYYY-MM-DD HH:MM". Time should be in hotel time zone.
room_type_id: (integer)
Room type identifier
company_account_number: (string)
Company card account number
travel_agent_account_number: (string)
Travel agent account number
access_code: (string)
Contract access code

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

rate_id: (integer)
Rate identifier
rate_code: (string)
Rate Code
rate_type_id: (integer)
Rate Type identifier
deposit_rule_info: (object)
Deposit rule information
- id: (integer)
  Deposit rule identifier
- name: (string)
  Deposit rule name
- description: (string)
  Deposit rule description
cancel_rule_info: (object)
Cancellation rule information
- id: (integer)
  Cancel rule identifier
- name: (string)
  Cancel rule name
- description: (string)
  Cancel rule description
available_rooms: (array of object)
List of rooms available, filtered by request parameters and its details
Items: items
- room_id: (integer)
  Room identifier
- room_no: (string)
  Room number
- room_type_id: (integer)
  Room Type identifier
- amount: (number)
  Base amount for the stay

Example:

{
  "rate_id": 25839,
  "rate_code": "TDIRDULFFLRO",
  "rate_type_id": 309,
  "deposit_rule_info": {
    "id": 1,
    "name": "Prepayment required",
    "description": "Prepayment Required for Reservation"
  },
  "cancel_rule_info": {
    "id": 36,
    "name": "24 hr Cancellation Policy",
    "description": "24 hr Cancellation Policy"
  },
  "available_rooms": [
    {
      "room_id": 15078,
      "room_no": "01",
      "room_type_id": 62,
      "amount": "260.00"
    },
    {
      "room_id": 12466,
      "room_no": "02",
      "room_type_id": 62,
      "amount": "260.00"
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/hourly_availability/room_rates get

get

Returns stay cost and tax information for the requested time frame and rate-roomtype combination.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

from_date_time: required(time-only)
From Date Time - Format - "YYYY-MM-DD HH:MM". Time should be in hotel time zone.
to_date_time: required(time-only)
To Date Time - Format - "YYYY-MM-DD HH:MM". Time should be in hotel time zone.
rate_id: required(integer)
Rate identifier
room_type_id: required(integer)
Room type identifier

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

rate_amount: (number)
Base amount for the stay
addon_amount: (number)
Addon price
total_inclusive_tax: (number)
Total inclusive tax (This will be included in the base amount)
total_exclusive_tax: (number)
Total exclusive tax
total_stay_cost: (number)
Total stay cost

Example:

{
  "rate_amount": 590,
  "addon_amount": 20,
  "total_inclusive_tax": 98.33,
  "total_exclusive_tax": 14,
  "total_stay_cost": 624
}

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/availability get

get

Returns a paginated list of availability filtered by the input parameters.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

from_date: required(date-only)
From date
to_date: required(date-only)
To date
adults: required(integer)
Number of adults
children: required(integer)
Number of children
room_type_id: (integer)
Room type identifier
rate_id: (integer)
Rate identifier
company_account_number: (string)
Company card account number
travel_agent_account_number: (string)
Travel agent account number
is_channel_manager: (boolean)
when provided "true", returns only the rates tagged in IBE channel manager
is_member: (boolean)
when provided "true", returns only the member rates
rate_classification: (one of PUBLIC, CORPORATE, GROUP)
Rate classification
promotion_code: (string)
Promotion code
access_code: (string)
Contract access code
group_code: (string)
Group code
page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: NightlyAvailability
- rate_id: (integer)
  Rate identifier
- rate_code: (string)
  Rate Code
- deposit_rule_info: (object)
  Deposit rule information
  - id: (integer)
    Deposit rule identifier
  - name: (string)
    Deposit rule name
  - description: (string)
    Deposit rule description
- cancel_rule_info: (object)
  Cancellation rule information
  - id: (integer)
    Cancel rule identifier
  - name: (string)
    Cancel rule name
  - description: (string)
    Cancel rule description
- room_types: (array of object)
  List of room types available filtered by request parameters and its details
  Items: items
  - id: (integer)
    RoomType identifier
  - name: (string)
    Name of the room type
  - availability: (integer)
    Availability count
  - adr: (number)
    Average Daily Rate
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/availability/room_rates get

get

Returns a detailed list of rates and taxes for complete stay filtered by the input parameters.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

from_date: required(date-only)
From date
to_date: required(date-only)
To date
adults: required(integer)
Number of adults
children: required(integer)
Number of children
room_type_id: required(integer)
Room type identifier
rate_id: required(integer)
Rate identifier (This is not a mandatory item if group code is provided)
promotion_code: (string)
Promotion code
group_code: (string)
Group code

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

total_stay_cost: (number)
Total stay cost
total_inclusive_tax: (number)
Total inclusive tax
total_exclusive_tax: (number)
Total exclusive tax
total_exclusive_tourist_tax: (number)
Total exclusive tourist tax
stay_dates: (array of object)
Price breakdown by stay dates
Items: items
- date: (date-only)
  Stay date
- rate_amount: (number)
  Rate amount for the date
- addon_amount: (number)
  Addon amount for the date
- exclusive_tax: (number)
  Exclusive tax amount for the date
- exclusive_tourist_tax: (number)
  Exclusive tourist tax amount for the date
- inclusive_tax: (number)
  Inclusive tax amount for the date
- total_amount: (number)
  Total amount for the date

Example:

{
  "total_stay_cost": 2356.9,
  "total_inclusive_tax": 353.32,
  "total_exclusive_tax": 10,
  "total_exclusive_tourist_tax": 32.9,
  "stay_dates": [
    {
      "date": "2023-10-01",
      "rate_amount": 1111,
      "addon_amount": 46,
      "exclusive_tax": 5,
      "exclusive_tourist_tax": 16.45,
      "inclusive_tax": 176.66,
      "total_amount": 1178.45
    },
    {
      "date": "2023-10-02",
      "rate_amount": 1111,
      "addon_amount": 46,
      "exclusive_tax": 5,
      "exclusive_tourist_tax": 16.45,
      "inclusive_tax": 176.66,
      "total_amount": 1178.45
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/group_hold_status get

get

Returns the group hold statuses set up for a given hotel.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: required(array of object)
Items: GroupHoldStatus
- hold_status: required(string)
  Name of hold status
- deduct_from_inventory: required(boolean)
  Flag indicating whether the hold status signifies a deduction from the hotel's inventory
- group_only: required(boolean)
  Flag indicating whether the hold status applies to only groups
- allotment_only: required(boolean)
  Flag indicating whether the hold status applies to only allotments

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hotels/{id}/likes get

get

Returns a paginated list of likes.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Hotel Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: Like
- id: required(integer)
  ID
- name: required(string)
  Name
- category: required(string)
  Category
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/hourly_reservations

/hourly_reservations post

post

Create hourly reservation for the provided hotel

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

adults_count: required(integer)
Number of adults in the room
arrival_time: required(string)
Date and time of arrival in ISO-8601 format.
Example:
```
2020-07-06T19:04:29Z
```
children_count: (integer)
Number of children in the room
departure_time: required(string)
Date and time of departure in ISO-8601 format.
Example:
```
2020-07-06T20:04:55Z
```
guests: required(array of object)
Guests
Items: items
- id: (integer)
  Guest Identifier of the existing guest
- first_name: required(string)
  First/Given name of the guest
- last_name: required(string)
  Last/Family name of the guest
- is_primary: required(boolean)
  Indicates the main guest to be used on reservation(only one guest can be primary)
- email: (string)
  Email address of the guest
- phone: (string)
  Phone number of the guest(landline or other)
- mobile: (string)
  Mobile or cell number of the guest
- address: (object)
  Address of Guest
  - street: (string)
    Street 1 Address
  - city: (string)
    City
  - state: (string)
    State
  - country: (string)
    Country Code
  - postal_code: (string)
    Postal Code
hotel_id: required(integer)
Hotel Identifier
note: (string)
Note to be added to the reservation
Example:
```
Quo vel facere est inventore reprehenderit.
```
rate_id: required(integer)
Identifier of the rate code to be used as part of the reservation
room_id: required(integer)
Room Identifier of the room to be assigned to the reservation (Hourly reservation MUST be assigned a specific room at the time of booking for correct inventory allocations)
source_code: (String)
Source Code

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(Integer)
Reservation Identifier

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/inventories

/inventories get

get

Returns a list of inventories filtered by the input parameters. Inventories for requested hotel and room type is returned..

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(string)
Hotel Identifier
room_type_ids: (array)
Room Type Identifiers
from_date: required(date)
Start Date
to_date: required(date)
End Date
page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: Inventory
- hotel_id: required(integer)
  Hotel Identifier
- date: required(date)
  Inventory date
- definitive_availability: required(integer)
  Availability
- physical: required(integer)
  Total inventory count
- definitive_sold: required(integer)
  Sold count
- out_of_order: required(integer)
  Out of order count
- sell_limit: (integer)
  Sell limit count
- room_type: (string)
  Room type code for this inventory(If this is missing, this is house inventory)
- room_type_id: (integer)
  Room type identifier for this inventory(If this is missing, this is house inventory)
total_count: (integer)

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/oauth

/posting_accounts

/posting_accounts get post

get

Returns a paginated list of posting accounts filtered by the input parameters. Posting Accounts for requested hotel is returned.

post

Create Posting Account for the provided hotel

Returns a paginated list of posting accounts filtered by the input parameters. Posting Accounts for requested hotel is returned.

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier
type: (string)
Possible values are HOUSE, GROUP
status: (string)
Possible values are OPEN, CLOSED
name: (string)
Name of the Posting Account
account_number: (string)
Account Number of the Posting Account
page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: PostingAccount
- id: required(integer)
  Posting Account Identifier
- name: required(string)
  Name of the Posting Account
- account_number: (string)
  Account Number of the Posting Account
- type: (one of HOUSE, GROUP)
  Type of Posting Account
- status: (one of OPEN, CLOSED)
  Account Status
- market_segment_id: (integer)
  Identifier of the associated Market Segment
- source_id: (integer)
  Identifier of the associated Source
- booking_origin_id: (integer)
  Identifier of the associated Booking Origin
- company_id: (integer)
  Associated Company Account Identifier
- travel_agent_id: (integer)
  Associated Travel Agent Account Identifier
- bills: (array of object)
  The bills for this posting account
  Items: AccountBill
  - bill_number: required(integer)
    Bill number
  - invoice_number: (String)
    Bill Invoice number
  - folio_number: (String)
    Bill Folio number
  - id: required(integer)
    Identifier
  - settle_date: (date)
    The date where posting account's bill is being settled, and folio is generated
  - posting_account_id: required(integer)
    Posting Account identifier
  - transactions: (array of )
    A list of all transactions for this bill
total_count: (integer)

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Create Posting Account for the provided hotel

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(integer)
Hotel Identifier
name: required(string)
Name
account_number: (string)
Account Number
market_segment_id: (integer)
Identifier of the associated Market Segment
source_id: (integer)
Identifier of the associated Source
booking_origin_id: (integer)
Identifier of the associated Booking Origin
company_id: (integer)
Identifier of the associated Company Account
travel_agent_id: (integer)
Identifier of the associated Travel Agent Account

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (integer)
Identifier of the created Posting Account

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/posting_accounts/{id} get

get

Show the details of a posting account by its identifier.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Posting Account Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer)
Posting Account Identifier
name: required(string)
Name of the Posting Account
account_number: (string)
Account Number of the Posting Account
type: (one of HOUSE, GROUP)
Type of Posting Account
status: (one of OPEN, CLOSED)
Account Status
market_segment_id: (integer)
Identifier of the associated Market Segment
source_id: (integer)
Identifier of the associated Source
booking_origin_id: (integer)
Identifier of the associated Booking Origin
company_id: (integer)
Associated Company Account Identifier
travel_agent_id: (integer)
Associated Travel Agent Account Identifier
bills: (array of object)
The bills for this posting account
Items: AccountBill
- bill_number: required(integer)
  Bill number
- invoice_number: (String)
  Bill Invoice number
- folio_number: (String)
  Bill Folio number
- id: required(integer)
  Identifier
- settle_date: (date)
  The date where posting account's bill is being settled, and folio is generated
- posting_account_id: required(integer)
  Posting Account identifier
- transactions: (array of )
  A list of all transactions for this bill

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/posting_accounts/{id}/transactions post

post

Post transactions (charges) to the posting account

Secured by oauth_2_0

URI Parameters

id: required(integer)
Posting Account identifier
hotel_id: required(integer)
Hotel identifier
bill_number: (integer - default: 1)
Bill Number to which the charge needs to be posted (Bill needs to exist as part of the account. This is NOT an external system bill Number or other such data)

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

charge_code_id: required(integer)
Charge code identifier
amount: required(float)
Transaction amount (can be POSITIVE or NEGATIVE)
reference_text: (string)
Transaction reference text
reference_number: (string)
Check number

Example:

[
  {
    "charge_code_id": 13652,
    "amount": 55,
    "reference_text": "This is a reference text",
    "reference_number": 191919
  },
  {
    "charge_code_id": 12248,
    "amount": -35.22
  },
  {
    "charge_code_id": 28902,
    "amount": 150.11,
    "reference_number": 191919
  }
]

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/rates

/rates post

post

Create a new Rate for the provided Hotel

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(integer)
Identifier of the Hotel Object
name: required(string)
Rate name
code: required(string)
Rate code
description: required(string)
Rate description
charge_code_id: required(integer)
Charge Code identifier
currency_code: required(string)
Currency code (ISO 4217)
type_id: required(integer)
Rate type identifier
is_hourly_rate: (boolean)
Indicates if the rate is hourly based or not. (This flag is applicable only for Hourly properties)
is_day_use: (boolean)
Indicates if the rate is for day use
is_suppress_rate_on: (boolean)
Indicates if the rate should be suppressed or not
is_discount_allowed_on: (boolean)
Indicates if discount allowed or not
market_segment_id: (integer)
Market segment identifier
source_id: (integer)
Source identifier
deposit_policy_id: (integer)
Deposit Policy identifier
cancellation_policy_id: (integer)
Cancellation Policy identifier
room_type_ids: (array)
Array of room type identifiers to be linked with the rate
restrictions: (object)
Restrictions for the rate
- min_stay: (integer)
  Minimum Stay Length (days)
- max_stay: (integer)
  Maximum Stay Length (days)
- min_advanced_booking: (integer)
  Minimum Advance Booking (days)
- max_advanced_booking: (integer)
  Maximum Advance Booking (days)

Example:

{
  "hotel_id": 105,
  "name": "Rover Connect Rate",
  "code": "RCR",
  "description": "Rover Connect Rate Description",
  "charge_code_id": 92617,
  "currency_code": "USD",
  "type_id": 29,
  "is_hourly_rate": true,
  "is_day_use": true,
  "is_suppress_rate_on": true,
  "is_discount_allowed_on": true,
  "market_segment_id": 14,
  "source_id": 25,
  "deposit_policy_id": 15,
  "cancellation_policy_id": 60,
  "room_type_ids": [
    464,
    1337,
    150,
    1198
  ],
  "restrictions": {
    "min_stay": 1,
    "max_stay": 3,
    "min_advanced_booking": 4,
    "max_advanced_booking": 10
  }
}

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (Integer)
Identifier of the created Rate

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/rates/{id} get put

get

Show the details of a rate by its identifier.

put

Update a Rate for the provided Hotel

Show the details of a rate by its identifier.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Rate Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer)
Identifier
code: required(string)
Rate Code
name: required(string)
Rate Name
description: required(string)
Description
currency_code: required(string)
Currency Code
type: required(object)
Rate Type
- id: required(integer)
  Identifier
- name: required(string)
  Rate Type name
- classification: required(one of PUBLIC, CORPORATE, GROUP)
  Rate type classification
- active: required(boolean)
  Whether the rate type is active for the property
charge_code: required(object)
Charge Codes
- id: required(integer)
  Identifier
- charge_code: required(string)
  Charge Code name
- description: required(string)
  Description of charge code
- charge_code_type: required(one of TAX, PAYMENT, ADDON, OTHERS, ROOM, FEES, AR_MANUAL_BALANCE, TOURIST_TAX, AR_MANUAL_CREDIT, FNB)
  Charge Code Type Value
- amount: required(float)
  Amount for the charge code
- post_type: required(one of STAY, NIGHT, WEEKLY, EVERY_X_STARTING_Y, CERTAIN_NIGHTS, LAST_NIGHT, STAY_EXCEPT_ARRIVAL, STAY_EXCEPT_LAST, EXCLUDE_FIRST_AND_LAST, CUSTOM)
  Post Type Value
- amount_type: required(one of ADULT, CHILD, PERSON, FLAT, ROOM)
  Amount Type Value
- amount_symbol: required(one of amount, percent)
  Amount Symbol Value
based_on_rate: (object)
Based on Rate (Value requires when this rate is child or contract)
- id: required(integer)
  Identifier
- name: required(string)
  Based on Rate name
- based_on_type: (one of amount, percent)
  Based on Type (Value requires when this rate is child or contract)
- based_on_value: (string)
  Based on Value (Value requires when this rate is child or contract)
discount_allowed: (boolean)
Whether the rate is allowed discount
active: required(boolean)
Whether the rate is active for the property
tax_inclusive_or_exclusive: (one of inclusive, exclusive, multiple)
Rate Tax type
suppress_rate: (boolean)
Whether the rate is suppressed
market_segment_code: (string)
Market Segment Code
source_code: (string)
Source Code
booking_origin_code: (string)
Booking Origin Code
commissionable: (boolean)
Whether the rate is commissionable
commission_type: (string)
Commission Type (Value requires when is_commission_on is true)
commission_value: (string)
Commission value (Value requires when is_commission_on is true)
commission_post_type: (one of STAY, WEEKLY, NIGHT, EVERY_X_STARTING_Y, CERTAIN_NIGHTS, LAST_NIGHT, STAY_EXCEPT_ARRIVAL, STAY_EXCEPT_LAST, EXCLUDE_FIRST_AND_LAST, CUSTOM)
Commission post type (Value requires when is_commission_on is true)
end_date: (date-only)
Rate End Date
deposit_policy: (object)
Deposit policy for the rate
- id: required(integer)
  Identifier
- name: required(string)
  Deposit Policy name
- description: (string)
  Deposit Policy description
cancellation_policy: (object)
Cancellation policy for the rate
- id: required(integer)
  Identifier
- name: required(string)
  Cancellation Policy name
- description: (string)
  Cancellation Policy description
addons: (array of object)
Array of Rate Addons
Items: RateAddon
- id: required(integer)
  Identifier
- name: required(string)
  Addon Name
- description: required(string)
  Description of Addon
- amount: required(float)
  Addon price
- amount_type: required(one of ADULT, CHILD, FLAT, PERSON, ROOM)
  Addon price Type
- post_type: required(one of STAY, WEEKLY, NIGHT, LAST_NIGHT)
  Post Type
- post_type_description: required(one of Nightly, Every Week, First Night, Post on Last Night)
  Post Type Description
- post_days: required(array)
  List of weekdays (order according to ISO-8601 standard). Only returned when Post Type is STAY.
- charge_code_id: required(integer)
  Associated Charge Code
- charge_group_id: required(integer)
  Associated Charge Group
- currency_code: required(string)
  Associated Currency Code (ISO 4217 Format)
- included_in_rate: (boolean)
  Indicates that the add-on is included in the rate
room_types: required(object)
Array of Room Types belonging to this rate
- id: required(integer)
  Identifier
- name: required(string)
  Room Type name
hourly_rate: (boolean)
Whether the rate is hourly
fixed_rate: (boolean)
Whether the rate is fixed
public_rate: (boolean)
Whether the rate is public
member: (boolean)
Whether the rate is for member
pms_only: (boolean)
Whether the rate is for pms only
channel_only: (boolean)
Whether the rate is for channel only
prepaid_commission: (boolean)
Whether the rate is prepaid commission
rate_shown_on_guest_bill: (boolean)
Whether the rate is showing on guest bill

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Update a Rate for the provided Hotel

Secured by oauth_2_0

URI Parameters

id: required(integer)
Rate Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(integer)
Identifier of the Hotel Object
name: (string)
Rate name
code: (string)
Rate code
description: (string)
Rate description
charge_code_id: (integer)
Charge Code identifier
currency_code: (string)
Currency code (ISO 4217)
type_id: (integer)
Rate type identifier
is_hourly_rate: (boolean)
Indicates if the rate is hourly based or not. (This flag is applicable only for Hourly properties)
is_suppress_rate_on: (boolean)
Indicates if the rate should be suppressed or not
is_discount_allowed_on: (boolean)
Indicates if discount allowed or not
market_segment_id: (integer)
Market segment identifier
source_id: (integer)
Source identifier
deposit_policy_id: (integer)
Deposit Policy identifier
cancellation_policy_id: (integer)
Cancellation Policy identifier
room_type_ids: (array)
Array of room type identifiers to be linked with the rate
restrictions: (object)
Restrictions for the rate
- min_stay: (integer)
  Minimum Stay Length (days)
- max_stay: (integer)
  Maximum Stay Length (days)
- min_advanced_booking: (integer)
  Minimum Advance Booking (days)
- max_advanced_booking: (integer)
  Maximum Advance Booking (days)

Example:

{
  "hotel_id": 105,
  "name": "Rover Connect Rate",
  "code": "RCR",
  "description": "Rover Connect Rate Description",
  "charge_code_id": 92617,
  "currency_code": "USD",
  "type_id": 29,
  "is_hourly_rate": true,
  "is_day_use": true,
  "is_suppress_rate_on": true,
  "is_discount_allowed_on": true,
  "market_segment_id": 14,
  "source_id": 25,
  "deposit_policy_id": 15,
  "cancellation_policy_id": 60,
  "room_type_ids": [
    464,
    1337,
    150,
    1198
  ],
  "restrictions": {
    "min_stay": 1,
    "max_stay": 3,
    "min_advanced_booking": 4,
    "max_advanced_booking": 10
  }
}

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (Integer)
Identifier of the updated Rate

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/rates/{id}/amounts get put

get

Returns a list of rate details for a given rate and room type

put

Update amounts in the rate manager

Secured by oauth_2_0

URI Parameters

id: required(integer)
Rate Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

start_date: required(date-only)
the first date (YYYY-MM-DD) for which to change data for
end_date: required(date-only)
the date (YYYY-MM-DD) to end any changes, can be the same date as the start_date or may be as far out as start_date + 30 days
amounts: required(array of object)
an array of rates for the room type(s)
Items: items
- room_type_id: required(integer)
  Room Type Identifier(s) to be updated
- single: (float)
  the amount to charge for a single guest in the room
- double: (float)
  the amount to charge for double or two people in the room
- extra_adult: (float)
  the amount to charge for each additional adult in the room above 2
- child: (float)
  the amount to charge for each child in the room

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/rates/{id}/date_ranges get post

get

Get the paginated date ranges for the rate.

post

Create a new Date Range for the requested rate.

Get the paginated date ranges for the rate.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Rate Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: DateRange
- begin_date: required(date-only)
  Begin Date of the date range
- end_date: required(date-only)
  End Date of the date range
total_count: (integer)

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Create a new Date Range for the requested rate.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Rate Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

begin_date: required(date-only)
Begin date of the range
end_date: required(date-only)
End date of the range

Example:

{
  "begin_date": "2020-05-05",
  "end_date": "2020-05-10"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (integer)
Identifier of the created date range.

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/rates/{id}/date_ranges/{date_range_id} put get

put

Update a Date Range for the requested rate.

get

Show the details of a Date Range by its identifier.

Update a Date Range for the requested rate.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Rate Identifier
date_range_id: required(integer)
Identifier of the Date Range

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

begin_date: (date-only)
Begin date of the range
end_date: (date-only)
End date of the range

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Show the details of a Date Range by its identifier.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Rate Identifier
date_range_id: required(integer)
Identifier of the Date Range

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

begin_date: required(date-only)
Begin Date of the date range
end_date: required(date-only)
End Date of the date range

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/rates/{id}/sets get post

get

Get the paginated rate sets for the rate and date range.

post

Create a new rate set for the requested rate and date range.

Get the paginated rate sets for the rate and date range.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Rate Identifier
date_range_id: required(integer)
Date Range Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: RateSet
- id: required(integer)
  Identifier of Rate Set
- name: required(string)
  Rate Set Name
- sunday: (boolean)
  Whether the rate set available on Sunday.
- monday: (boolean)
  Whether the rate set available on Monday.
- tuesday: (boolean)
  Whether the rate set available on Tuesday.
- wednesday: (boolean)
  Whether the rate set available on Wednesday.
- thursday: (boolean)
  Whether the rate set available on Thursday.
- friday: (boolean)
  Whether the rate set available on Friday.
- saturday: (boolean)
  Whether the rate set available on Saturday.
- day_min_hours: (integer)
  Minimum hours required
- day_max_hours: (integer)
  Maximum hours allowed
- day_checkout_cutoff_time: (time-only)
  Checkout cut off for day time
- night_checkout_cutoff_time: (time-only)
  Checkout cut off for night time
- night_start_time: (time-only)
  Night start time
- night_end_time: (time-only)
  Night end time
- room_rates: (array of RoomRate)
  Room Rates information
  Items: RoomRate
  - id: (integer)
    Identifier of Room Rate
  - room_type_id: required(integer)
    Identifier of Room Type
  - single: (number)
    Amount for single occupancy
  - double: (number)
    Amount for double occupancy
  - extra_adult: (number)
    Amount for extra adult occupancy
  - child: (number)
    Amount for child occupancy
  - day_per_hour: (number)
    Increment amount for one hour during day time
  - night_per_hour: (number)
    Increment amount for one hour during night time
  - hourly_room_rates: (array of HourlyRoomRate)
    Items: HourlyRoomRate
    hour: required(integer)
    Integer representing the hour (Takes values from 0 to 23. 0 being 1st hour and 23 being the 24th hour)
    amount: required(number)
    Amount for the hour
total_count: (integer)

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Create a new rate set for the requested rate and date range.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Rate Identifier
date_range_id: required(integer)
Date Range Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

name: required(string)
Rate Set Name
sunday: (boolean)
Whether the rate set available on Sunday.
monday: (boolean)
Whether the rate set available on Monday.
tuesday: (boolean)
Whether the rate set available on Tuesday.
wednesday: (boolean)
Whether the rate set available on Wednesday.
thursday: (boolean)
Whether the rate set available on Thursday.
friday: (boolean)
Whether the rate set available on Friday.
saturday: (boolean)
Whether the rate set available on Saturday.
day_min_hours: (integer)
Minimum hours required. (Valid only for Hourly Rate)
day_max_hours: (integer)
Maximum hours allowed. (Valid only for Hourly Rate)
day_checkout_cutoff_time: (time-only)
Checkout cut off for day time. (Valid only for Hourly Rate)
night_checkout_cutoff_time: (time-only)
Checkout cut off for night time. (Valid only for Hourly Rate)
night_start_time: (time-only)
Night start time. (Valid only for Hourly Rate)
night_end_time: (time-only)
Night end time. (Valid only for Hourly Rate)
room_rates: (array of object)
Room Rates information
Items: items
- room_type_id: required(integer)
  Identifier of Room Type
- single: (number)
  Amount for single occupancy
- double: (number)
  Amount for double occupancy
- extra_adult: (number)
  Amount for extra adult occupancy
- child: (number)
  Amount for child occupancy
- day_per_hour: (number)
  Increment amount for one hour during day time. (Valid only for Hourly Rate)
- night_per_hour: (number)
  Increment amount for one hour during night time. (Valid only for Hourly Rate)
- hourly_room_rates: (array of object)
  Hourly Room Rates information. (Valid only for Hourly Rate)
  Items: items
  - hour: required(integer)
    Integer representing the hour (Takes values from 0 to 23. 0 being 1st hour and 23 being the 24th hour)
  - amount: required(number)
    Amount for the hour

Example:

{
  "name": "Test Rate Set Hourly",
  "monday": true,
  "tuesday": true,
  "wednesday": true,
  "thursday": true,
  "friday": true,
  "saturday": true,
  "sunday": true,
  "day_checkout_cutoff_time": "10:00:00",
  "night_start_time": "19:00:00",
  "night_end_time": "07:00:00",
  "night_checkout_cutoff_time": "22:00:00",
  "day_min_hours": 5,
  "day_max_hours": 10,
  "room_rates": [
    {
      "room_type_id": 173,
      "single": 100,
      "double": 120,
      "extra_adult": 50,
      "child": 90,
      "day_per_hour": 5,
      "night_per_hour": 8,
      "nightly_rate": 111,
      "hourly_room_rates": [
        {
          "hour": 0,
          "amount": 88
        },
        {
          "hour": 1,
          "amount": 88
        },
        {
          "hour": 2,
          "amount": 88
        },
        {
          "hour": 3,
          "amount": 88
        }
      ]
    }
  ]
}

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (integer)
Identifier of the created rate set.

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/rates/{id}/sets/{set_id} put get

put

Update a Rate Set for the requested rate and date range.

get

Show the details of a Rate Set by its identifier.

Update a Rate Set for the requested rate and date range.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Rate Identifier
date_range_id: required(integer)
Date Range Identifier
set_id: required(integer)
Rate Set Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

name: required(string)
Rate Set Name
sunday: (boolean)
Whether the rate set available on Sunday.
monday: (boolean)
Whether the rate set available on Monday.
tuesday: (boolean)
Whether the rate set available on Tuesday.
wednesday: (boolean)
Whether the rate set available on Wednesday.
thursday: (boolean)
Whether the rate set available on Thursday.
friday: (boolean)
Whether the rate set available on Friday.
saturday: (boolean)
Whether the rate set available on Saturday.
day_min_hours: (integer)
Minimum hours required. (Valid only for Hourly Rate)
day_max_hours: (integer)
Maximum hours allowed. (Valid only for Hourly Rate)
day_checkout_cutoff_time: (time-only)
Checkout cut off for day time. (Valid only for Hourly Rate)
night_checkout_cutoff_time: (time-only)
Checkout cut off for night time. (Valid only for Hourly Rate)
night_start_time: (time-only)
Night start time. (Valid only for Hourly Rate)
night_end_time: (time-only)
Night end time. (Valid only for Hourly Rate)
room_rates: (array of object)
Room Rates information
Items: items
- room_type_id: required(integer)
  Identifier of Room Type
- single: (number)
  Amount for single occupancy
- double: (number)
  Amount for double occupancy
- extra_adult: (number)
  Amount for extra adult occupancy
- child: (number)
  Amount for child occupancy
- day_per_hour: (number)
  Increment amount for one hour during day time. (Valid only for Hourly Rate)
- night_per_hour: (number)
  Increment amount for one hour during night time. (Valid only for Hourly Rate)
- hourly_room_rates: (array of object)
  Hourly Room Rates information. (Valid only for Hourly Rate)
  Items: items
  - hour: required(integer)
    Integer representing the hour (Takes values from 0 to 23. 0 being 1st hour and 23 being the 24th hour)
  - amount: required(number)
    Amount for the hour

Example:

{
  "name": "Test Rate Set Hourly - Update",
  "monday": true,
  "tuesday": true,
  "wednesday": true,
  "thursday": true,
  "friday": true,
  "saturday": true,
  "sunday": true,
  "day_checkout_cutoff_time": "10:00:00",
  "night_start_time": "19:00:00",
  "night_end_time": "07:00:00",
  "night_checkout_cutoff_time": "22:00:00",
  "day_min_hours": 5,
  "day_max_hours": 10,
  "room_rates": [
    {
      "room_type_id": 173,
      "single": 100,
      "double": 120,
      "extra_adult": 50,
      "child": 90,
      "day_per_hour": 5,
      "night_per_hour": 8,
      "nightly_rate": 111,
      "hourly_room_rates": [
        {
          "hour": 0,
          "amount": 88
        },
        {
          "hour": 1,
          "amount": 88
        },
        {
          "hour": 2,
          "amount": 88
        },
        {
          "hour": 3,
          "amount": 88
        }
      ]
    }
  ]
}

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Show the details of a Rate Set by its identifier.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Rate Identifier
date_range_id: required(integer)
Date Range Identifier
set_id: required(integer)
Rate Set Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer)
Identifier of Rate Set
name: required(string)
Rate Set Name
sunday: (boolean)
Whether the rate set available on Sunday.
monday: (boolean)
Whether the rate set available on Monday.
tuesday: (boolean)
Whether the rate set available on Tuesday.
wednesday: (boolean)
Whether the rate set available on Wednesday.
thursday: (boolean)
Whether the rate set available on Thursday.
friday: (boolean)
Whether the rate set available on Friday.
saturday: (boolean)
Whether the rate set available on Saturday.
day_min_hours: (integer)
Minimum hours required
day_max_hours: (integer)
Maximum hours allowed
day_checkout_cutoff_time: (time-only)
Checkout cut off for day time
night_checkout_cutoff_time: (time-only)
Checkout cut off for night time
night_start_time: (time-only)
Night start time
night_end_time: (time-only)
Night end time
room_rates: (array of RoomRate)
Room Rates information
Items: RoomRate
- id: (integer)
  Identifier of Room Rate
- room_type_id: required(integer)
  Identifier of Room Type
- single: (number)
  Amount for single occupancy
- double: (number)
  Amount for double occupancy
- extra_adult: (number)
  Amount for extra adult occupancy
- child: (number)
  Amount for child occupancy
- day_per_hour: (number)
  Increment amount for one hour during day time
- night_per_hour: (number)
  Increment amount for one hour during night time
- hourly_room_rates: (array of HourlyRoomRate)
  Items: HourlyRoomRate
  - hour: required(integer)
    Integer representing the hour (Takes values from 0 to 23. 0 being 1st hour and 23 being the 24th hour)
  - amount: required(number)
    Amount for the hour

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations

/reservations get post

get

Returns a paginated list of reservations filtered by the input parameters. Reservations for all hotels in the authorized chain are returned.

post

Create reservation for the provided hotel

Returns a paginated list of reservations filtered by the input parameters. Reservations for all hotels in the authorized chain are returned.

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier
confirmation_number: (string)
Confirmation Number
alt_confirmation_number: (string)
Alternate Confirmation Number
last_name: (string)
Last Name
departure_date: (date-only)
Departure Date (This will be deprecated in future versions)
date: (date-only)
Date (Arrival Date / Departure Date / Created Date / Updated Date)
from_date: (date-only)
The first date (YYYY-MM-DD) for which to fetch data, it can only be combined with date_filter, not date or date_operator
to_date: (date-only)
The end date (YYYY-MM-DD) for which to fetch data, it may be the same date as from_date and a maximum of +30 days. to_date can only be combined with date_filter, not date or date_operator
date_filter: (one of arrival, departure, created, updated - default: arrival)
Date Filter
date_operator: (one of eq, gte, lte - default: eq)
Date Operator
group_id: (string)
Group Identifier
credit_card_last_4: (string)
Last 4 digits of the credit card
reservation_id: (string)
Reservation Identifier
email: (string)
Email ID of the guest
no_of_nights: (integer)
Number of nights stay that reservation booked for
exclude_canceled: (boolean)
Set true to exclude all cancelled reservations
checked_in: (boolean)
Set true to list all checked_in reservations
room: (string)
Room Number assigned to the reservation
page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: ReservationExtended
- id: required(integer)
  Identifier
- hotel_id: required(integer)
  Hotel Identifier
- confirmation_number: required(string)
  Confirmation Number
- status: required(one of RESERVED, CHECKEDIN, CHECKEDOUT, NOSHOW, CANCELED)
  Current reservation status
- arrival_date: required(date-only)
  Arrival Date
- arrival_time: (time-only)
  Arrival Time
- departure_date: required(date-only)
  Departure Date
- departure_time: (time-only)
  Departure Time
- market_segment_code: (string)
  Market Segment for Reservation
- room: (object)
  Room assigned to the reservation
  - id: (integer)
    Identifier
  - number: (string)
    Room Number
  - room_type_id: (integer)
    Room Type Identifier
  - status: (one of CLEAN, INSPECTED, DIRTY, PICKUP)
    Current Housekeeping status of room
  - service_status: (one of IN_SERVICE, OUT_OF_ORDER, OUT_OF_SERVICE)
    Current service status of room
  - occupied: (boolean)
    Is the room currently occupied
  - max_occupancy: (integer)
    Maximum occupancy
  - floor: (object)
    Floor information
    - number: (string)
      Floor number
    - description: (string)
      Floor description
  - features: (array of any)
    Array of features assigned to the room
- stay_dates: (array of object)
  A breakdown of the reservation stay dates
  Items: StayDate
  - date: required(date-only)
    Date for this particular stay date record
  - id: required(integer)
    Identifier
  - amount: (float)
    The total gross amount for the stay date (net room and inclusive taxes)
  - net_amount: (float)
    Net amount for stay date, Gross amount less inclusive taxes
  - tax_amount: (float)
    Total of taxes exclusive and inclusive for the stay date
  - exclusive_tax_amount: (float)
    Total amount of any exclusive taxes for the stay date
  - inclusive_tax_amount: (float)
    Total amount of any taxes included in the amount for the stay date
  - rate_id: (integer)
    Identified for the PMS rate this reservation is associated with
  - rate_suppressed: required(boolean)
    Indicates if the reservation's rate is suppressed. If the value is TRUE it is imperative that external systems do NOT provide the guest any rate amount data as it should be hidden from the guest.
  - room_type_id: required(integer)
    Room Type Identifier
  - adults: required(integer)
    Adults Count
  - children: (integer)
    Children Count
  - infants: (integer)
    Infants Count
  - room: (Room)
    Room assigned to this reservation
  - group: (array of object)
    Group information
    Items: items
    id: required(Integer)
    Group Identifier
    name: required(Integer)
    name of the group
    code: (Integer)
    group code attached to the stay date
  - allotment: (array of object)
    allotment information
    Items: items
    id: required(Integer)
    allotment Identifier
    name: required(Integer)
    name of the allotment
    code: (Integer)
    group code attached to the stay date
  - original_room_type_id: required(Integer)
    Identifier for the original room type
- guests: (array of object)
  A list of the guest information
  Items: Guest
  - id: required(integer)
    Identifier
  - is_primary: (boolean)
    Is Primary Guest(Returned only when the object belongs to the Reservation object)
  - first_name: (string)
    Guest's First name
  - last_name: required(string)
    Guest's Last Name
  - email: (string)
    Guest's Email address
  - address: (object)
    Guest's address
    id: required(integer)
    Identifier
    address_line1: (string)
    Address 1
    address_line2: (string)
    Address 2
    address_line3: (string)
    Address 3
    city: (string)
    City Name
    state: (string)
    State Name
    postal_code: (string)
    Postal Code
    country_code: (string)
    Country Code (ISO 3166-1 alpha-2)
  - birthday: (date-only)
    Guest's birthday
  - is_vip: required(boolean)
    Is VIP Guest
  - title: (string)
    Guest's Title
  - works_at: (string)
    Guest's Company
  - job_title: (string)
    Guest's Job Title
  - nationality: (string)
    Guest's Nationality Country Code (ISO)
  - home_phone: (string)
    Guest's home phone number
  - language: (string)
    Guest's language. ISO 639-1
  - opted_promotional_emails: required(boolean)
    Opted for promotional emails
  - mobile_phone: (string)
    Guest's mobile number
  - is_flagged: (boolean)
    Is flagged guest
  - flagged_reason: (string)
    Reason guest was flagged. Only returned when value is present.
  - memberships: (array of GuestMembership)
    Guest Memberships
    Items: GuestMembership
    id: required(integer)
    Guest membership identifier
    code: (string)
    Membership program code
    membership_id: required(string)
    Membership Identifier
    type: required(one of FFP, HLP)
    Membership Program Type - Frequent Flyer Program or Hotel Loyalty Program
    level: (object)
    Membership Level Details
    id: (integer)
    Membership level identifier
    name: (string)
    Membership level name
  - likes: (array of object)
    Likes
    Items: items
    category: (string)
    category
    names: (array of string)
    Array of likes
- company: (object)
  Company
  - id: required(integer)
    Identifier
  - account_number: (string)
    Unique number for Company/Travel agent
  - type: required(one of COMPANY, TRAVELAGENT)
    A type of the account
  - name: required(string)
    A name of Company/Travel agent
  - address: (object)
    Account address
    - id: required(integer)
      Identifier
    - address_line1: (string)
      Address 1
    - address_line2: (string)
      Address 2
    - address_line3: (string)
      Address 3
    - city: (string)
      City Name
    - state: (string)
      State Name
    - postal_code: (string)
      Postal Code
    - country_code: (string)
      Country Code (ISO 3166-1 alpha-2)
  - ar_number: (string)
    Account receivable number
  - hotel_id: required(integer)
    Hotel identifier
  - is_global: required(boolean)
    A flag indicating if the Account is global or not
  - tax_number: (string)
    A tax id number
  - phone: (string)
    The Phone number.
  - fax: (string)
    The Fax number.
  - email: (string)
    The Email address.
  - web_page: (string)
    The web_page link.
  - commision: (object)
    For travel agents if the system needs to calculate a commission on items to be paid to the agency. Can be a % of the transaction or a fixed amount.
    - on: (boolean)
      A flag indicating if the commission is enabled or not.
    - type: (string)
      The commision type can be "percent" or "amount".
    - value: (string)
      The amount value or percent value based on the type selected.
  - primary_contact: (object)
    The main contact person for the agency or company.
    - first_name: (string)
      The first name of main contact person.
    - last_name: (string)
      The last name of main contact person.
    - job_title: (string)
      The job title of main contact person.
    - phone: (string)
      The phone number of main contact person.
    - email: (string)
      The email address of main contact person.
- travel_agent: (object)
  Travel agent
  - id: required(integer)
    Identifier
  - account_number: (string)
    Unique number for Company/Travel agent
  - type: required(one of COMPANY, TRAVELAGENT)
    A type of the account
  - name: required(string)
    A name of Company/Travel agent
  - address: (object)
    Account address
    - id: required(integer)
      Identifier
    - address_line1: (string)
      Address 1
    - address_line2: (string)
      Address 2
    - address_line3: (string)
      Address 3
    - city: (string)
      City Name
    - state: (string)
      State Name
    - postal_code: (string)
      Postal Code
    - country_code: (string)
      Country Code (ISO 3166-1 alpha-2)
  - ar_number: (string)
    Account receivable number
  - hotel_id: required(integer)
    Hotel identifier
  - is_global: required(boolean)
    A flag indicating if the Account is global or not
  - tax_number: (string)
    A tax id number
  - phone: (string)
    The Phone number.
  - fax: (string)
    The Fax number.
  - email: (string)
    The Email address.
  - web_page: (string)
    The web_page link.
  - commision: (object)
    For travel agents if the system needs to calculate a commission on items to be paid to the agency. Can be a % of the transaction or a fixed amount.
    - on: (boolean)
      A flag indicating if the commission is enabled or not.
    - type: (string)
      The commision type can be "percent" or "amount".
    - value: (string)
      The amount value or percent value based on the type selected.
  - primary_contact: (object)
    The main contact person for the agency or company.
    - first_name: (string)
      The first name of main contact person.
    - last_name: (string)
      The last name of main contact person.
    - job_title: (string)
      The job title of main contact person.
    - phone: (string)
      The phone number of main contact person.
    - email: (string)
      The email address of main contact person.
- upsell_applied: (boolean)
  Upsell Applied
- early_check_in_applied: (boolean)
  Is early_check_in applied
- late_check_out_applied: (boolean)
  Is late_check_out applied
- addons: (array of object)
  A list of addons
  Items: ReservationAddon
  - id: required(integer)
    Identifier
  - name: required(string)
    Addon Name
  - description: required(string)
    Description of Addon
  - amount: required(float)
    Addon price
  - amount_type: required(one of ADULT, CHILD, FLAT, PERSON, ROOM)
    Addon price Type
  - post_type: required(one of STAY, WEEKLY, NIGHT, LAST_NIGHT)
    Post Type
  - post_type_description: required(one of Nightly, Every Week, First Night, Post on Last Night)
    Post Type Description
  - post_days: required(array)
    List of weekdays (order according to ISO-8601 standard). Only returned when Post Type is STAY.
  - quantity: required(integer)
    Number of addons associated with the reservation
  - charge_code_id: required(integer)
    Associated Charge Code
  - charge_group_id: required(integer)
    Associated Charge Group
  - currency_code: required(string)
    Associated Currency Code (ISO 4217 Format)
  - included_in_rate: (boolean)
    Indicates that the add-on is included in the rate
- bills: (array of object)
  The bills for this reservation
  Items: ReservationBill
  - bill_number: required(integer)
    Bill number
  - invoice_number: (String)
    Bill Invoice number
  - folio_number: (String)
    Bill Folio number
  - id: required(integer)
    Identifier
  - settle_date: (date)
    The date where guest's bill is being settled, and folio is generated
  - reservation_id: required(integer)
    Reservation identifier
  - transactions: (array of )
    A list of all transactions for this bill
- booking_origin_code: (String)
  The origin of the reservation
- created_time: required(datetime)
  Created time
- currency_code: required(String)
  Hotel Currency Code
- deposit_amount: (float)
  Deposit Amount paid
- guarantee_code: (string)
  Guarantee code selected for reservation
- notes: (array of object)
  Reservation notes
  Items: items
  - description: required(Text)
    Reservation note description
  - type: (string)
    Reservation note type
- promotion_code: (String)
  Promotion Code
- reservation_type_code: (one of 4PM_HOLD, 6PM_HOLD, COMPANY_GUARANTEED, CREDIT_CARD_GUARANTEED, DEPOSIT_RECEIVED, DEPOSIT_REQUESTED, HOUSE_USE, NOT_GUARANTEED, PAYMENT_GUARANTEED, TRAVEL_AGENT_GUARANTEED)
  Reservation Type Code
- segment_code: (String)
  Segment Code
- source_code: (String)
  Source Code
- tax_exempt: (Boolean)
  Is the reservation tax exempted or not
- cancel_date: (date-only)
  Date of cancelation if reservation has been canceled
- updated_time: required(date-only)
  Date of the last update made to reservation
- creator: (array of object)
  Creator information
  Items: items
  - id: required(Integer)
    Creator user Identifier
  - login: required(String)
    login of the Creator
- restrict_post: (Boolean)
  Determines whether postings are permitted for a reservation or not
- do_not_move: (Boolean)
  Indicates a reservation that is blocked in a specific room and is prevented from being moved to an alternate room without approval in the system (these rooms may not be moved for upgrades etc.)
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Create reservation for the provided hotel

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(integer)
Hotel Identifier
arrival_date: required(date-only)
Arrival Date
arrival_time: (time-only)
Arrival Time
departure_date: required(date-only)
Departure Date
departure_time: (time-only)
Departure Time
group_id: (integer)
Group Identifier - if present, rate_id is not required and the reservation will use the group rate
stay_dates: (array of object)
Reservation Stay Dates
Items: items
- date: required(date-only)
  Date
- rate_id: required(integer)
  Rate Identifier
- room_type_id: required(integer)
  Room Type Identifier
- adults: (integer)
  Adults Count
- children: (integer)
  Children Count
- infants: (integer)
  Infants Count
- amount: (number)
  Allows at the creation of booking to set in an amount for the rate to use, this may be a value that is different than what is currently configured for the date - this is generally ONLY used for data transfer from one PMS to another.
guests: (array of object)
Guests
Items: items
- id: (string)
  Guest Identifier
- is_primary: (boolean)
  Is Primary
- first_name: (string)
  First Name
- last_name: (string)
  Last Name
- email: (string)
  Email
company: (object)
Company
- id: (integer)
  Identifier
- account_number: required(string)
  Account Number
travel_agent: (object)
Travel agent
- id: (integer)
  Identifier
- account_number: required(string)
  Account Number
addons: (array of object)
Addons set for the reservation
Items: items
- id: required(integer)
  Addon Identifier
- quantity: required(integer)
  Number of addons opted for the reservation
booking_origin_code: (String)
Booking Origin Code
promotion_code: (String)
Promotion Code
reservation_type_code: (String)
Reservation Type Code
segment_code: (String)
Segment Code
source_code: (String)
Source Code
market_segment_code: (String)
Used by hotels for reporting and booking classification
booker_email: (String)
Hotel informational field of email address for who booked reservation - does NOT send confirmation to this address
notes: (array of object)
Reservation notes
Items: items
- description: required(string)
  Note description
references: (array of object)
An array containing data for connections to CRS or other such systems. Allowing data to be entered and passed on for connection to the CRS for later updates or modifications.
Items: items
- value: required(string)
  The external system number, such as a confirmation number or other system number
- type: required(string)
  The type of value is being sent - currently, the only value to send here is “confirmation_number"
- interface: required(string)
  The interface system that number is from. The following is a listing of system names that are available for use - (siteminder, synxis, direct, travetripper, windsurfer, ibe, travelclick, culilis, verticalbooking, staah, dedge, or opera). For a previous system transfer we suggest using opera.
- primary: required(boolean)
  If listed as primary, this number will show on guest display listings in the UI
- description: required(string)
  Any further description of the reference as desired

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(Integer)
Reservation Identifier

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id} put get

put

Update reservation by its identifier

get

Show the details of a reservation by its identifier.

Update reservation by its identifier

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

arrival_date: required(date-only)
Arrival Date
arrival_time: (time-only)
Arrival Time
departure_date: required(date-only)
Departure Date
departure_time: (time-only)
Departure Time
stay_dates: (array of object)
Reservation Stay Dates
Items: items
- date: required(date-only)
  Date
- rate_id: required(integer)
  Rate Identifier
- room_type_id: required(integer)
  Room Type Identifier
- adults: (integer)
  Adults Count
- children: (integer)
  Children Count
- infants: (integer)
  Infants Count
guests: (array of object)
Guests
Items: items
- id: (string)
  Guest Identifier
- is_primary: (boolean)
  Is Primary
- first_name: (string)
  First Name
- last_name: (string)
  Last Name
- email: (string)
  Email
company: (object)
Company
- id: (integer)
  Identifier
- account_number: required(string)
  Account Number
travel_agent: (object)
Travel agent
- id: (integer)
  Identifier
- account_number: required(string)
  Account Number
addons: (array of object)
Addons set for the reservation
Items: items
- id: required(integer)
  Addon Identifier
- quantity: required(integer)
  Number of addons opted for the reservation
booking_origin_code: (String)
Booking Origin Code
promotion_code: (String)
Promotion Code
reservation_type_code: (String)
Reservation Type Code
segment_code: (String)
Segment Code
notes: (array of object)
Reservation notes
Items: items
- description: required(string)
  Note description
do_not_move: (boolean)
Set a reservation blocked in a specific room, it will be prevented from being moved to an alternate room without approval in the system.

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer)
Reservation Identifier

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Show the details of a reservation by its identifier.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required(integer)
Identifier
hotel_id: required(integer)
Hotel Identifier
confirmation_number: required(string)
Confirmation Number
status: required(one of RESERVED, CHECKEDIN, CHECKEDOUT, NOSHOW, CANCELED)
Current reservation status
arrival_date: required(date-only)
Arrival Date
arrival_time: (time-only)
Arrival Time
departure_date: required(date-only)
Departure Date
departure_time: (time-only)
Departure Time
market_segment_code: (string)
Market Segment for Reservation
room: (object)
Room assigned to the reservation
- id: (integer)
  Identifier
- number: (string)
  Room Number
- room_type_id: (integer)
  Room Type Identifier
- status: (one of CLEAN, INSPECTED, DIRTY, PICKUP)
  Current Housekeeping status of room
- service_status: (one of IN_SERVICE, OUT_OF_ORDER, OUT_OF_SERVICE)
  Current service status of room
- occupied: (boolean)
  Is the room currently occupied
- max_occupancy: (integer)
  Maximum occupancy
- floor: (object)
  Floor information
  - number: (string)
    Floor number
  - description: (string)
    Floor description
- features: (array of any)
  Array of features assigned to the room
stay_dates: (array of object)
A breakdown of the reservation stay dates
Items: StayDate
- date: required(date-only)
  Date for this particular stay date record
- id: required(integer)
  Identifier
- amount: (float)
  The total gross amount for the stay date (net room and inclusive taxes)
- net_amount: (float)
  Net amount for stay date, Gross amount less inclusive taxes
- tax_amount: (float)
  Total of taxes exclusive and inclusive for the stay date
- exclusive_tax_amount: (float)
  Total amount of any exclusive taxes for the stay date
- inclusive_tax_amount: (float)
  Total amount of any taxes included in the amount for the stay date
- rate_id: (integer)
  Identified for the PMS rate this reservation is associated with
- rate_suppressed: required(boolean)
  Indicates if the reservation's rate is suppressed. If the value is TRUE it is imperative that external systems do NOT provide the guest any rate amount data as it should be hidden from the guest.
- room_type_id: required(integer)
  Room Type Identifier
- adults: required(integer)
  Adults Count
- children: (integer)
  Children Count
- infants: (integer)
  Infants Count
- room: (Room)
  Room assigned to this reservation
- group: (array of object)
  Group information
  Items: items
  - id: required(Integer)
    Group Identifier
  - name: required(Integer)
    name of the group
  - code: (Integer)
    group code attached to the stay date
- allotment: (array of object)
  allotment information
  Items: items
  - id: required(Integer)
    allotment Identifier
  - name: required(Integer)
    name of the allotment
  - code: (Integer)
    group code attached to the stay date
- original_room_type_id: required(Integer)
  Identifier for the original room type
guests: (array of object)
A list of the guest information
Items: Guest
- id: required(integer)
  Identifier
- is_primary: (boolean)
  Is Primary Guest(Returned only when the object belongs to the Reservation object)
- first_name: (string)
  Guest's First name
- last_name: required(string)
  Guest's Last Name
- email: (string)
  Guest's Email address
- address: (object)
  Guest's address
  - id: required(integer)
    Identifier
  - address_line1: (string)
    Address 1
  - address_line2: (string)
    Address 2
  - address_line3: (string)
    Address 3
  - city: (string)
    City Name
  - state: (string)
    State Name
  - postal_code: (string)
    Postal Code
  - country_code: (string)
    Country Code (ISO 3166-1 alpha-2)
- birthday: (date-only)
  Guest's birthday
- is_vip: required(boolean)
  Is VIP Guest
- title: (string)
  Guest's Title
- works_at: (string)
  Guest's Company
- job_title: (string)
  Guest's Job Title
- nationality: (string)
  Guest's Nationality Country Code (ISO)
- home_phone: (string)
  Guest's home phone number
- language: (string)
  Guest's language. ISO 639-1
- opted_promotional_emails: required(boolean)
  Opted for promotional emails
- mobile_phone: (string)
  Guest's mobile number
- is_flagged: (boolean)
  Is flagged guest
- flagged_reason: (string)
  Reason guest was flagged. Only returned when value is present.
- memberships: (array of GuestMembership)
  Guest Memberships
  Items: GuestMembership
  - id: required(integer)
    Guest membership identifier
  - code: (string)
    Membership program code
  - membership_id: required(string)
    Membership Identifier
  - type: required(one of FFP, HLP)
    Membership Program Type - Frequent Flyer Program or Hotel Loyalty Program
  - level: (object)
    Membership Level Details
    id: (integer)
    Membership level identifier
    name: (string)
    Membership level name
- likes: (array of object)
  Likes
  Items: items
  - category: (string)
    category
  - names: (array of string)
    Array of likes
company: (object)
Company
- id: required(integer)
  Identifier
- account_number: (string)
  Unique number for Company/Travel agent
- type: required(one of COMPANY, TRAVELAGENT)
  A type of the account
- name: required(string)
  A name of Company/Travel agent
- address: (object)
  Account address
  - id: required(integer)
    Identifier
  - address_line1: (string)
    Address 1
  - address_line2: (string)
    Address 2
  - address_line3: (string)
    Address 3
  - city: (string)
    City Name
  - state: (string)
    State Name
  - postal_code: (string)
    Postal Code
  - country_code: (string)
    Country Code (ISO 3166-1 alpha-2)
- ar_number: (string)
  Account receivable number
- hotel_id: required(integer)
  Hotel identifier
- is_global: required(boolean)
  A flag indicating if the Account is global or not
- tax_number: (string)
  A tax id number
- phone: (string)
  The Phone number.
- fax: (string)
  The Fax number.
- email: (string)
  The Email address.
- web_page: (string)
  The web_page link.
- commision: (object)
  For travel agents if the system needs to calculate a commission on items to be paid to the agency. Can be a % of the transaction or a fixed amount.
  - on: (boolean)
    A flag indicating if the commission is enabled or not.
  - type: (string)
    The commision type can be "percent" or "amount".
  - value: (string)
    The amount value or percent value based on the type selected.
- primary_contact: (object)
  The main contact person for the agency or company.
  - first_name: (string)
    The first name of main contact person.
  - last_name: (string)
    The last name of main contact person.
  - job_title: (string)
    The job title of main contact person.
  - phone: (string)
    The phone number of main contact person.
  - email: (string)
    The email address of main contact person.
travel_agent: (object)
Travel agent
- id: required(integer)
  Identifier
- account_number: (string)
  Unique number for Company/Travel agent
- type: required(one of COMPANY, TRAVELAGENT)
  A type of the account
- name: required(string)
  A name of Company/Travel agent
- address: (object)
  Account address
  - id: required(integer)
    Identifier
  - address_line1: (string)
    Address 1
  - address_line2: (string)
    Address 2
  - address_line3: (string)
    Address 3
  - city: (string)
    City Name
  - state: (string)
    State Name
  - postal_code: (string)
    Postal Code
  - country_code: (string)
    Country Code (ISO 3166-1 alpha-2)
- ar_number: (string)
  Account receivable number
- hotel_id: required(integer)
  Hotel identifier
- is_global: required(boolean)
  A flag indicating if the Account is global or not
- tax_number: (string)
  A tax id number
- phone: (string)
  The Phone number.
- fax: (string)
  The Fax number.
- email: (string)
  The Email address.
- web_page: (string)
  The web_page link.
- commision: (object)
  For travel agents if the system needs to calculate a commission on items to be paid to the agency. Can be a % of the transaction or a fixed amount.
  - on: (boolean)
    A flag indicating if the commission is enabled or not.
  - type: (string)
    The commision type can be "percent" or "amount".
  - value: (string)
    The amount value or percent value based on the type selected.
- primary_contact: (object)
  The main contact person for the agency or company.
  - first_name: (string)
    The first name of main contact person.
  - last_name: (string)
    The last name of main contact person.
  - job_title: (string)
    The job title of main contact person.
  - phone: (string)
    The phone number of main contact person.
  - email: (string)
    The email address of main contact person.
upsell_applied: (boolean)
Upsell Applied
early_check_in_applied: (boolean)
Is early_check_in applied
late_check_out_applied: (boolean)
Is late_check_out applied
addons: (array of object)
A list of addons
Items: ReservationAddon
- id: required(integer)
  Identifier
- name: required(string)
  Addon Name
- description: required(string)
  Description of Addon
- amount: required(float)
  Addon price
- amount_type: required(one of ADULT, CHILD, FLAT, PERSON, ROOM)
  Addon price Type
- post_type: required(one of STAY, WEEKLY, NIGHT, LAST_NIGHT)
  Post Type
- post_type_description: required(one of Nightly, Every Week, First Night, Post on Last Night)
  Post Type Description
- post_days: required(array)
  List of weekdays (order according to ISO-8601 standard). Only returned when Post Type is STAY.
- quantity: required(integer)
  Number of addons associated with the reservation
- charge_code_id: required(integer)
  Associated Charge Code
- charge_group_id: required(integer)
  Associated Charge Group
- currency_code: required(string)
  Associated Currency Code (ISO 4217 Format)
- included_in_rate: (boolean)
  Indicates that the add-on is included in the rate
bills: (array of object)
The bills for this reservation
Items: ReservationBill
- bill_number: required(integer)
  Bill number
- invoice_number: (String)
  Bill Invoice number
- folio_number: (String)
  Bill Folio number
- id: required(integer)
  Identifier
- settle_date: (date)
  The date where guest's bill is being settled, and folio is generated
- reservation_id: required(integer)
  Reservation identifier
- transactions: (array of )
  A list of all transactions for this bill
booking_origin_code: (String)
The origin of the reservation
created_time: required(datetime)
Created time
currency_code: required(String)
Hotel Currency Code
deposit_amount: (float)
Deposit Amount paid
guarantee_code: (string)
Guarantee code selected for reservation
notes: (array of object)
Reservation notes
Items: items
- description: required(Text)
  Reservation note description
- type: (string)
  Reservation note type
promotion_code: (String)
Promotion Code
reservation_type_code: (one of 4PM_HOLD, 6PM_HOLD, COMPANY_GUARANTEED, CREDIT_CARD_GUARANTEED, DEPOSIT_RECEIVED, DEPOSIT_REQUESTED, HOUSE_USE, NOT_GUARANTEED, PAYMENT_GUARANTEED, TRAVEL_AGENT_GUARANTEED)
Reservation Type Code
segment_code: (String)
Segment Code
source_code: (String)
Source Code
tax_exempt: (Boolean)
Is the reservation tax exempted or not
cancel_date: (date-only)
Date of cancelation if reservation has been canceled
updated_time: required(date-only)
Date of the last update made to reservation
creator: (array of object)
Creator information
Items: items
- id: required(Integer)
  Creator user Identifier
- login: required(String)
  login of the Creator
restrict_post: (Boolean)
Determines whether postings are permitted for a reservation or not
do_not_move: (Boolean)
Indicates a reservation that is blocked in a specific room and is prevented from being moved to an alternate room without approval in the system (these rooms may not be moved for upgrades etc.)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/cancel post

post

Cancel the reservation.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

reason: (text)
send_cancellation_email: (boolean - default: false)
refund_deposit: (boolean - default: false)
charge_penalty: (boolean - default: false)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

status: required(boolean)
errors: (array)

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/check_in post

post

Check in the reservation.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

queue_when_not_ready: (boolean - default: false)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

room: required(object)
Room
- id: (integer)
  Identifier
- number: (string)
  Room Number
- room_type_id: (integer)
  Room Type Identifier
- status: (one of CLEAN, INSPECTED, DIRTY, PICKUP)
  Current Housekeeping status of room
- service_status: (one of IN_SERVICE, OUT_OF_ORDER, OUT_OF_SERVICE)
  Current service status of room
- occupied: (boolean)
  Is the room currently occupied
- max_occupancy: (integer)
  Maximum occupancy
- floor: (object)
  Floor information
  - number: (string)
    Floor number
  - description: (string)
    Floor description
- features: (array of any)
  Array of features assigned to the room
queue_position: (integer)
Queue Position
pre_checked_in_at: (time)
Pre-Checkedin-Time
status: (string)
Reservation Status
warnings: (array)
Warnings

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/check_out post

post

Check out the reservation.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/notes get post

get

Get the paginated notes for the reservation.

post

Post notes to the reservation

Get the paginated notes for the reservation.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: Note
- id: (integer)
  Identifier
- description: (string)
  Description
- created_at: (datetime-only)
  Created at timestamp
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Post notes to the reservation

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

notes: (array of object)
Reservation notes
Items: items
- description: required(string)
  Note description

Example:

{
  "notes": [
    {
      "description": "Test Desc 1"
    },
    {
      "description": "Test Desc 2"
    },
    {
      "description": "Test Desc 3"
    }
  ]
}

HTTP status code 200

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/payment_methods post

post

Add a payment method to the reservation. Card number or token is required.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

code: required(string)
Payment Type Code
card_number: required(string)
Card Number
token: (string)
Token characters. For ADYEN this is the`recurringDetailReference'.
expiry_date: required(string)
Expiry Date (YYYY-MM)
card_name: (string)
The card holder's name as it appears on the card.
masked_card_number: (string)
Last 4 digits of the card.
transaction_id: (string)
A transaction id for the payment can be stored. For ADYEN it is a mandatory field and it must be the ‘ShopperReference’ string.

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/pre_check_in post

post

Pre check in the reservation.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

arrival_time: required(time-only HH:MM AM/PM)
Arrival Time
note: (string)
Note

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

queue_position: (integer)
Queue Position
pre_checked_in_at: required(datetime)
Pre-Checkedin-Time

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/queue_details get

get

Get the queue details for the reservation within its room type.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

queue_position: (integer)
Reservation Queue Position
queue_count: (integer)
Queued Reservation Count
available_count: (integer)
Available Room Count

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/record_cc_payment post

post

Record a credit card payment for the reservation's payment method by creating a financial transaction. Payment method must be a credit card. Assumes the payment has already been posted to a payment gateway.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

amount: required(string)
Amount
authorization_code: required(string)
Authorization Code
reference_text: required(string)
Reference Text
code: required(string)
Payment Type Code
card_number: (string)
Card Number
token: (string)
Token
expiry_date: required(string)
Expiry Date (YYYY-MM)
cvv: (string)
CVV
card_name: (string)
Card Name
attach_cc_to_reservation: (boolean - default: true)
Attach credit card to reservation
transaction_id: (string)
We can store the transaction id for this payment. For Adyen, this would be the ShopperReference string.
req_reference_no: (string)
A transaction reference number provided by the payment gateway. For Adyen, this would be the PSPReference.

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/restrict_post post

post

Apply restrict_post flag in the reservation.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

value: required(boolean - default: false)

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/room_key get

get

Get the room key details for the reservation.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

type: (one of qr-code-data, information)
Room Key Type
data: (string)
Room Key Data

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/upsell_room_type post

post

Set the upsold room type on the reservation. Either the room_type_id or room_id must be provided.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

room_type_id: (integer)
Room Type Identifier
room_id: (integer)
Room Type Identifier

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/upsell_room_type_options get

get

Get the room types available for upsell for the reservation.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

allowed: (boolean)
Upsell Allowed or Not
results: (array of object)
Items: UpsellRoomTypeOption
- id: (integer)
  Room Type Identifier
- amount: (string)
  Room Type Upsell Amount
warnings: (array)
Warnings

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/revenue get

get

Returns revenue posted on a reservation grouped by date per charge type.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: RevenueDetail
- date: (date-only)
  Date on which the revenue posted
- revenue: (array of object)
  Revenue Details of the reservation per Charge Code Type
  Items: items
  - amount: required(float)
    Amount posted on the reservation based on Charge Code Type
  - currency_code: (string)
    Currency Code
  - charge_type: required(one of ADDON, ALLOWANCE, F & B, FEES, OTHERS, ROOM, TAX, TOURIST TAX)
    Charge Code Type
  - charge_codes: required(object)
    id: required(integer)
    Charge code identifier
    code: required(string)
    Charge code
    description: required(string)
    Charge code description
    amount: required(float)
    Amount

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/transactions post

post

Post transactions (charges) to the reservation

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier
bill_number: (integer - default: 1)
Bill Number to which the charge needs to be posted (Bill needs to exist as part of the reservation. This is NOT an external system bill Number or other such data)

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

charge_code_id: required(integer)
Charge code identifier
amount: required(float)
Transaction amount (can be POSITIVE or NEGATIVE)
reference_text: (string)
Transaction reference text
reference_number: (string)
Check number

Example:

[
  {
    "charge_code_id": 13652,
    "amount": 55,
    "reference_text": "This is a reference text",
    "reference_number": 191919
  },
  {
    "charge_code_id": 12248,
    "amount": -35.22
  },
  {
    "charge_code_id": 28902,
    "amount": 150.11,
    "reference_number": 191919
  }
]

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/confirm_letter post

post

Trigger confirmation letter to the primary guest and/or to the provided emails

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

emails: (array)
List of emails to which the confirmation letter is to be sent

Example:

[
  "john.smith@test.com",
  "john.snow@test.com"
]

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/cancel_letter post

post

Trigger cancellation letter to the primary guest and/or to the provided emails

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

emails: (array)
List of emails to which the cancellation letter is to be sent

Example:

[
  "john.smith@test.com",
  "john.snow@test.com"
]

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/assign_room put

put

Assign room to the reservation.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

room_id: required(integer)

Example:

{
  "room_id": 12345
}

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/external_references get

get

Get the external references for a reservation.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (integer)
Identifier
hotel_id: (integer)
Hotel Identifier
confirmation_number: (string)
Confirmation Number
status: (one of RESERVED, CHECKEDIN, CHECKEDOUT, NOSHOW, CANCELED)
Current reservation status
arrival_date: (date-only)
Arrival Date
departure_date: (date-only)
Departure Date
created_date: (date-only)
Created date
updated_date: (date-only)
Updated date
external_references: (array of object)
External References Information
Items: items
- value: (string)
  Reference value
- description: (integer)
  Reference description
- type: (string)
  Reference type
- interface: (integer)
  Related interface
- primary: (integer)
  Determines if a reference is primary to the reservation or not.

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/external_reference post

post

This API allows the vendor to save 3 values in PMS; Verified status, Guest Portal Completed and Room PIN, one value at the time. Contact Implementation team to activate the setting to display these fields in reservation screen.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

key: required(one of VERIFIED_STATUS, GUEST_PORTAL_COMPLETED or ROOM_PIN)
Reference Type
value: required(String)
Reference Value

HTTP status code 204

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/external_reference/{external_reference_key} delete

delete

Delete the external references of a reservation by its external_reference key

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier
external_reference_key: required(String)
External Reference Key(VERIFIED_STATUS, GUEST_PORTAL_COMPLETED or ROOM_PIN)
Example:
```
connect/reservations/:id/external_reference/verified_status
```

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

HTTP status code 204

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/deposits get

get

Get the deposit details of a reservation.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (integer)
The deposit policy identifier attached to the booking
name: (string)
The name of the deposit policy
amount_owed: (number)
The current amount due
amount_paid: (number)
The deposit amount already paid
due_dates: (array of object)
Array of due dates and amounts
Items: items
- date: (date)
  Due date of deposit
- amount: (number)
  Amount due on the date

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/{id}/selected_payment_method get

get

Get the selected Payment Method of the reservation.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Reservation Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

code: required(string)
Payment Type Code
expiry_date: (string)
Expiry Date (YYYY-MM)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/reservations/summary get

get

Returns a paginated list of reservation summary filtered by the input parameters. This will the smaller version of GET /reservations API.

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier
date: (date-only)
Date (Arrival Date / Departure Date / Created Date / Updated Date)
from_date: (date-only)
The first date (YYYY-MM-DD) for which to fetch data, it can only be combined with date_filter, not date or date_operator
to_date: (date-only)
The end date (YYYY-MM-DD) for which to fetch data, it may be the same date as from_date and a maximum of +30 days. to_date can only be combined with date_filter, not date or date_operator
date_filter: (one of arrival, departure, created, updated - default: arrival)
Date Filter
date_operator: (one of eq, gte, lte - default: eq)
Date Operator
status: (one of RESERVED, CHECKEDIN, CHECKEDOUT, NOSHOW, CANCELED)
Reservation Status
page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: ReservationSummary
- id: (integer)
  Identifier
- hotel_id: (integer)
  Hotel Identifier
- confirmation_number: (string)
  Confirmation Number
- status: (one of RESERVED, CHECKEDIN, CHECKEDOUT, NOSHOW, CANCELED)
  Current reservation status
- arrival_date: (date-only)
  Arrival Date
- arrival_time: (time-only)
  Arrival Time
- departure_date: (date-only)
  Departure Date
- departure_time: (time-only)
  Departure Time
- rate_id: (integer)
  Identifier of the Rate assigned to the reservation
- room_type_id: (integer)
  Identifier of the Room Type assigned to the reservation
- room_id: (integer)
  Identifier of the Room assigned to the reservation
- group_id: (integer)
  Identifier of the Group assigned to the reservation
- market_segment_id: (integer)
  Identifier of Market Segment for Reservation
- source_id: (integer)
  Identifier of Source for Reservation
- guest_id: (integer)
  Identifier of primary guest for Reservation
- first_name: (string)
  Guest First Name
- last_name: (string)
  Guest Last Name
- company_id: (integer)
  Company Identifier
- travel_agent_id: (integer)
  Travel agent Identifier
- created_date: (date-only)
  Created date
- updated_date: (date-only)
  Updated date
- cancel_date: (date-only)
  Date of cancelation if reservation has been canceled
- creator: (object)
  Creator information
  - id: (Integer)
    Creator user Identifier
  - login: (String)
    login of the Creator
- updater: (object)
  Updater information
  - id: (Integer)
    Updater user Identifier
  - login: (String)
    login of the Updator
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/rooms

/rooms get

get

Returns a paginated list of rooms filtered by the input parameters. Rooms of requested hotel is returned.

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier
page: (integer - default: 1)
Specify the page that you want to retrieve
per_page: (integer - default: 25)
The number of results per page, maximum 50

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: (array of object)
Items: Room
- id: (integer)
  Identifier
- number: (string)
  Room Number
- room_type_id: (integer)
  Room Type Identifier
- status: (one of CLEAN, INSPECTED, DIRTY, PICKUP)
  Current Housekeeping status of room
- service_status: (one of IN_SERVICE, OUT_OF_ORDER, OUT_OF_SERVICE)
  Current service status of room
- occupied: (boolean)
  Is the room currently occupied
- max_occupancy: (integer)
  Maximum occupancy
- floor: (object)
  Floor information
  - number: (string)
    Floor number
  - description: (string)
    Floor description
- features: (array of any)
  Array of features assigned to the room
total_count: (integer)

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/rooms/{id} get

get

Show the details of a room by its identifier.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Room Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (integer)
Identifier
number: (string)
Room Number
room_type_id: (integer)
Room Type Identifier
status: (one of CLEAN, INSPECTED, DIRTY, PICKUP)
Current Housekeeping status of room
service_status: (one of IN_SERVICE, OUT_OF_ORDER, OUT_OF_SERVICE)
Current service status of room
occupied: (boolean)
Is the room currently occupied
max_occupancy: (integer)
Maximum occupancy
floor: (object)
Floor information
- number: (string)
  Floor number
- description: (string)
  Floor description
features: (array of any)
Array of features assigned to the room

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/rooms/{id}/change_house_keeping_status post

post

Change house keeping status of a room by its identifier

Secured by oauth_2_0

URI Parameters

id: required(string)

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

status: required(one of CLEAN, DIRTY, INSPECTED, PICKUP)
Housekeeping status of the room

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/rooms/{id}/service_status post get

post

Change service status of a room by its identifier

get

Returns a paginated list of service status for the requested room and date range

Change service status of a room by its identifier

Secured by oauth_2_0

URI Parameters

id: required(string)

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

type: required(object)
Inactive Room details
- service_status: required(one of OUT_OF_ORDER, OUT_OF_SERVICE, IN_SERVICE)
  Service status of the room
- from_date: required(date-only)
  Begin date of the service status
- to_date: required(date-only)
  End date of the service status
- comment: (string)
  Comment on the service status

Example:

{
  "from_date": "2020-01-15",
  "to_date": "2020-01-20",
  "service_status": "OUT_OF_ORDER",
  "comment": "TEST COMMENT"
}

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/room_types

/room_types/{id} get

get

Show the details of a room type by its identifier.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Room Type Identifier

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: (integer)
Identifier
code: (string)
Code
name: (string)
Name
description: (string)
Description
max_occupancy: (integer)
Max Occupancy
image_url: (string)
Image URL
suite: (boolean)
Is a suite room type
pseudo: (boolean)
Is a pseudo room type

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/room_types/{id}/available_rooms get

get

Retrieve all available rooms for the provided room type. Start and End dates in this search should reflect the arrival and departure dates of stays that are being looked for. This API will return rooms that are available on the basis of these dates with the start date being the arrival data and the end date being the departure date. For the current business date additional query parameters must be applied to return rooms which are not in VACANT/INSPECTED status.

Secured by oauth_2_0

URI Parameters

id: required(integer)
Room Type Identifier

Query Parameters

begin_date: required(date-only)
Begin Date
end_date: required(date-only)
End Date
house_keeping_status: (one of CLEAN, DIRTY, INSPECTED, PICKUP)
Housekeeping status of the room
include_not_ready: (boolean - default: false)
include_dueout: (boolean - default: false)
include_clean: (boolean - default: false)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

rooms: required(array of object)
Rooms available to book for the provided room type.
Items: items
- id: required(integer)
  Room Identifier
- room_number: required(integer)
  Room number
- house_keeping_status: required(one of CLEAN, DIRTY, INSPECTED, PICKUP)
  House Keeping Status

Example:

[
  {
    "id": 13243,
    "room_number": "011",
    "house_keeping_status": "INSPECTED"
  },
  {
    "id": 14335,
    "room_number": "012",
    "house_keeping_status": "DIRTY"
  }
]

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/restrictions

/restrictions/house post get delete

post

Create restrictions for the hotel on the House level

get

Returns a list of house restrictions filtered by the input parameters.

delete

Delete restrictions for the hotel on the House level

Create restrictions for the hotel on the House level

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(integer)
Hotel Identifier
from_date: required(date-only)
the first date (YYYY-MM-DD) for which to change data for
to_date: required(date-only)
the date (YYYY-MM-DD) to end any changes, can be the same date as the start_date or may be as far out as start_date + 30 days
restrictions: required(object)
a hash of restrictions in the hotel level
- closed: (boolean)
  stops any booking from staying on the date
- closed_arrival: (boolean)
  does not allow bookings to arrive on the date
- closed_departure: (boolean)
  does not allow bookings to depart on the date
- min_length_of_stay: (integer)
  stays arriving on this date must stay a minimum of X nights
- max_length_of_stay: (integer)
  stays arriving on this date may stay no more than Z nights
- min_stay_through: (integer)
  stays that include this date must stay at least X nights (stay dates may be before or after the date)
- min_advanced_booking: (integer)
  bookings must be made at least X days prior to the arrival date
- max_advanced_booking: (integer)
  bookings may be made no more than Y days prior to the arrival date

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Returns a list of house restrictions filtered by the input parameters.

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier
from_date: required(date-only)
the first date (YYYY-MM-DD) for which to fetch data
to_date: required(date-only)
the end date (YYYY-MM-DD) for which to fetch data, can be the same date as the start_date or may be as far out as start_date + 30 days

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

restrictions: required(array of object)
House Restrictions
Items: items
- closed: (array of object)
  stops any booking from staying on the date
  Items: items
  - value: (boolean)
    Closed restriction value - true / false
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- closed_arrival: (array of object)
  does not allow bookings to arrive on the date
  Items: items
  - value: (boolean)
    Closed arrival restriction value - true / false
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- closed_departure: (array of object)
  does not allow bookings to depart on the date
  Items: items
  - value: (boolean)
    Closed departure restriction value - true / false
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- min_stay_through: (array of object)
  stays that include this date must stay at least X nights (stay dates may be before or after the date)
  Items: items
  - value: (integer)
    Min stay through restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- min_length_of_stay: (array of object)
  stays arriving on this date must stay a minimum of X nights
  Items: items
  - value: (integer)
    Min length of stay restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- max_length_of_stay: (array of object)
  stays arriving on this date may stay no more than Z nights
  Items: items
  - value: (integer)
    Max length of stay restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- min_advanced_booking: (array of object)
  bookings must be made at least X days prior to the arrival date
  Items: items
  - value: (integer)
    Min advanced booking restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- max_advanced_booking: (array of object)
  bookings may be made no more than Y days prior to the arrival date
  Items: items
  - value: (integer)
    Max advanced booking restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Delete restrictions for the hotel on the House level

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(integer)
Hotel Identifier
from_date: required(date-only)
the first date (YYYY-MM-DD) for which to change data for
to_date: required(date-only)
the date (YYYY-MM-DD) to end any changes, can be the same date as the start_date or may be as far out as start_date + 30 days
restrictions: required(array)
An array of restrictions in the hotel level

Example:

{
  "hotel_id": 105,
  "from_date": "2023-01-01",
  "to_date": "2023-01-01",
  "restrictions": [
    "min_advanced_booking",
    "max_advanced_booking",
    "min_stay_through",
    "min_length_of_stay",
    "max_length_of_stay"
  ]
}

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/restrictions/rate post get delete

post

Create restrictions for the hotel on the Rate level

get

Returns a list of rate level restrictions filtered by the input parameters.

delete

Delete restrictions for the hotel on the Rate level

Create restrictions for the hotel on the Rate level

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(integer)
Hotel Identifier
rate_id: required(integer)
Rate Identifier
from_date: required(date-only)
the first date (YYYY-MM-DD) for which to change data for
to_date: required(date-only)
the date (YYYY-MM-DD) to end any changes, can be the same date as the start_date or may be as far out as start_date + 30 days
restrictions: required(object)
a hash of restrictions in the rate level
- closed: (boolean)
  stops any booking from staying on the date
- closed_arrival: (boolean)
  does not allow bookings to arrive on the date
- closed_departure: (boolean)
  does not allow bookings to depart on the date
- min_length_of_stay: (integer)
  stays arriving on this date must stay a minimum of X nights
- max_length_of_stay: (integer)
  stays arriving on this date may stay no more than Z nights
- min_stay_through: (integer)
  stays that include this date must stay at least X nights (stay dates may be before or after the date)
- min_advanced_booking: (integer)
  bookings must be made at least X days prior to the arrival date
- max_advanced_booking: (integer)
  bookings may be made no more than Y days prior to the arrival date

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Returns a list of rate level restrictions filtered by the input parameters.

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier
rate_id: (integer)
Rate Identifier
from_date: required(date-only)
the first date (YYYY-MM-DD) for which to fetch data
to_date: required(date-only)
the end date (YYYY-MM-DD) for which to fetch data, can be the same date as the start_date or may be as far out as start_date + 30 days

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

restrictions: required(array of object)
Rate Restrictions
Items: items
- rate_id: required(integer)
  Rate Identifier
- closed: (array of object)
  stops any booking from staying on the date
  Items: items
  - value: (boolean)
    Closed restriction value - true / false
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- closed_arrival: (array of object)
  does not allow bookings to arrive on the date
  Items: items
  - value: (boolean)
    Closed arrival restriction value - true / false
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- closed_departure: (array of object)
  does not allow bookings to depart on the date
  Items: items
  - value: (boolean)
    Closed departure restriction value - true / false
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- min_stay_through: (array of object)
  stays that include this date must stay at least X nights (stay dates may be before or after the date)
  Items: items
  - value: (integer)
    Min stay through restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- min_length_of_stay: (array of object)
  stays arriving on this date must stay a minimum of X nights
  Items: items
  - value: (integer)
    Min length of stay restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- max_length_of_stay: (array of object)
  stays arriving on this date may stay no more than Z nights
  Items: items
  - value: (integer)
    Max length of stay restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- min_advanced_booking: (array of object)
  bookings must be made at least X days prior to the arrival date
  Items: items
  - value: (integer)
    Min advanced booking restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- max_advanced_booking: (array of object)
  bookings may be made no more than Y days prior to the arrival date
  Items: items
  - value: (integer)
    Max advanced booking restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Delete restrictions for the hotel on the Rate level

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(integer)
Hotel Identifier
rate_id: required(integer)
Rate Identifier
from_date: required(date-only)
the first date (YYYY-MM-DD) for which to change data for
to_date: required(date-only)
the date (YYYY-MM-DD) to end any changes, can be the same date as the start_date or may be as far out as start_date + 30 days
restrictions: required(array)
An array of restrictions in the Rate level

Example:

{
  "hotel_id": 105,
  "from_date": "2023-01-01",
  "to_date": "2023-01-01",
  "rate_id": "26201",
  "restrictions": [
    "min_advanced_booking",
    "max_advanced_booking",
    "min_stay_through",
    "min_length_of_stay",
    "max_length_of_stay"
  ]
}

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/restrictions/rate_type post get delete

post

Create restrictions for the hotel on the Rate type level

get

Returns a list of rate type restrictions filtered by the input parameters.

delete

Delete restrictions for the hotel on the Rate type level

Create restrictions for the hotel on the Rate type level

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(integer)
Hotel Identifier
rate_type_id: required(integer)
Rate type Identifier
from_date: required(date-only)
the first date (YYYY-MM-DD) for which to change data for
to_date: required(date-only)
the date (YYYY-MM-DD) to end any changes, can be the same date as the start_date or may be as far out as start_date + 30 days
restrictions: required(object)
a hash of restrictions in the rate type level
- closed: (boolean)
  stops any booking from staying on the date
- closed_arrival: (boolean)
  does not allow bookings to arrive on the date
- closed_departure: (boolean)
  does not allow bookings to depart on the date
- min_length_of_stay: (integer)
  stays arriving on this date must stay a minimum of X nights
- max_length_of_stay: (integer)
  stays arriving on this date may stay no more than Z nights
- min_stay_through: (integer)
  stays that include this date must stay at least X nights (stay dates may be before or after the date)
- min_advanced_booking: (integer)
  bookings must be made at least X days prior to the arrival date
- max_advanced_booking: (integer)
  bookings may be made no more than Y days prior to the arrival date

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Returns a list of rate type restrictions filtered by the input parameters.

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier
rate_type_id: (integer)
Rate Type Identifier
from_date: required(date-only)
the first date (YYYY-MM-DD) for which to fetch data
to_date: required(date-only)
the end date (YYYY-MM-DD) for which to fetch data, can be the same date as the start_date or may be as far out as start_date + 30 days

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

restrictions: required(array of object)
RateType Restrictions
Items: items
- rate_type_id: required(integer)
  Rate Type Identifier
- closed: (array of object)
  stops any booking from staying on the date
  Items: items
  - value: (boolean)
    Closed restriction value - true / false
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- closed_arrival: (array of object)
  does not allow bookings to arrive on the date
  Items: items
  - value: (boolean)
    Closed arrival restriction value - true / false
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- closed_departure: (array of object)
  does not allow bookings to depart on the date
  Items: items
  - value: (boolean)
    Closed departure restriction value - true / false
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- min_stay_through: (array of object)
  stays that include this date must stay at least X nights (stay dates may be before or after the date)
  Items: items
  - value: (integer)
    Min stay through restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- min_length_of_stay: (array of object)
  stays arriving on this date must stay a minimum of X nights
  Items: items
  - value: (integer)
    Min length of stay restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- max_length_of_stay: (array of object)
  stays arriving on this date may stay no more than Z nights
  Items: items
  - value: (integer)
    Max length of stay restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- min_advanced_booking: (array of object)
  bookings must be made at least X days prior to the arrival date
  Items: items
  - value: (integer)
    Min advanced booking restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- max_advanced_booking: (array of object)
  bookings may be made no more than Y days prior to the arrival date
  Items: items
  - value: (integer)
    Max advanced booking restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Delete restrictions for the hotel on the Rate type level

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(integer)
Hotel Identifier
rate_type_id: required(integer)
Rate type Identifier
from_date: required(date-only)
the first date (YYYY-MM-DD) for which to change data for
to_date: required(date-only)
the date (YYYY-MM-DD) to end any changes, can be the same date as the start_date or may be as far out as start_date + 30 days
restrictions: required(array)
An array of restrictions in the Rate type level

Example:

{
  "hotel_id": 105,
  "from_date": "2023-01-01",
  "to_date": "2023-01-01",
  "rate_type_id": "26201",
  "restrictions": [
    "min_advanced_booking",
    "max_advanced_booking",
    "min_stay_through",
    "min_length_of_stay",
    "max_length_of_stay"
  ]
}

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/restrictions/room_type post get delete

post

Create restrictions for the hotel on the Room type level

get

Returns a list of room type restrictions filtered by the input parameters.

delete

Delete restrictions for the hotel on the Room type level

Create restrictions for the hotel on the Room type level

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(integer)
Hotel Identifier
room_type_id: required(integer)
Room type Identifier
from_date: required(date-only)
the first date (YYYY-MM-DD) for which to change data for
to_date: required(date-only)
the date (YYYY-MM-DD) to end any changes, can be the same date as the start_date or may be as far out as start_date + 30 days
restrictions: required(object)
a hash of restrictions in the room type level
- closed: (boolean)
  stops any booking from staying on the date
- closed_arrival: (boolean)
  does not allow bookings to arrive on the date
- closed_departure: (boolean)
  does not allow bookings to depart on the date
- min_length_of_stay: (integer)
  stays arriving on this date must stay a minimum of X nights
- max_length_of_stay: (integer)
  stays arriving on this date may stay no more than Z nights
- min_stay_through: (integer)
  stays that include this date must stay at least X nights (stay dates may be before or after the date)
- min_advanced_booking: (integer)
  bookings must be made at least X days prior to the arrival date
- max_advanced_booking: (integer)
  bookings may be made no more than Y days prior to the arrival date

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Returns a list of room type restrictions filtered by the input parameters.

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier
room_type_id: (integer)
Room type Identifier
from_date: required(date-only)
the first date (YYYY-MM-DD) for which to fetch data
to_date: required(date-only)
the end date (YYYY-MM-DD) for which to fetch data, can be the same date as the start_date or may be as far out as start_date + 30 days

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

restrictions: required(array of object)
Room Type Restrictions
Items: items
- room_type_id: required(integer)
  Room Type Identifier
- closed: (array of object)
  stops any booking from staying on the date
  Items: items
  - value: (boolean)
    Closed restriction value - true / false
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- closed_arrival: (array of object)
  does not allow bookings to arrive on the date
  Items: items
  - value: (boolean)
    Closed arrival restriction value - true / false
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- closed_departure: (array of object)
  does not allow bookings to depart on the date
  Items: items
  - value: (boolean)
    Closed departure restriction value - true / false
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- min_stay_through: (array of object)
  stays that include this date must stay at least X nights (stay dates may be before or after the date)
  Items: items
  - value: (integer)
    Min stay through restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- min_length_of_stay: (array of object)
  stays arriving on this date must stay a minimum of X nights
  Items: items
  - value: (integer)
    Min length of stay restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- max_length_of_stay: (array of object)
  stays arriving on this date may stay no more than Z nights
  Items: items
  - value: (integer)
    Max length of stay restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- min_advanced_booking: (array of object)
  bookings must be made at least X days prior to the arrival date
  Items: items
  - value: (integer)
    Min advanced booking restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- max_advanced_booking: (array of object)
  bookings may be made no more than Y days prior to the arrival date
  Items: items
  - value: (integer)
    Max advanced booking restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Delete restrictions for the hotel on the Room type level

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(integer)
Hotel Identifier
room_type_id: required(integer)
Room Type Identifier
from_date: required(date-only)
the first date (YYYY-MM-DD) for which to change data for
to_date: required(date-only)
the date (YYYY-MM-DD) to end any changes, can be the same date as the start_date or may be as far out as start_date + 30 days
restrictions: required(array)
An array of restrictions in the Room type level

Example:

{
  "hotel_id": 105,
  "room_type_id": "1345",
  "from_date": "2023-01-01",
  "to_date": "2023-01-01",
  "restrictions": [
    "min_advanced_booking",
    "max_advanced_booking",
    "min_stay_through",
    "min_length_of_stay",
    "max_length_of_stay"
  ]
}

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

/restrictions/room_rate post get delete

post

Update restrictions for the hotel on the Room Rate level

get

Returns a list of room rate restrictions filtered by the input parameters.

delete

Delete restrictions for the hotel on the Room Rate level

Update restrictions for the hotel on the Room Rate level

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(integer)
Hotel Identifier
room_type_id: required(integer)
Room Type Identifier
rate_id: required(integer)
Rate Identifier
from_date: required(date-only)
the first date (YYYY-MM-DD) for which to change data for
to_date: required(date-only)
the date (YYYY-MM-DD) to end any changes, can be the same date as the start_date or may be as far out as start_date + 30 days
restrictions: required(object)
a hash of restrictions in the room rate level
- closed: (boolean)
  stops any booking from staying on the date
- closed_arrival: (boolean)
  does not allow bookings to arrive on the date
- closed_departure: (boolean)
  does not allow bookings to depart on the date
- min_length_of_stay: (integer)
  stays arriving on this date must stay a minimum of X nights
- max_length_of_stay: (integer)
  stays arriving on this date may stay no more than Z nights
- min_stay_through: (integer)
  stays that include this date must stay at least X nights (stay dates may be before or after the date)
- min_advanced_booking: (integer)
  bookings must be made at least X days prior to the arrival date
- max_advanced_booking: (integer)
  bookings may be made no more than Y days prior to the arrival date

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Returns a list of room rate restrictions filtered by the input parameters.

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Query Parameters

hotel_id: required(integer)
Hotel Identifier
room_type_id: (integer)
Room Type Identifier
rate_id: required(integer)
Rate Identifier
from_date: required(date-only)
the first date (YYYY-MM-DD) for which to fetch data
to_date: required(date-only)
the end date (YYYY-MM-DD) for which to fetch data, can be the same date as the start_date or may be as far out as start_date + 30 days

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

restrictions: required(array of object)
Room Rate Restrictions
Items: items
- room_type_id: required(integer)
  Room Type Identifier
- rate_id: required(integer)
  Rate Identifier
- closed: (array of object)
  stops any booking from staying on the date
  Items: items
  - value: (boolean)
    Closed restriction value - true / false
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- closed_arrival: (array of object)
  does not allow bookings to arrive on the date
  Items: items
  - value: (boolean)
    Closed arrival restriction value - true / false
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- closed_departure: (array of object)
  does not allow bookings to depart on the date
  Items: items
  - value: (boolean)
    Closed departure restriction value - true / false
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- min_stay_through: (array of object)
  stays that include this date must stay at least X nights (stay dates may be before or after the date)
  Items: items
  - value: (integer)
    Min stay through restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- min_length_of_stay: (array of object)
  stays arriving on this date must stay a minimum of X nights
  Items: items
  - value: (integer)
    Min length of stay restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- max_length_of_stay: (array of object)
  stays arriving on this date may stay no more than Z nights
  Items: items
  - value: (integer)
    Max length of stay restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- min_advanced_booking: (array of object)
  bookings must be made at least X days prior to the arrival date
  Items: items
  - value: (integer)
    Min advanced booking restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied
- max_advanced_booking: (array of object)
  bookings may be made no more than Y days prior to the arrival date
  Items: items
  - value: (integer)
    Max advanced booking restriction value
  - date_ranges: (array of RestrictionDateRange)
    Items: RestrictionDateRange
    from_date: (date-only)
    the first date (YYYY-MM-DD) from which restriction is applied
    to_date: (date-only)
    the end date (YYYY-MM-DD) upto which restriction is applied

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Delete restrictions for the hotel on the Room Rate level

Secured by oauth_2_0

Headers

API-Version: required(string)
API Version
Example:
```
2.0
```

Body

Media type: application/json

Type: object

Properties

hotel_id: required(integer)
Hotel Identifier
room_type_id: required(integer)
Room Type Identifier
rate_id: required(integer)
Rate Identifier
from_date: required(date-only)
the first date (YYYY-MM-DD) for which to change data for
to_date: required(date-only)
the date (YYYY-MM-DD) to end any changes, can be the same date as the start_date or may be as far out as start_date + 30 days
restrictions: required(array)
An array of restrictions in the Room Rate level

Example:

{
  "hotel_id": 105,
  "rate_id": "1234",
  "room_type_id": "1345",
  "from_date": "2023-01-01",
  "to_date": "2023-01-01",
  "restrictions": [
    "min_advanced_booking",
    "max_advanced_booking",
    "min_stay_through",
    "min_length_of_stay",
    "max_length_of_stay"
  ]
}

HTTP status code 200

HTTP status code 422

Validation Error

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Secured by oauth_2_0

Headers

Authorization: required(string)
Used to send a valid OAuth 2 access token.

HTTP status code 401

Bad or expired token, Unsupported version

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

HTTP status code 403

Bad request

Body

Media type: application/json

Type: object

Properties

type: required(array of object)
Items: Error
- code: (one of VALIDATION_ERROR, AUTHENTICATION_FAILED, INVALID_RECORD, SYSTEM_ERROR, UNAUTHORIZED, INVALID_PARAMETER)
  Error Code
- message: (string)
  Error Message

Stayntouch Connect API documentation version 2.0

/accounts

get /accounts

Headers

Query Parameters

HTTP status code 200

Body

HTTP status code 422

Body

Secured by oauth_2_0

Headers

HTTP status code 401

Body

HTTP status code 403

Body

post /accounts

Headers

Body

HTTP status code 200

Body

HTTP status code 422

Body

Secured by oauth_2_0

Headers

HTTP status code 401

Body

HTTP status code 403

Body

get /accounts/{id}

URI Parameters

Headers

Query Parameters

HTTP status code 200

Body

HTTP status code 422

Body

Secured by oauth_2_0

Headers

HTTP status code 401

Body

HTTP status code 403

Body

put /accounts/{id}

URI Parameters

Headers

Body

HTTP status code 200

Body

HTTP status code 422

Body

Secured by oauth_2_0

Headers

HTTP status code 401

Body

HTTP status code 403

Body

post /accounts/{id}/accounts_receivable

URI Parameters

Headers

Body

HTTP status code 200

Body

HTTP status code 422

Body

Secured by oauth_2_0

Headers

HTTP status code 401

Body

HTTP status code 403

Body

get /accounts/{id}/accounts_receivable

URI Parameters

Headers

Query Parameters

HTTP status code 200

Body

HTTP status code 422

Body

Secured by oauth_2_0

Headers