Response of Reservation Information

The below represent some different response models for reservations. Please note that multiple reservation child elements of different status element types can be mixed in a single reservation's response element.

---

Response Model — No Pending New, Modified, Cancelled Reservations

Sample Success Response

{
  "reservations": []
}

---

Response Model — New Reservation Confirmation

Attributes

booked_at date (Optional)

Date when the booking has been made.

---

commissionamount integer (Required)

The total commission a hotel has to pay to OTA per complete reservation.

Min:1 Max:1

---

currencycode string (Required)

Currency code in which the booking has been made.

---

paymenttype string (Required)

Payment type for the booking.

---

hotel_id alphanumeric (Required)

The hotel id as used by IT Provider.

Maximum 20 characters allowed.

Min:1 Max:1

---

hotel_name alphanumeric (Required)

The hotel name as used by IT Provider.

Min:1 Max:1

---

paymentdue integer (Required)

The payment due details ** Currently only supported by Hostel world.

Min:1 Max:1

customer object

---

The corporate_booking_detail element contains the corporate level B2B booking details for taxation and billing.

Attribute

address string (Required)

The address of the booker.

Min:1 Max:1

---

cc_cvc integer (Required)

CVC number of the credit card.

Min:1 Max:1

---

cc_expiration_date datetime (Required)

The expiration date of the credit card.

Min:0 Max:1

Format MMYY

---

cc_name string (Required)

Name of the credit card holder.

Min:1 Max:1

---

cc_number integer (Required)

The number of the credit card.

Min:1 Max:1

---

cc_type string (Required)

The type of credit card.

Min:1 Max:1

---

cc_current_balance string (Required)

Current balance of virtual credit card allocated by OTA.

Min:1 Max:1

---

cc_activation_date string (Required)

The activation date of the virtual credit card allocated by OTA.

Min:1 Max:1

Format Date: YYYY-MM-DD

---

vcc_expiration_date string (Required)

The expiration date of the virtual credit card allocated by OTA.

Min:1 Max:1

Format Date: YYYY-MM-DD

---

cc_token string (Required)

The token of credit card.

Min:1 Max:1

---

cc_token_expiration date (Required)

The expiry date of cc token generated.

Min:1 Max:1

---

cc_unique_code string (Required)

cc unique code - Value is assigned if Partner is integrated with Airpay payment gateway. Otherwise, empty node is passed.

Min:1 Max:1

---

city string (Required)

The city where the booker is from.

Min:1 Max:1

---

state string (Required)

The state where the booker is from.

Min:1 Max:1

---

countrycode string (Required)

The country code of the country where the booker is from.

Min:1 Max:1

---

email string (Required)

Email address supplied by the customer.

Min:1 Max:1

---

first_name string (Required)

First name of the booker as supplied by the customer.

Min:1 Max:1

---

last_name string (Required)

Last name of the booker as supplied by the customer.

Min:1 Max:1

---

remarks string (Required)

Remarks regarding this reservation, supplied by the customer.

Min:1 Max:1

---

telephone string (Required)

Telephone number as supplied by the customer.

Min:1 Max:1

---

zip string (Required)

Zip / Postal code as supplied by the customer.

Min:1 Max:1

---

cc_vault_token numeric (Required)

Token for cc number.

Min:1 Max:1

---

cc_tracking_id string (Required)

Tracking id for cc details.

Min:1 Max:1

---

rooms object

Attribute

---

arrival_date datetime (Required)

Date of arrival of the guests.

Min:1 Max:1

Format - YYYY-MM-DD

---

departure_date datetime (Required)

Date of departure of the guests.

Min:1 Max:1

Format - YYYY-MM-DD

---

info string (Required)

Extra information for the room.

Min:1 Max:1

---

facilities string (Required)

Information over facilities included for the room (if allocated).

Min:1 Max:1

---

specialrequest string (Required)

Special request made while making booking for the room (if allocated).

Min:1 Max:1

---

eta numerical (Required)

Estimate time for check in for this reservation as filled in on the website.

Min:1 Max:1

---

guest_name string (Required)

Guest name for this reservation as filled in on the website.

Min:1 Max:1

---

first_name string (Required)

Guest's First name for this reservation as filled in on the website.

Min:1 Max:1

---

last_name string (Required)

Guest's Last name for this reservation as filled in on the website.

Min:1 Max:1

---

id alphanumeric (Required)

The room type ID as used by IT Provider.

Min:1 Max:1

---

max_children integer (Required)

The number of children included in the booked room.

Min:0 Max:1

---

numberofguests integer (Required)

It is the number of guests for this reservation as filled by the booker.

Min:1 Max:1

---

numberofchildren integer (Required)

It is the number of children for this reservation as filled by the booker.

Min:1 Max:1

---

numberofadults integer (Required)

It is the number of adults for this reservation as filled by the booker.

Min:1 Max:1

---

roomstaystatus string (Required)

