Availability

Availability by Room Type Code

Method: GET
Path: /publishers/{publisherCode}/hotels/{hotelCode}/roomTypes/{roomTypeCode}/availability?startDate={yyyy-MM-dd} or
Path: /publishers/{publisherCode}/hotels/{hotelCode}/roomTypes/{roomTypeCode}/availability?startDate={yyyy-MM-dd}&range={NumberOfDays}
Description: Get all availability for a publisher, hotel, room type and date range.

Parameters

Name

Located in

Description

Required

Type

Name

Located in

Description

Required

Type

publisherCode

path

The unique identifier for the data publisher. Please refer to PMS RequestorID/publisherCode list

Yes

string

hotelCode

path

The code that uniquely identifies a single hotel property.

Yes

string

roomTypeCode

path

The code that identifies a Room Type.

Yes

string

startDate

query

Start date to query for availability. Format like yyyy-MM-dd i.e 2017-07-21.

Yes

date

range

query

The number of days to query for. Maximum 30.

No

number

Responses

Code

Description

Schema

Code

Description

Schema

200

OK

Availability

401

Unauthorized

Error

403

Forbidden

Error

405

Method Not Supported

Error

429

Too Many Requests

TooManyRequests

500

Internal Server Error

Error


Availability by Rate Plan Code

Method: GET
Path: /publishers/{publisherCode}/hotels/{hotelCode}/ratePlans/{ratePlanCode}/availability?startDate={yyyy-MM-dd} or
Path: /publishers/{publisherCode}/hotels/{hotelCode}/ratePlans/{ratePlanCode}/availability?startDate={yyyy-MM-dd}&range={NumberOfDays}
Description: Fetch the availability for a given publisher, hotel, rate plan and date range.

Parameters

Name

Located in

Description

Required

Type

Name

Located in

Description

Required

Type

publisherCode

path

The unique identifier for the data publisher. Please refer to PMS RequestorID/publisherCode list

Yes

string

hotelCode

path

The code that uniquely identifies a single hotel property.

Yes

string

ratePlanCode

path

The rate plan code.

Yes

string

startDate

query

Start date to query for rates. Format like yyyy-MM-dd i.e 2017-07-21.

Yes

date

range

query

The number of days to query for. Maximum 30.

No

number

Responses

Code

Description

Schema

Code

Description

Schema

200

OK

Availability

401

Unauthorized

Error

403

Forbidden

Error

405

Method Not Supported

Error

429

Too Many Requests

TooManyRequests

500

Internal Server Error

Error


Response JSON Samples: Availability Samples