Warning
This documentation is subject to change and further enhancement.
SMX will allow for partner applications to PULL availability and rate data from the SMX platform.
Data will be provided to SMX by the hoteliers property management systems (PMS), referred to in this API as a 'Publisher'.
The request and response will be sent in a application/JSON
format, derived from OTA2017A
.
Security - BearerAuthorization
apiKey | API Key |
---|---|
Name | Authorization |
In | Header |
Description | Must be in format of |
Tokens can be self-generated through the SMX Subscriber Admin Portal by the 'Account Owner'.
Publishers
Publisher List
Method: GET
Path: /publishers
Description: Get a list of publishers connected to your application.
Responses
Code | Description | Schema |
---|---|---|
200 | OK | |
401 | Unauthorized | |
403 | Forbidden | |
429 | Too Many Requests | |
500 | Internal Server Error |
Hotels
Method: GET
Path: /publishers/{publisherCode}/hotels
Description: Get a list of hotels connected to the selected publisher and your application.
Parameters
Name | Located in | Description | Required | Type |
---|---|---|---|---|
publisherCode | path | Publisher code | Yes | string |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | |
401 | Unauthorized | |
403 | Forbidden | |
429 | Too Many Requests | |
500 | Internal Server Error |
RatePlans
RatePlan by Hotel
Method: GET
Path: /publishers/{publisherCode}/hotels/{hotelCode}/ratePlans
Description: Lists all the Rate Plans for a specific hotel and publisher.
Parameters
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 |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | |
401 | Unauthorized | |
403 | Forbidden | |
429 | Too Many Requests | |
500 | Internal Server Error |
RatePlan by Rate Plan Code
Method: GET
Path: /publishers/{publisherCode}/hotels/{hotelCode}/ratePlans/{ratePlanCode}
Description: Get a specific rate plan for a hotel and publisher
Parameters
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 |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | |
401 | Unauthorized | |
403 | Forbidden | |
429 | Too Many Requests | |
500 | Internal Server Error |
Rate by Rate Plan
Method: GET
Path: /publishers/{publisherCode}/hotels/{hotelCode}/ratePlans/{ratePlanCode}/rates
Description: Fetch the rates for a rate plan code based on given date range for a specific hotel and publisher
NOTE If a publisher does not send a ratePlanCode with a rate then use ratePlanCode: NO_RATE_PLAN_PROVIDED_SM
in the path for the GET method
Parameters
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. Note: If a publisher does not send a ratePlanCode with a rate then use | Yes | string |
startDate | query | Start date to query for rates. Format like | Yes | date |
range | query | The number of days to query for. Maximum | No | number |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | |
401 | Unauthorized | |
403 | Forbidden | |
429 | Too Many Requests | |
500 | Internal Server Error |
Availability by Rate Plan
Method: GET
Path: /publishers/{publisherCode}/hotels/{hotelCode}/ratePlans/{ratePlanCode}/availability
Description: Fetch the availability for a given rate plan, hotel, and publisher.
Parameters
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 | Yes | date |
range | query | The number of days to query for. Maximum | No | number |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | |
401 | Unauthorized | |
403 | Forbidden | |
429 | Too Many Requests | |
500 | Internal Server Error |
Rates
Rates by Rate Plan
Method: GET
Path: /publishers/{publisherCode}/hotels/{hotelCode}/ratePlans/{ratePlanCode}/rates
Description: Fetch the rates for a rate plan code based on given date range, hotel, and publisher.
Parameters
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 | Yes | date |
range | query | The number of days to query for. Maximum | No | number |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | |
401 | Unauthorized | |
403 | Forbidden | |
429 | Too Many Requests | |
500 | Internal Server Error |
Availability
Availability by Rate Plan
Method: GET
Path: /publishers/{publisherCode}/hotels/{hotelCode}/ratePlans/{ratePlanCode}/availability
Description: Fetch the availability for a given rate plan, hotel, and publisher.
Parameters
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 | Yes | date |
range | query | The number of days to query for. Maximum | No | number |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | |
401 | Unauthorized | |
403 | Forbidden | |
429 | Too Many Requests | |
500 | Internal Server Error |
Availability by Room Type
Method: GET
Path: /publishers/{publisherCode}/hotels/{hotelCode}/roomTypes/{roomTypeCode}/availability
Description: Get all availability for a room type, date range, hotel, and publisher.
Parameters
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 | Yes | date |
range | query | The number of days to query for. Maximum | No | number |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | |
401 | Unauthorized | |
403 | Forbidden | |
429 | Too Many Requests | |
500 | Internal Server Error |
Availability by Hotel
Method: GET
Path: /publishers/{publisherCode}/hotels/{hotelCode}/availability
Description: Get all availability for a specific hotel, publisher and date range
Parameters
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 |
startDate | query | Start date to query for availability. Format like | Yes | date |
range | query | The number of days to query for availability. Maximum | No | number |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | |
401 | Unauthorized | |
403 | Forbidden | |
429 | Too Many Requests | |
500 | Internal Server Error |
RoomTypes
RoomType by Hotel
Method: GET
Path: /publishers/{publisherCode}/hotels/{hotelCode}/roomTypes
Description: Lists all the Room Types for a specific hotel and publisher.
Parameters
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 |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | |
401 | Unauthorized | |
403 | Forbidden | |
429 | Too Many Requests | |
500 | Internal Server Error |
RoomType by Room Type
Method: GET
Path: /publishers/{publisherCode}/hotels/{hotelCode}/roomTypes/{roomTypeCode}
Description: Get a specific room type for a specific hotel and publisher.
Parameters
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 |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | |
401 | Unauthorized | |
403 | Forbidden | |
429 | Too Many Requests | |
500 | Internal Server Error |
Availability by Room Type
Method: GET
Path: /publishers/{publisherCode}/hotels/{hotelCode}/roomTypes/{roomTypeCode}/availability
Description: Get all availability for a specific room type, date range, hotel and publisher.
Parameters
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 | Yes | date |
range | query | The number of days to query for. Maximum | No | number |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | |
401 | Unauthorized | |
403 | Forbidden | |
429 | Too Many Requests | |
500 | Internal Server Error |