The roomstaystatus ('new', 'modified' 'request' or 'cancelled') identifies the stay whether it is new, modified, request or cancelled.

Min:1 Max:1

---

roomreservation_id string (Required)

The room reservation ID as used by STAAH to identify the booked room within the reservation.

Min:1 Max:1

---

totalbeforetax integer (Required)

Total booking value before applying the taxes.

Min:1 Max:1

---

totaltax integer (Required)

The total amount of tax for this reservation. All rooms * all nights combined.

Min:1 Max:1

---

totalprice integer (Required)

The total price for this room before tax(s) for all nights combined, sum of all prices known at the moment of reservation (Before Taxes). Note that there may be some excluded charges from this price.

Min:1 Max:1

---

price alphanumeric (Required)

Price and rate category ID per night as known at the moment of reservation. The currency used for pricing is always the same for the hotel and set by OTA.

Min:1 Max:unbounded

---

amount double (Required)

It contains the amount of per day pricing.

Value for this parameter will be numeric with possible decimal point.

Min:1 Max:unbounded

---

date alphanumeric (Required)

Date and time

Format: YYYY-MM-DD

---

rate_id alphanumeric (Required)

Rate category ID per night as known at the moment of reservation.

---

mealplan_id integer (Required)

Meal plan ID per night as known at the moment of reservation.

Min:1 Max:1

---

mealplan alphanumeric (Required)

Meal plan name per night as known at the moment of reservation.

Min:1 Max:1

---

tax integer (Required)

Tax amount per night of reservation (Date wise).

Min:1 Max:1

---

pricebeforetax alphanumeric (Required)

Room rate amount per night of reservation before tax(s)(Date wise).

Min:1 Max:1

---

priceaftertax alphanumeric (Required)

Room rate amount per night of reservation after tax(s)(Date wise).

Min:1 Max:1

---

adults alphanumeric (Required)

It is the name of additional adult/s for this reservation as filled by the booker.

Min:0 Max:1

---

addons alphanumeric (Required)

Additional services added to the reservation.

Min:0 Max:1

---

name string (Required)

The add-on name, in English.

Min:0 Max:1

---

nights integer (Required)

Number of nights this customer has booked the addon for.

Min:0 Max:1

---

priceperunit integer (Required)

The unitary price for this add-on.

Min:0 Max:1

---

pricemode integer (Required)

An integer identifying the price mode (per stay, per night, per person per night). See table below for the values.

Min:0 Max:1

ID	PRICE MODE
0	Not applicable
1	Per stay
2	Per person per stay
3	Per night
4	Per person per night
5	Percentage
6	Per person per night restricted

---

price integer (Required)

The total calculated price for the add-on, taking into consideration the price mode.

Min:0 Max:1

---

Taxes array

This array represents the detailed information about the taxes applied to an item (such as a room booking, product, or service). Each object in the taxes array includes the name and value of the tax. See below attributes:

Attributes

---

name string (Optional)

The name or description of the tax.

Example Values:

• "Slab %": Indicates a slab-based tax, possibly percentage-based where the rate varies based on predefined slabs or tiers.

• "Flat %": Indicates a flat rate percentage tax, where a constant percentage is applied.

---

value string (Optional)

The value of the tax. This usually represents a percentage rate.

---

---

extracomponents alphanumeric (Required)

The tag contains details of all Extra / Other charges charged on a room. It is a room level value allocated from OTA and might vary as per rooms booked for multiple room reservation scenario.

---

bed_type alphanumeric (Required)

The tag contains details of bed type.

---

affiliation object

Source Information of reservation.

---

Attribute

---

pos string (Required)

Point of sale of reservation.

Min:1 Max:1

---

source string (Required)

Source of reservation.

Min:1 Max:1

---

OTA_Code number (Required)

Source of reservation code or OTA code.

---

gstno alphanumeric (Required)

GST No. of the company for B2B booking.

Min:1 Max:1

---

companyname string (Required)

Name of B2B booking company (as allocated from OTA).

Min:1 Max:1

---

companyaddress string (Required)

Address of B2B company (As allocated from OTA).

---

chain_id alphanumeric (Required)

The chain id allocated from IT provider for the property

---

external_id alphanumeric (Required)

Instant booking reference - In the event of a property migrating from Instant (STAAH product) to Su.

---

otadue string (Required)

The amount OTA needs to pay to the property for the booking.

Min:1 Max:1

---

sellamount integer (Required)

The sell amount of room of this reservation (Same value as of tag "totalprice"). All rooms * all nights combined including Taxes.

Min:1 Max:1

---

confirmationlink

The url through which one can confirm / deny the request of booking coming from VRBO. Only available under "request" booking from VRBO.

Min:1 Max:1

---

payment_charge numeric (Required)

Payment charged from OTA on the booking. Currently data is being allocated by http://Booking.com only.

Min:1 Max:1

---

channel_booking_id alphanumeric (Required)

