Booking

POST 
/v2/booking

Introduction

Books one or more previously check-priced room rates. Booking is asynchronous: this call only confirms the request was accepted for processing, not that the reservation itself is confirmed yet — see status on the response.

Request

application/json

Body

items object[]required
The item(s) to book in this single purchase.
Array [
item objectrequired
type
Possible values: [hotel]
Default value: hotel
bookingToken stringrequired
The re-confirmed room rate to book, as returned by v2/hotels/checkrate (roomRates[].bookingToken). Expires 15 minutes after being issued.
totalPrice objectrequired
The room rate's total price, as returned by v2/hotels/checkrate (roomRates[].priceComposition.total).
value numberrequired
currency stringrequired
guests object[]required
One entry per guest staying in the room.
Array [
ageQualifying required
Possible values: [ADULT, CHILD]
Age category of the guest.
firstName stringrequired
Guest's first name.
lastName stringnullable
Guest's last name.
email stringnullable
phone stringnullable
dob stringnullable
Date of birth (ISO 8601).
age integernullable
country stringnullable
nationality stringnullable
addressZipCode stringnullable
addressStreet stringnullable
addressNumber stringnullable
addressComplement stringnullable
addressDistrict stringnullable
addressCity stringnullable
addressState stringnullable
cpf stringnullable
Brazilian CPF, when applicable.
rg stringnullable
Brazilian RG, when applicable.
rgOrgaoEmissor stringnullable
Brazilian RG's issuing organ, when applicable.
passport stringnullable
birthCertificate stringnullable
]
comments stringnullable
Free-text special requests for the hotel (e.g. late check-in, accessible room).
]
buyer objectnullable
name stringnullable
email stringnullable
payments object[]required
Payment(s) to charge for this purchase.
Array [
paymentOptionId stringrequired
The payment option being charged, as returned by v2/hotels/checkrate (roomRates[].paymentOptions[].id).
creditCard objectnullable
brand stringnullable
holder stringnullable
number stringnullable
expiryDate stringnullable
cvv stringnullable
installments integer
Default value: 1
Number of installments, for payment options that support it.
paidItems object[]required
Which item(s) this payment covers, and how much of each.
Array [
itemIndex integerrequired
Index into items this portion of the payment applies to.
amount numberrequired
Portion of that item's totalPrice covered by this payment.
currency stringrequired
]
]
searchId stringnullable

The searchId from the availability search/checkrate these room rates came from. Recommended: also drives internal cross-call correlation.

locale stringnullable

Desired language/locale for the response's text.

Responses

200

application/json

Schema

Schema

orderId stringrequired
status required

Possible values: [INPROGRESS, FAILED, PRICE_CHANGED]

PRICE_CHANGED means the price moved since checkrate; see priceChanges. Re-submitting to confirm the new price isn't wired up yet.

items object[]required
Array [
id stringrequired
ID of the created reservation/order item.
index integerrequired
Index into the request's items this result corresponds to.
]
priceChanges object[]nullable
Populated only when status is PRICE_CHANGED.
Array [
id stringrequired
index integernullable
referenceTotal numbernullable
The total price this item was booked at.
supplierTotal numbernullable
The item's current, live total price.
difference numbernullable
currency stringnullable
]

Example (from schema)

{
  "orderId": "string",
  "items": [
    {
      "id": "string",
      "index": 0
    }
  ],
  "priceChanges": [
    {
      "id": "string",
      "index": 0,
      "referenceTotal": 0,
      "supplierTotal": 0,
      "difference": 0,
      "currency": "string"
    }
  ]
}

Loading...