External Reservation Creation
POST/v1/api/externalReservation/create
Endpoint to create hotel reservations in the Niara system from an external call.
To decide whether this is a new reservation or an update to an existing one, Niara looks for a reservation whose locator matches the sent locator (or, when locator is not sent, the sent externalId). If no match is found this way, it then looks for a reservation whose pmsNumber matches that same value. When a match is found, the existing reservation is updated with the new data instead of a new one being created.
Depending on the integrating system, the externalId may be the same as the pmsNumber or the locator. If that is the case, send both fields with the same value.
Request
- application/json
Body
Unique reservation ID used by the external system integrating with Niara.
Hotel ID
Check-in day. (ISO 8601)
Check-out day. (ISO 8601)
Number of nights.
Reservation status [CONFIRMED or CANCELLED].
Primary guest's name.
Primary guest's email.
Currency. (ISO 4217 code)
Value without taxes.
Tax amount.
Number of adults.
Number of children.
List with the children's ages.
Room name.
Rate plan name.
Meal plan.
Hotel Name
Reservation source.
Reservation ID known by the guest.
Reservation ID on the hotel's PMS. May carry the same value as externalId, depending on how the source system integrates.
Indicates if the rate is non-refundable.
Day the penalty starts if the reservation is refundable. (ISO 8601)
Commission value.
Reservation comments.
Guest journey status [CHECKED_IN, CHECKED_OUT, NO_SHOW, CONFIRMED or CANCELLED].
Primary guest's ID from your system.
Primary guest's CPF.
Primary guest's passport number.
Primary guest's nationality (two-letter ISO code).
Primary guest's RG identity number (for brazilian citizens).
Primary guest's RG issuing authority (for brazilian citizens).
Primary guest's phone number.
Primary guest's date of birth.
Primary guest's address street.
Primary guest's address number.
Primary guest's address zip code.
Primary guest's address complement.
Primary guest's address neighborhood.
Primary guest's address city.
Primary guest's address state.
Responses
- 200
Reservation successfully created.
- application/json
- Schema
- Example (from schema)
Schema
Niara ID of the created reservation.
{
"reservationId": "string"
}