Booking reference number of OTA.

Min:1 Max:1

---

thread_id alphanumeric (Required)

The thread ID as allocated by OTA / Channel (Supported by Airbnb only).

Min:1 Max:1

---

guest_id alphanumeric (Required)

The guest ID as allocated by OTA / Channel (Supported by Airbnb only).

Min:1 Max:1

---

numberofpets numeric (Required)

The number of pets as allocated by OTA / Channel.

Min:1 Max:1

---

numberofinfants numeric (Required)

The number of infants as allocated by OTA / Channel.

Min:1 Max:1

---

listingbaseprice numeric (Required)

Base price of the listing allocated from OTA / Channel (Supported by Airbnb Only).

Min:1 Max:1

---

processed_at datetime (Required)

Date and Time Stamp (HH:MM:SS) when the booking was processed (GMT Time).

Min:1 Max:1

Format - Date Time

---

deposit numeric (Required)

Deposit collected for a booking made / received.

Min:1 Max:1

---

cancellation_fee numeric (Required)

Deposit collected for a booking made / received.

Min:1 Max:1

---

vendor_booking_id string (Required)

The vendor booking id provided by some of the OTAs. (Empty node will be passed if no value received from OTA for booking)

---

id alphanumeric (Required)

The reservation ID as used by STAAH.

---

reservation_notif_id string (Required)

The reservation notification ID used to mark reservation as received.

Min:1 Max:1

---

modified_at date (Required)

Date when the status is modified.

---

status string (Required)

The reservation status ('new', 'modified' or 'cancelled').

Min:1 Max:1

---

totalprice integer (Required)

The total amount of room sales of this reservation. All rooms * all nights combined including Taxes. Note that there may be some excluded charges from this price.

Min:1 Max:1

---

totaltax integer (Required)

The total amount of tax for this reservation. All rooms * all nights combined.

Min:1 Max:1

---

discount double (Required)

Discount amount received from OTA.

Min:1 Max:1

---

extrafees object

Information of extra fees charged on booking ** Currently only supported by Airbnb. If no value allocated or for other channels, the node will be passed empty as "extrafees": [], and "taxes": []

---

Attribute

---

name string (Required)

Name of the extra fee charged.

Min:1 Max:1

---

amount string (Required)

Amount charged as extra fee.

Min:1 Max:1

---

taxes object

Information of taxes charged on booking ** Currently only supported by Airbnb. If no value allocated or for other channels, the node will be passed empty as <taxes></taxes>

---

Attribute

---

name string (Required)

Name of the tax charged.

Min:1 Max:1

---

amount string (Required)

Amount of tax applied / charged.

Min:1 Max:1

---

Sample Success Response

