Hotel API · Reservations & credit
BookingList()
This function is dedicated to retrieve the bookings for a given hotel. Uses idtoken if exist, or idorder if exist or return all bookings starting from lastupdate date or between fromdate / todate.
Request
<BookingListRQ>
<Credential>
<Login>?</Login>
<Password>?</Password>
</Credential>
<User>?</User>
<Ilng>?</Ilng>
<Source>?</Source>
<hotel>?</hotel>
<idtoken>?</idtoken>
<idorder>?</idorder>
<operation>?</operation>
<lastupdate>?</lastupdate>
<fromdate>?</fromdate>
<todate>?</todate>
</BookingListRQ>| Root | Sub root | Description | Values & Format | Tag |
|---|---|---|---|---|
| Credential | Mandatory | |||
| Login | Text | |||
| Password | Text | |||
| User | Current user Id | Numeric | Mandatory | |
| Ilng | Language Id | Numeric | Optional | |
| Source | Source Id | Text | Mandatory if hotel is through a 3rd party supplier | |
| hotel | Hotel Id | Text | Optional | |
| idtoken | Token Id | Numeric | Optional | |
| idorder | Id of order | Numeric | Optional | |
| operation | type of operation | Text | “pms” in case of connection from a hotel PMS software | |
| lastupdate | last update | date | Optional | |
| fromdate | booking from date | date | Optional | |
| todate | booking to date | date | Optional |
Response
<BookingListRS>
<ErrorResult id="?">
<message>?</message>
</ErrorResult>
<bookings>
<booking>
<id>?</id>
<ClientTel>?</ClientTel>
<ClientEmail>?</ClientEmail>
<Autorisation>?</Autorisation>
<PaidAmount>?</PaidAmount>
<totalnetRate>?</totalnetRate>
<totalPaidAmount>?</totalPaidAmount>
<idaffiliate>?</idaffiliate>
<city>?</city>
<hoteltitle> ?</hoteltitle>
<fromdate> ?</fromdate>
<todate> ?</todate>
<remarks> ?</remarks>
<lastupdate> ?</lastupdate>
<state id="?"> ?</state>
<Source>?</Source>
<HCN>?</HCN>
<rooms>
<room>
<type> ?</type>
<boarding> ?</boarding>
<netRate> ?</netRate>
<Supplements/>
<customers>
<customer>
<name> ?</name>
<reductions> ?</reductions>
<kind> ?</kind>
</customer>
</customers>
</room>
</rooms>
</booking>
</bookings>
<Started>
</Started>
<ResponseTime>
</ResponseTime>
</BookingListRS>| Root | Sub root | Description | Values & Format | Tag |
|---|---|---|---|---|
| ErrorResult | Operation State | |||
| ErrorResult:@id | Id of current error | Numeric | ||
| message | Appropriate message | Text | ||
| bookings | ||||
| totalnetRate | cost rate | Numeric | ||
| totalPaidAmount | paid amount (added when state is reserved and booking is paid online) | Numeric | ||
| idaffiliate | Id Affiliate (agent) | Numeric | ||
| ClientTel | Client phone number | Text | ||
| ClientEmail | Client Email | Text | ||
| Autorisation | Authorisation | Numeric | ||
| PaidAmount | Paid Amount | Numeric | ||
| city | Hotel city location | text | ||
| hoteltitle | Title | text | ||
| fromdate | Date reservation from | Date | ||
| todate | Date reservation to | Date | ||
| remarks | Remarks | Text | ||
| lastupdate | Last update date | Date | ||
| Source | Source Id | Text | ||
| HCN | Hotel confirmation number | Text | ||
| state | State of the reservation | Text | ||
| State : @id | Id of the state of the reservation | Numeric | 4 : The hotel is available and your booking is confirmed, a voucher is issued 1 : The hotel is available and your booking is confirmed as reserved, no voucher is issued 0 : the hotel is not available is your booking is saved as onrequest 2 : the booking is cancelled 9: the booking OnRequest accepted by the hotel and saved as OnRequestOK | |
| rooms | ||||
| type | Type room | Numeric | ||
| boarding | Boarding room | Numeric | ||
| netRate | Net rate per room | Numeric | ||
| customers | ||||
| name | Customer Name | Text | ||
| reductions | Reduction | Numeric | 0 if no reduction is applied | |
| kind | kind | text |