Hotel Book Retrieve
Note:
Few attributes in below sample response are supplier specific, hence there can be possibility these attributes will not appear in the response. We recommend you to parse these fields as mentioned in the sample responses.
The Booking Enquiry operation allows you to retrieve booking details. The response body for the booking retrieval will be same as the booking response. If an issue arise while doing the booking, this could be used to verify the status of the booking. If somehow the bookingId is not available clientId or the bookingKey could be used
Hotel Book Retrieve Request
| Tags | Attribute | Description |
|---|---|---|
| HotelBookRetrieveCriteria | (JsonObject) | |
| productType * (String) |
For hotels the product type should be 'H' | |
| bookingReferenceId (String) |
Identifies the booking after the booking creation | |
| clientReferenceId (String) |
Clients unique id to identify a booking | |
| bookingKey (String) |
Identifies the booking before booking creation | |
| hotel booking retrieve request | |
|---|---|
Hotel Book Retrieve Response
| Tags | Attribute | Description |
|---|---|---|
| meta | meta (Object) |
|
| success (Boolean) |
||
| statusCode (String) |
||
| statusMessage (String) |
||
| actionType (String) |
This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose. | |
| conversationId (String) |
conversationId a unique identifier of current conversation . | |
| commonData | (JsonObject) | |
| commonData | productCode* (String) |
Product code for hotels - H |
| commonData | culture* (String) |
en |
| data | (JsonArray) | This encloses hotel information. |
| data | bookingReferenceId* (String) |
This attribute contains the unique booking reference id. |
| data | clientReference * (String) |
This attribute contains the client reference id. |
| data | supplierReferenceId * (String) |
This attribute contains the supplier ReferenceId. |
| data | bookingStatus* (String) |
This attribute contains the booking status. |
| data | transactionDate* (String) |
Date of which the transaction has been placed. |
| hotel | name* (String) |
This attribute contains hotel name. |
| hotelKey* (String) |
This attribute contains a unique hotel id. | |
| totalNet* (String) |
This attribute contains selling price. | |
| currency* (String) |
This attribute contains currency of booking price. | |
| checkInDate* (String) |
This attribute contains the check-in date. | |
| checkoutDate* (String) |
This attribute contains the check-out date. | |
| rooms | (JsonArray) * | This encloses room information |
| room | (JsonObject) | |
| room | roomKey* (String) |
This attribute contains the room's unique id. |
| room | roomIndex* (String) |
represents the room number |
| room | roomId* (String) |
This attribute contains the room id. |
| room | roomTypeName * (String) |
Room type Eg: Deluxe Room |
| room | standardizedRoomName (String) |
Standard room name provided by hotel content solution provider (CSP). This tag will only come if any Hotel CSP enabled. |
| room | roomTypeDesc * (String) |
Room type description |
| room | bedType (String) |
bed type provided in the room Eg: Double |
| room | roomView (String) |
room view description Eg: mountain view |
| room | maxOccupancy (Integer) |
Max occupancy of a room. |
| room | sizeMeasurement (String) |
size of the room. |
| room | rateNotes (String) |
Eg: please Note That Three Bedroom Residence is Located In The Residence Building |
| isEmailId (Boolean) |
If the value of the attribute is true then send email id details in the booking request Not released yet |
|
| isPAN (Boolean) |
If the value of the attribute is true then send pan details in the booking request. Not released yet |
|
| isPassport (Boolean) |
If the value of the attribute is true then send passport details in the booking request. Not released yet |
|
| isPhoneNo (Boolean) |
If the value of the attribute is true then send phone number details in the booking request. Not released yet |
|
| ratePlan | (JsonObject) * | |
| ratePlan | supplierCode * (String) |
|
| ratePlan | meal * (String) |
Meal plan |
| ratePlan | standardizedMeal (String) |
Standard meal plan provided by hotel content solution provider (CSP). This tag will only come if any Hotel CSP enabled. |
| ratePlan | availableStatus * (String) |
availability status of the room |
| ratePlan | cancelPolicyIndicator (String) |
The cancel policy indicators Eg: refundable |
| ratePlan | code * (String) |
This attribute contains the room contract details |
| ratePlan | isPackage (String) |
Shows if the room rate is a package. |
| ratePlan | fixedCombo * (Boolean) |
Shows room selection is combined or flexible. |
| ratePlan | combinePolicy * (Boolean) |
Shows if cancellation policy is combined or roomwise. |
| ratePlan | inclusions (String) |
Room inclusion details Eg: ["Free Wifi", "Free pool"] |
| ratePlan | rateType (String) |
Contains rate type Eg: Retail/Corporate |
| ratePlan | gstAssured (Boolean) |
This indicated that available room hotel is GST assured and you can make request for GST invoices |
| ratePlan | lastCancellationDate (Date) |
Indicates last cancellation date |
| roomRate | (JsonObject) | |
| roomRate | currency* (String) |
Contains selling currency room price |
| roomRate | netAmount* (Double) |
Selling price of a room. |
| taxes | (JsonArray) | |
| tax | (JsonObject) | |
| tax | name (String) |
Tax name Not released yet |
| tax | amount (Double) |
Tax amount Not released yet |
| tax | included (Boolean) |
Shows if the tax is included in the room rate or not. Not released yet |
| rates | (JsonArray) * | |
| rate | (JsonObject) | |
| rate | name * (String) |
Name of the rate Eg: daily rates Not released yet |
| rate | amount * (String) |
Rate amount Not released yet |
| rate | from * (Date) |
Start date of room rate. Not released yet |
| rate | to * (Date) |
End date of room rate. Not released yet |
| rate | rateIndex * (String) |
Rate number Not released yet |
| offers | (JsonArray) | |
| offer | (JsonObject) | |
| offer | code (String) |
Offer Code Not released yet |
| offer | name (String) |
Offer name Not released yet |
| offer | from (Date) |
Start date from that date offer will apply Not released yet |
| offer | to (Date) |
End date where the offer will expire Not released yet |
| offer | amount (Double) |
Offer amount Not released yet |
| offer | included (Boolean) |
indicate that the offer is applied or not Not released yet |
| supplements | (JsonArray) | |
| supplement | (JsonObject) | |
| supplement | supplementKey (String) |
Supplement key |
| supplement | type (String) |
List of possible types - INCLUDED, ADDITION, AT_PROPERTY |
| supplement | name (String) |
Supplement name |
| supplement | amount (Double) |
Supplement charges |
| supplement | included (Boolean) |
Indicate that the supplement is applied or not to given room |
| supplement | currency (String) |
Supplement charges currency |
| supplement | description (String) |
Text, describing the supplement details |
| supplement | optionId (String) |
Unique identifier for supplement option |
| supplement | groupOptionId (String) |
Group Id for the supplement to which given supplement-option belongs |
| supplement | isFlightDetailsRequired (Boolean) |
Specifies if flight-information of guest is needed at the time of booking |
| supplement | isMandatory (Boolean) |
Identifies that - this supplement must be selected |
| supplement | dependentOnSupplementId (JsonArray) |
IDs of required linked supplements |
| financialInfo | (JsonObject) | |
| financialInfo | tmc (String) |
This tag contains supplier owner name. tmc - Travel Management Company. Eg: VE |
| financialInfo | supplier (String) |
Name of the supplier |
| financialInfo | subSupplierCode (String) |
Supplier code Not released yet |
| payment | (JsonObject) | |
| payment | paymentTypes (String) |
Payment types Eg: CARD,CR |
| passengers | (JsonArray) | This encloses passenger information. Not released yet |
| passenger | (JsonObject) | This encloses passenger information. Not released yet |
| passengerKey (String) |
passenger key Not released yet |
|
| isLead (String) |
true if the lead passenger Codes Not released yet |
|
| ptc (String) |
passenger type (ADT for adult,CHD for child) | |
| passengerInfo | birthDate (String) |
birthdate of the passenger Not released yet |
| gender (String) |
gender of the passenger Not released yet |
|
| nameTitle (String) |
salutation (Mr., Ms,) Not released yet |
|
| givenName (String) |
first name Not released yet |
|
| middleName (String) |
middle name Not released yet |
|
| surName (String) |
last name Not released yet |
|
| loyaltyProgramAccount | (String) |
This encloses loyalty information Not released yet |
| accountNumber (String) |
account number Not released yet |
|
| providerName (String) |
provider name Not released yet |
|
| tierCode (String) |
tier code Not released yet |
|
| programName (String) |
program name Not released yet |
|
| identityDocument | (JsonObject) |
This encloses identity documents Not released yet |
| idType (String) |
id type (PAN, PASSPORT) Not released yet |
|
| issuingCountryCode (String) |
issuing country Not released yet |
|
| applicableCountry (String) |
applicable country Not released yet |
|
| placeOfBirth (String) |
place of birth Not released yet |
|
| dateOfIssue (String) |
date of issue Not released yet |
|
| residenceCountryCode (String) |
residence country code Not released yet |
|
| expiryDate (String) |
expiry date Not released yet |
|
| Contact | (JsonObject) |
This tag encloses contact |
| PostalAddress | label (JsonObject) |
|
| street (String) |
||
| postalCode (String) |
||
| cityName (String) |
||
| countryCode (String) |
||
| contactsProvided (String) |
||
| emailAddress (String) |
||
| Phone | (JsonObject) |
|
| label (String) |
||
| countryCode (String) |
||
| phoneNumber (String) |
||
| hotelRequests | (JsonObject) |
|
| ssr (StringArray) |
||
| voucherDocuments | (JsonObject) |
This tag encloses the voucher specific information of booking.This information is needed to show on voucher. |
| hotelConfirmationNumber (String) |
Most of the cases this will be available only for Booking retrieve call. | |
| status (String) |
||
| roomBookingInfo | (JsonObject) |
|
| roomIndex (String) |
||
| status (String) |
||
| essentialNotes | (JsonObject) |
This tag encloses the remark for room. This is mandatory information which must be displayed to the end user before booking and voucher also. |
| name (String) |
||
| isMandatory (String) |
||
| description (String) |
||
| hotel book retrieve response | |
|---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 | |