{
  "reservations": [{
    "booked_at": "2017-09-03",
    "commissionamount": "72.63",
    "currencycode": "NZD",
    "paymenttype": "Hotel Collect",
    "hotel_id": "11122010",
    "hotel_name": "The Rosehotel Motel",
    "paymentdue": "",
    "customer": {
      "address": "Holly Tree Barn Commonside",
      "cc_cvc": "",
      "cc_expiration_date": "",
      "cc_name": "",
      "cc_number": "",
      "cc_type": "",
      "cc_current_balance": "125.36",
      "cc_activation_date": "2020-05-28",
      "vcc_expiration_date": "2020-06-02",
      "cc_token": "12589463532",
      "cc_token_expiration": "2020-12-12",
      "cc_unique_code": "c237b1ba20f5c2cbe32f47e6db1d1c58",
      "city": "Frodsham",
      "state": "",
      "countrycode": "gb",
      "email": "[e-mail]",
      "first_name": "staah - Alun",
      "last_name": "Parry",
      "remarks": "Approximate time of arrival: between 17:00 and 18:00",
      "telephone": "[phone]",
      "zip": "WA6 9HA",
      "cc_vault_token": "",
      "cc_tracking_id": ""
    },
    "rooms": [{
      "arrival_date": "2018-03-11",
      "departure_date": "2018-03-13",
      "info": "",
      "facilities": "",
      "taxes": [{
        "name": "Slab %",
        "value": "175.0"
      },
      {
        "name": "Flat %",
        "value": "353.5"
      }],
      "specialrequest": "",
      "eta": "",
      "guest_name": "Alun Parry",
      "first_name": "Alun",
      "last_name": "Parry",
      "id": "1000202",
      "max_children": "0",
      "numberofguests": "2",
      "numberofchildren": "0",
      "numberofadults": "2",
      "roomstaystatus": "new",
      "roomreservation_id": "123654789",
      "totalbeforetax": "568.98",
      "totaltax": "63.22",
      "totalprice": "632.20",
      "price": [{
        "amount": "174.49",
        "date": "2018-03-11",
        "rate_id": "1",
        "mealplan_id": "15",
        "mealplan": "Room Only",
        "tax": "31.61",
        "pricebeforetax": "174.49",
        "priceaftertax": "206.1"
      }, {
        "date": "2018-03-12",
        "rate_id": "1",
        "mealplan_id": "15",
        "mealplan": "Room Only",
        "tax": "31.61",
        "pricebeforetax": "174.49",
        "priceaftertax": "206.1"
      }],
      "adults": ["XXX XXX", "YYY YYY"],
      "addons": [{
        "name": "Breakfast",
        "nights": "2",
        "priceperunit": "18.00",
        "pricemode": "4",
        "price": "72.00",
        "taxes": [{
          "name": "Slab %",
          "value": "175.0"
        },
        {
          "name": "Flat %",
          "value": "353.5"
        }]
      }]
    }],
    "extracomponents": [{
      "name": "Service Charge",
      "value": "108"
    }, {
      "name": "Cleaning Fee",
      "value": "40"
    }],
    "bed_type":"Queen",
    "affiliation": {
      "pos": "Expedia",
      "source": "expedia",
      "OTA_Code": "9",
      "gstno": "010101ABCD",
      "companyname": "UltraTech",
      "companyaddress": "Noida, Uttar Pradesh"
    },
    "chain_id": "Chain1",
    "external_id": "",
    "otadue": "",
    "nettamount": "160.00",
    "sellamount": "532",
    "cancelreason": "",
    "confirmationlink": "",
    "payment_charge": "",
    "channel_booking_id": "180538ABD2269",
    "thread_id": "20101986",
    "guest_id": "101986",
    "numberofpets": "",
    "numberofinfants": "",
    "listingbaseprice": "110",
    "processed_at": "2021-08-13 05:43:10",
    "deposit": "10.20",
    "cancellation_fee": "",
    "vendor_booking_id": "NH7201152942756",
    "id": "1805382269_11122010",
    "reservation_notif_id": "152420368316228301205",
    "modified_at": "2017-09-03",
    "status": "new",
    "totalprice": "632.20",
    "totaltax": "63.22",
    "discount": "28.2",
    "extrafees": [{
      "name": "Airbnb Service",
      "amount": "22.05"
    }, {
      "name": "Airbnb S1ervice",
      "amount": "22.05"
    }],
    "taxes": [{
      "name": "VAT\/GST (Ptt_authority_175960)",
      "amount": "43.22"
    }, {
      "name": "Tourist Tax (Ptt_authority_175961)",
      "amount": "20.00"
    }]
  }]
}

---

Response Model — Modified Reservation

Sample Success Response

{
  "reservations": [{
    "booked_at": "2017-09-03",
    "commissionamount": "72.63",
    "currencycode": "NZD",
    "paymenttype": "Hotel Collect",
    "hotel_id": "11122010",
    "hotel_name": "The Rosehotel Motel",
    "paymentdue": "",
    "customer": {
      "address": "Holly Tree Barn Commonside",
      "cc_cvc": "",
      "cc_expiration_date": "",
      "cc_name": "",
      "cc_number": "",
      "cc_type": "",
      "cc_current_balance": "125.36",
      "cc_activation_date": "2020-05-28",
      "vcc_expiration_date": "2020-06-02",
      "cc_token": "12589463532",
      "cc_token_expiration": "2020-12-12",
      "cc_unique_code": "c237b1ba20f5c2cbe32f47e6db1d1c58",
      "city": "Frodsham",
      "state": "",
      "countrycode": "gb",
      "email": "[e-mail]",
      "first_name": "staah - Alun",
      "last_name": "Parry",
      "remarks": "Approximate time of arrival: between 17:00 and 18:00",
      "telephone": "[phone]",
      "zip": "WA6 9HA",
      "cc_vault_token": "",
      "cc_tracking_id": ""
    },
    "rooms": [{
      "arrival_date": "2018-03-11",
      "departure_date": "2018-03-13",
      "info": "",
      "facilities": "",
      "taxes": [{
        "name": "Slab %",
        "value": "175.0"
      },
      {
        "name": "Flat %",
        "value": "353.5"
      }],
      "specialrequest": "",
      "eta": "",
      "guest_name": "Alun Parry",
      "first_name": "Alun",
      "last_name": "Parry",
      "id": "1000202",
      "max_children": "0",
      "numberofguests": "2",
      "numberofchildren": "0",
      "numberofadults": "2",
      "roomstaystatus": "new",
      "roomreservation_id": "123654789",
      "totalbeforetax": "568.98",
      "totaltax": "63.22",
      "totalprice": "632.20",
      "price": [{
        "amount": "174.49",
        "date": "2018-03-11",
        "rate_id": "1",
        "mealplan_id": "15",
        "mealplan": "Room Only",
        "tax": "31.61",
        "pricebeforetax": "174.49",
        "priceaftertax": "206.1"
      }, {
        "date": "2018-03-12",
        "rate_id": "1",
        "mealplan_id": "15",
        "mealplan": "Room Only",
        "tax": "31.61",
        "pricebeforetax": "174.49",
        "priceaftertax": "206.1"
      }],
      "adults": ["XXX XXX", "YYY YYY"],
      "addons": [{
        "name": "Breakfast",
        "nights": "2",
        "priceperunit": "18.00",
        "pricemode": "4",
        "price": "72.00",
        "taxes": [{
          "name": "Slab %",
          "value": "175.0"
        },
        {
          "name": "Flat %",
          "value": "353.5"
        }]
      }]
    }],
    "extracomponents": [{
      "name": "Service Charge",
      "value": "108"
    }, {
      "name": "Cleaning Fee",
      "value": "40"
    }],
    "bed_type":"Queen",
    "affiliation": {
    "pos": "Expedia",
    "source": "expedia",
    "OTA_Code": "9",
    "gstno": "010101ABCD",
    "companyname": "UltraTech",
    "companyaddress": "Noida, Uttar Pradesh"
  },
  "chain_id": "Chain1",
  "external_id": "",
  "otadue": "",
  "nettamount": "160.00",
  "sellamount": "532",
  "cancelreason": "",
  "confirmationlink": "",
  "payment_charge": "",
  "channel_booking_id": "180538ABD2269",
  "thread_id": "20101986",
  "guest_id": "101986",
  "numberofpets": "",
  "numberofinfants": "",
  "listingbaseprice": "110",
  "processed_at": "2021-08-13 05:43:10",
  "deposit": "10.20",
  "cancellation_fee": "",
  "vendor_booking_id": "NH7201152942756",
  "id": "1805382269_11122010",
  "reservation_notif_id": "152420368316228301205",
  "modified_at": "2017-09-03",
  "status": "modified",
  "totalprice": "632.20",
  "totaltax": "63.22",
  "discount": "28.2",
  "extrafees": [{
    "name": "Airbnb Service",
    "amount": "22.05"
  }, {
    "name": "Airbnb S1ervice",
    "amount": "22.05"
  }],
  "taxes": [{
    "name": "VAT\/GST (Ptt_authority_175960)",
    "amount": "43.22"
  }, {
    "name": "Tourist Tax (Ptt_authority_175961)",
    "amount": "20.00"
  }]
  }]
}

