Table of Contents |
---|
Note |
---|
Warning |
...
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'.
...
Table of Contents |
---|
...
|
...
|
...
|
...
Description
...
X-SM-REFERENCE-ID
...
string
...
The reference ID used for the request
...
X-SM-ELAPSED-TIME
...
number (integer)
...
The elapsed time on the server side for the response to be written in milliseconds
Publisher
Name | Type | Description | Required |
---|---|---|---|
name | string | Publisher name | Yes |
code | string | Publisher code | Yes |
messageTypes | Message types supported by the publisher | Yes |
Hotel
Name | Type | Description | Required |
---|---|---|---|
name | string | Hotel name | Yes |
code | string | Hotel code | Yes |
currency | string | ISO 4217 currency code for the hotel currency | Yes |
messageTypes | Message types supported by the publisher | Yes |
RatePlan
Name | Type | Description | Required |
---|---|---|---|
code | string | The code of the rate plan | Yes |
category | string | This is the segment/category to which the rate plan belongs to | No |
yieldable | boolean | Boolean attribute to indicate whether the rate is yieldable or not. Only one Yieldable indicator is acceptable for RatePlan code; therefore, the Yieldable indicator must be the same for all seasons passed. | No |
marketCode | string | String attribute to indicate the market code for the rate. Only one MarketCode is acceptable for RatePlan code; therefore, the MarketCode must be the same for all seasons passed. | No |
confidential | boolean | This attribute is a boolean to indicate if the rate is to be considered “Confidential.” | No |
start | date | Start date. Format | No |
end | date | End date. The rate plan date range is not inclusive of the end date. Format | No |
commissionable | boolean | This indicates whether the rate season is commissionable or not. If the Boolean is sent as False, the rate season is not commissionable. If the Boolean is set to True, but NO commission is sent in the commission element, then the commission to be applied is the default one for the property. If the Boolean is set to True and a commission is passed in the field then the commission sent is the one applied to the rate season. | No |
description | string | Description of the rate plan | No |
commissionPercentage | double | Commission percentage | No |
commissionAmount | double | Commission amount. | No |
minimumAdvancedBookingOffset | number (integer) | This is the minimum amount of days prior to arrival that the rate can be booked. | No |
maximumAdvancedBookingOffset | number (integer) | This is the maximum amount of days prior to arrival that the rate can be booked. | No |
minLOS | number (integer) | This is the minimum length of stay requirement associated | No |
maxLOS | number (integer) | This is the maximum length of stay requirement associated to the rate | No |
arrivalWeekDays | Set of days of the week that arrival is allowed | No | |
availableWeekDays | Set of days of the week which the rate plan is available and therefore could be used to reflect when STAY is possible | No | |
lastModifiedAt | date | The last time when this rate plan was modified. | No |
Rate
Name | Type | Description | Required |
---|---|---|---|
date | date | Date of the rate. Format | No |
currencyCode | string | ISO 4217 currency code for the rate | No |
roomTypeCode | string | The code that identifies a Room Type. | Yes |
ratePlanCode | string | The code that identifies a Rate Plan | Yes |
status | string | Indicates for each room code passed for the rate whether it is opened or closed | Yes |
minLOS | integer | This is the minimum length of stay requirement associated with the rate plan. | No |
maxLOS | integer | This is the maximum length of stay requirement associated to the rate plan. | No |
baseGuestAmount | Base charge for a given number of guests for a given age qualifying code. | Yes | |
additionalGuestAmounts | Charges related to additional guests. | No | |
lastModifiedAt | date | The last time when this rate was modified. | No |
RoomType
Name | Type | Description | Required |
---|---|---|---|
code | string | The ID of the room type | Yes |
name | string | Room type name | No |
description | string | Description of the room type | No |
Availability
Name | Type | Description | Required |
---|---|---|---|
bookingLimit | integer | The number of rooms available. | Yes |
date | date | Date of the availability. Format | Yes |
ratePlanCode | string | The code that identifies a Rate Plan | No |
roomTypeCode | string | The code that identifies a Room Type. | No |
minLOS | integer | This is the minimum length of stay requirement associated with the rate plan. | No |
maxLOS | integer | This is the maximum length of stay requirement associated with the rate plan. | No |
restriction | string | The type of restriction | No |
status | string | The status of the restriction | No |
MessageTypes
Name | Type | Description | Required |
---|---|---|---|
MessageType | string | Message types supported by the publisher: | Yes |
AgeQualifier
...
Name
...
Type
...
Description
...
Required
...
AgeQualifier
...
string
...
Declares the type of guest:child
adult
BaseGuestAmount
Name | Type | Description | Required |
---|---|---|---|
ageQualifier | Declares the type of guest: | Yes | |
guestCount | integer | Number of guests included in the rate amount. | Yes |
amountBeforeTax | number | Rate amount exclusive of tax. | No |
amountAfterTax | number | Rate amount inclusive of tax. | No |
AdditionalGuestAmount
Name | Type | Description | Required |
---|---|---|---|
ageQualifier | Declares the type of guest: | No | |
amount | number | This is the tax exclusive rate amount of additional guests | No |
WeekDays
...
Name
...
Type
...
Description
...
Required
...
WeekDays
...
string
...
Days of the week.Mon
Tues
Wed
Thurs
Fri
Sat
Sun
TooManyRequests
Name | Type | Description | Required |
---|---|---|---|
message | string | Error message | Yes |
code | string | Error code | No |
retryAfter | integer | The time in seconds to retry after | Yes |
Error
...
Name
...
Type
...
Description
...
Required
...
message
...
string
...
Error message
...
No
...
code
...
string
...
Error code
...
|
Child pages (Children Display) |
---|