The book service is responsible for confirming and issuing the reservation.
In this document, the fields marked as “required” are the common ones that all integrations must send. However, depending on the credential you use, there may be additional fields that are also required for that specific case. Therefore:
- Always fill in the general fields marked as required in this document.
- Review the specific requirements of your credential and include those additional fields when applicable.
If you want to see the status of the reservation, access the status reservation service using the field from the response: reservation_id
Country-Dependent Fields
Some fields vary based on the country of the credential used. Below are the rules that apply to two specific nodes in the request body:
- travelers.identification
- Description: The traveler’s identification type is country-dependent.
- Rule: When type = PASSPORT, certain countries require the issue_country field (e.g., "US", "BR").
- Examples: Case with PASSPORT requiring issue_country:
"travelers": [ { "identification": { "type": "PASSPORT", "number": "X1234567", "issue_country": "US" } } ]
Case with local identification:
"travelers": [ { "identification": { "type": "LOCAL", "number": "29216702087" } } ]
Note: The allowed values for identification.type and whether issue_country is mandatory depend on the country. Please review the country rules catalog before sending the request.
- invoice.fiscal_identification
- Description: The invoice’s tax identification is also country-dependent.
- Rule: The fiscal_identification.type and its format vary by country (e.g., CPF/CNPJ in Brazil, CUIT in Argentina, NIF in Spain). Validate against the appropriate catalog.
- Example (illustrative only):
"invoice": { "fiscal_identification": { "type": "CPF", "number": "99999999999" } }
Note: Verify the allowed types, number length/format, and any additional country-specific fields required.
Travelers
In the traveler field, you must enter different information depending on the vertical:
- Hotels: Only one lead traveler per room
- Flights: All travelers
- Activities: Only one