---

Response Model — Request Booking

Sample Success Response

{
  "reservations": [
    {
      "booked_at": "2017-09-03",
      "commissionamount": "72.63",
      "currencycode": "NZD",
      "paymenttype": "Hotel Collect",
      "hotel_id": "11122010",
      "hotel_name": "The Rosehotel Motel",
      "paymentdue": "",
      "customer": {
        "address": "Holly Tree Barn Commonside",
        "cc_cvc": "",
        "cc_expiration_date": "",
        "cc_name": "",
        "cc_number": "",
        "cc_type": "",
        "cc_current_balance": "125.36",
        "cc_activation_date": "2020-05-28",
        "vcc_expiration_date": "2020-06-02",
        "cc_token": "12589463532",
        "cc_token_expiration": "2020-12-12",
        "cc_unique_code": "c237b1ba20f5c2cbe32f47e6db1d1c58",
        "city": "Frodsham",
        "state": "",
        "countrycode": "gb",
        "email": "[e-mail]",
        "first_name": "staah - Alun",
        "last_name": "Parry",
        "remarks": "Approximate time of arrival: between 17:00 and 18:00",
        "telephone": "[phone]",
        "zip": "WA6 9HA",
        "cc_vault_token": "",
        "cc_tracking_id": ""
      },
      "rooms": [
        {
          "arrival_date": "2018-03-11",
          "departure_date": "2018-03-13",
          "info": "",
          "facilities": "",
          "taxes": [
            {
              "name": "Slab %",
              "value": "175.0"
            },
            {
              "name": "Flat %",
              "value": "353.5"
            }
          ],
          "specialrequest": "",
          "eta": "",
          "guest_name": "Alun Parry",
          "first_name": "Alun",
          "last_name": "Parry",
          "id": "1000202",
          "max_children": "0",
          "numberofguests": "2",
          "numberofchildren": "0",
          "numberofadults": "2",
          "roomstaystatus": "new",
          "roomreservation_id": "123654789",
          "totalbeforetax": "568.98",
          "totaltax": "63.22",
          "totalprice": "632.20",
          "price": [
            {
              "amount": "174.49",
              "date": "2018-03-11",
              "rate_id": "1",
              "mealplan_id": "15",
              "mealplan": "Room Only",
              "tax": "31.61",
              "pricebeforetax": "174.49",
              "priceaftertax": "206.1"
            },
            {
              "date": "2018-03-12",
              "rate_id": "1",
              "mealplan_id": "15",
              "mealplan": "Room Only",
              "tax": "31.61",
              "pricebeforetax": "174.49",
              "priceaftertax": "206.1"
            }
          ],
          "adults": [
            "XXX XXX",
            "YYY YYY"
          ],
          "addons": [
            {
              "name": "Breakfast",
              "nights": "2",
              "priceperunit": "18.00",
              "pricemode": "4",
              "price": "72.00",
              "taxes": [
                {
                  "name": "Slab %",
                  "value": "175.0"
                },
                {
                  "name": "Flat %",
                  "value": "353.5"
                }
              ]
            }
          ]
        }
      ],
      "extracomponents": [
        {
          "name": "Service Charge",
          "value": "108"
        },
        {
          "name": "Cleaning Fee",
          "value": "40"
        }
      ],
        "affiliation": {
    "pos": "Expedia",
    "source": "expedia",
    "OTA_Code": "9",
    "gstno": "010101ABCD",
    "companyname": "UltraTech",
    "companyaddress": "Noida, Uttar Pradesh"
  },
  "chain_id": "Chain1",
  "external_id": "",
  "otadue": "",
  "nettamount": "160.00",
  "sellamount": "532",
  "cancelreason": "",
  "confirmationlink": "xxxxx.suissu.com/SUAPI/service/requesturls/1-TDhKTFbhp5pm-ulH7VrIUsPOD4qkRO0",
  "payment_charge": "",
  "channel_booking_id": "180538ABD2269",
  "thread_id": "20101986",
  "guest_id": "101986",
  "numberofpets": "",
  "numberofinfants": "",
  "listingbaseprice": "110",
  "processed_at": "2021-08-13 05:43:10",
  "deposit": "10.20",
  "cancellation_fee": "",
  "vendor_booking_id": "NH7201152942756",
  "id": "1805382269_11122010",
  "reservation_notif_id": "152420368316228301205",
  "modified_at": "2017-09-03",
  "status": "request",
  "totalprice": "632.20",
  "totaltax": "63.22",
  "discount": "28.2",
  "extrafees": [
    {
      "name": "Airbnb Service",
      "amount": "22.05"
    },
    {
      "name": "Airbnb S1ervice",
      "amount": "22.05"
    }
  ],
  "taxes": [
    {
      "name": "VAT/GST (Ptt_authority_175960)",
      "amount": "43.22"
    },
    {
      "name": "Tourist Tax (Ptt_authority_175961)",
      "amount": "20.00"
    }
  ]
    }
  ]
}

---

Response Model - Cancelled Reservation

{
    "reservations": [
        {
            "booked_at": "2020-08-24",
            "commissionamount": "28.6",
            "currencycode": "NZD",
            "paymenttype": "Hotel Collect",
            "hotel_id": "KC",
            "hotel_name": "Kings Cross",
            "paymentdue": "",
            "customer": {
                "address": "24th Street",
                "cc_cvc": "",
                "cc_expiration_date": "0225",
                "cc_name": "JASON",
                "cc_number": "4111111111111111",
                "cc_type": "VI",
                "cc_current_balance": "",
                "cc_activation_date": "",
                "vcc_expiration_date": "",
                "cc_token": "",
                "cc_token_expiration": "",
                "cc_unique_code": "",
                "city": "Auckland",
                "state": "",
                "countrycode": "New Zealand",
                "email": "[e-mail]",
                "first_name": "Sam",
                "last_name": "Thomas",
                "remarks": "Approximate time of arrival: between 17:00 and 18:00Are double beds available?",
                "telephone": "1234566789",
                "zip": "12345",
                "cc_vault_token": "",
                "cc_tracking_id": ""
            },
            "rooms": [
                {
                    "arrival_date": "2020-09-10",
                    "departure_date": "2020-09-12",
                    "info": "This modern room is equipped with a work desk and a flat-screen TV with satellite channels. Enjoy a convenient Breakfast at the property for USD 18 per person, per night. Children and Extra Bed Policy: Children cannot be accommodated at the hotel. There is no capacity for extra beds in the room. Deposit Policy: 100 percent of the first night may be charged anytime after booking. Cancellation Policy: If cancelled or modified up to 1 day before the date of arrival, no fee will be charged. If cancelled or modified later or in case of no-show, 100 percent of the first night will be charged.",
                    "facilities": "No Smoking Meal plan :Enjoy a convenient Breakfast at the property for USD 18 per person, per night. rewritten_from_name : SECRET DEAL genius_rate : no",
                    "taxes": [
                        {
                            "name": "Slab %",
                            "value": "175.0"
                        },
                        {
                            "name": "Flat %",
                            "value": "353.5"
                        }
                    ],
                    "specialrequest": "",
                    "eta": "",
                    "guest_name": "Sam Thomas",
                    "first_name": "Sam",
                    "last_name": "Thomas",
                    "id": "STD",
                    "max_children": "0",
                    "numberofguests": "2",
                    "numberofchildren": "0",
                    "numberofadults": "2",
                    "roomstaystatus": "cancelled",
                    "roomreservation_id": "1598272591656",
                    "totalbeforetax": "286",
                    "totaltax": "0",
                    "totalprice": "286",
                    "price": [
                        {
                            "amount": "174.49",
                            "date": "2020-09-10",
                            "rate_id": "BAR",
                            "mealplan_id": "1",
                            "mealplan": "All inclusive",
                            "tax": "0",
                            "pricebeforetax": "125",
                            "priceaftertax": "125"
                        },
                        {
                            "date": "2020-09-11",
                            "rate_id": "BAR",
                            "mealplan_id": "1",
                            "mealplan": "All inclusive",
                            "tax": "0",
                            "pricebeforetax": "125",
                            "priceaftertax": "125"
                        }
                    ],
                    "adults": [
                        "XXX XXX",
                        "YYY YYY"
                    ],
                    "addons": [
                        {
                            "name": "Breakfast",
                            "nights": "2",
                            "priceperunit": "18.00",
                            "pricemode": "4",
                            "price": "36",
                            "taxes": [
                                {
                                    "name": "Slab %",
                                    "value": "175.0"
                                },
                                {
                                    "name": "Flat %",
                                    "value": "353.5"
                                }
                            ]
                        }
                    ]
                }
            ],
            "extracomponents": [],
            "bed_type": "Queen",
            "affiliation": {
                "pos": "Expedia",
                "source": "expedia",
                "OTA_Code": "9",
                "gstno": "010101ABCD",
                "companyname": "UltraTech",
                "companyaddress": "Noida, Uttar Pradesh"
            },
            "chain_id": "Chain1",
            "external_id": "",
            "otadue": "",
            "nettamount": "160.00",
            "sellamount": "532",
            "cancelreason": "",
            "confirmationlink": "",
            "payment_charge": "",
            "channel_booking_id": "180538ABD2269",
            "thread_id": "20101986",
            "guest_id": "101986",
            "numberofpets": "",
            "numberofinfants": "",
            "listingbaseprice": "110",
            "processed_at": "2021-08-13 05:43:10",
            "deposit": "10.20",
            "cancellation_fee": "",
            "vendor_booking_id": "122543543",
            "id": "040736750_KC",
            "reservation_notif_id": "159827327984387346046",
            "modified_at": "2020-08-24",
            "status": "cancelled",
            "totalprice": "286",
            "totaltax": "5",
            "discount": "28.2",
            "extrafees": [
                {
                    "name": "Airbnb Service",
                    "amount": "22.05"
                },
                {
                    "name": "Airbnb S1ervice",
                    "amount": "22.05"
                }
            ],
            "taxes": [
                {
                    "name": "VAT/GST (Ptt_authority_175960)",
                    "amount": "43.22"
                },
                {
                    "name": "Tourist Tax (Ptt_authority_175961)",
                    "amount": "20.00"
                }
            ]
        }
    ]
}

Response Model — Multiple Room Reservation

Sample Success Response

{
  "reservations": [
    {
      "booked_at": "2020-08-24",
      "commissionamount": "31.6",
      "currencycode": "NZD",
      "paymenttype": "Channel Collect",
      "hotel_id": "KC",
      "hotel_name": "Kings Cross",
      "paymentdue": "",
      "customer": {
        "address": "24th Street",
        "cc_cvc": "",
        "cc_expiration_date": "0225",
        "cc_name": "JASON",
        "cc_number": "4111111111111111",
        "cc_type": "VI",
        "cc_current_balance": "",
        "cc_activation_date": "",
        "vcc_expiration_date": "",
        "cc_token": "",
        "cc_token_expiration": "",
        "cc_unique_code": "",
        "city": "Auckland",
        "state": "",
        "countrycode": "New Zealand",
        "email": "[e-mail]",
        "first_name": "Paul",
        "last_name": "Chris",
        "remarks": "Approximate time of arrival: between 17:00 and 18:00. Are double beds available?",
        "telephone": "123456789",
        "zip": "12345",
        "cc_vault_token": "",
        "cc_tracking_id": ""
      },
      "rooms": [
        {
          "arrival_date": "2020-08-24",
          "departure_date": "2020-08-25",
          "info": "This modern room is equipped with a work desk and a flat-screen TV with satellite channels. Enjoy a convenient Breakfast at the property for USD 18 per person, per night. Children and Extra Bed Policy: Children cannot be accommodated at the hotel. There is no capacity for extra beds in the room. Deposit Policy: 100 percent of the first night may be charged anytime after booking. Cancellation Policy: If cancelled or modified up to 1 day before the date of arrival, no fee will be charged. If cancelled or modified later or in case of no-show, 100 percent of the first night will be charged.",
          "facilities": "No Smoking Meal plan: Enjoy a convenient Breakfast at the property for USD 18 per person, per night. rewritten_from_name: SECRET DEAL genius_rate: no",
          "taxes": [
            {
              "name": "Slab %",
              "value": "175.0"
            },
            {
              "name": "Flat %",
              "value": "353.5"
            }
          ],
          "specialrequest": "",
          "eta": "",
          "guest_name": "Paul Chris",
          "first_name": "Paul",
          "last_name": "Chris",
          "id": "STD",
          "max_children": "0",
          "numberofguests": "2",
          "numberofchildren": "0",
          "numberofadults": "2",
          "roomstaystatus": "new",
          "roomreservation_id": "1598274401030",
          "totalbeforetax": "261",
          "totaltax": "5",
          "totalprice": "266",
          "price": [
            {
              "amount": "174.49",
              "date": "2020-08-24",
              "rate_id": "BAR",
              "mealplan_id": "1",
              "mealplan": "All inclusive",
              "tax": "4",
              "pricebeforetax": "136",
              "priceaftertax": "140"
            }
          ],
          "adults": [
            "XXX XXX",
            "YYY YYY"
          ],
          "addons": [
            {
              "name": "Breakfast",
              "nights": "1",
              "priceperunit": "18.00",
              "pricemode": "4",
              "price": "18",
              "taxes": [
                {
                  "name": "Slab %",
                  "value": "175.0"
                },
                {
                  "name": "Flat %",
                  "value": "353.5"
                }
              ]
            }
          ]
        },
        {
          "arrival_date": "2020-08-26",
          "departure_date": "2020-08-27",
          "info": "This modern room is equipped with a work desk and a flat-screen TV with satellite channels. Enjoy a convenient Breakfast at the property for USD 18 per person, per night. Children and Extra Bed Policy: Children cannot be accommodated at the hotel. There is no capacity for extra beds in the room. Deposit Policy: 100 percent of the first night may be charged anytime after booking. Cancellation Policy: If cancelled or modified up to 1 day before the date of arrival, no fee will be charged. If cancelled or modified later or in case of no-show, 100 percent of the first night will be charged.",
          "facilities": "No Smoking Meal plan: Enjoy a convenient Breakfast at the property for USD 18 per person, per night. rewritten_from_name: SECRET DEAL genius_rate: no",
          "specialrequest": "",
          "eta": "",
          "guest_name": "Paul Chris",
          "first_name": "Paul",
          "last_name": "Chris",
          "id": "STD1",
          "max_children": "0",
          "numberofguests": "2",
          "numberofchildren": "0",
          "numberofadults": "2",
          "roomstaystatus": "new",
          "roomreservation_id": "1598274398684",
          "totalbeforetax": "261",
          "totaltax": "5",
          "totalprice": "266",
          "price": [
            {
              "date": "2020-08-26",
              "rate_id": "BAR",
              "mealplan_id": "1",
              "mealplan": "All inclusive",
              "tax": "4",
              "pricebeforetax": "136",
              "priceaftertax": "140"
            }
          ],
          "adults": [
            "XXX XXX",
            "YYY YYY"
          ],
          "addons": [
            {
              "name": "Breakfast",
              "nights": "1",
              "priceperunit": "18.00",
              "pricemode": "4",
              "price": "18",
              "taxes": [
                {
                  "name": "Slab %",
                  "value": "175.0"
                },
                {
                  "name": "Flat %",
                  "value": "353.5"
                }
              ]
            }
          ]
        }
      ],
      "extracomponents": [
        {
          "name": "service charge",
          "value": "108"
        }
      ],
      "bed_type": "Queen",
      "affiliation": {
        "pos": "Expedia",
        "source": "expedia",
        "OTA_Code": "9",
        "gstno": "010101ABCD",
        "companyname": "UltraTech",
        "companyaddress": "Noida, Uttar Pradesh"
      },
      "chain_id": "Chain1",
      "external_id": "",
      "otadue": "",
      "nettamount": "160.00",
      "sellamount": "532",
      "cancelreason": "",
      "confirmationlink": "",
      "payment_charge": "",
      "channel_booking_id": "180538ABD2269",
      "thread_id": "20101986",
      "guest_id": "101986",
      "numberofpets": "",
      "numberofinfants": "",
      "listingbaseprice": "110",
      "processed_at": "2021-08-13 05:43:10",
      "deposit": "10.20",
      "cancellation_fee": "",
      "vendor_booking_id": "122543543",
      "id": "232368879_KC",
      "reservation_notif_id": "159827439307556534166",
      "modified_at": "2020-08-24",
      "status": "new",
      "totalprice": "532",
      "totaltax": "10",
      "discount": "28.2",
      "extrafees": [],
      "taxes": []
    }
  ]
}

---

Multiple Room Reservation

System allows to have multiple rooms to be booked under same reservation with different Guest, Check In/Out dates, Room type, Rate Plan, etc. These reservations can be retrieved through the same API request. Refer to Response Model — Multiple Room Reservation for reference.

Errors

Errors due to Invalid Parameters

{
  "Status": "Fail",
  "Errors": {
    "Code": "950",
    "ShortText": "Reservation Not Found"
  }
}