Skip to main content

External Reservation Creation

POST 
/v1/api/externalReservation/create

Endpoint to create hotel reservations in the Niara system from an external call.

If the sent locator (Niara reservation ID) already exists, the request is treated as an update: the existing reservation will be updated with the new data instead of creating a new one.

Request​

Body

    externalId stringrequired

    Unique reservation ID from your external system.

    locator string

    Unique reservation ID from the Niara system.

    hotelId stringrequired

    Hotel ID.

    startDate stringrequired

    Check-in date (ISO 8601 format).

    endDate stringrequired

    Check-out date (ISO 8601 format).

    numberOfNights integerrequired

    Number of nights.

    status stringrequired

    Reservation status [CONFIRMED or CANCELLED].

    source string

    Reservation source.

    primaryGuestName stringrequired

    Primary guest name.

    primaryGuestCpf string

    Primary guest CPF.

    primaryGuestEmail stringrequired

    Primary guest email.

    currency stringrequired

    Currency. (ISO 4217 code)

    netPrice numberrequired

    Net price of the reservation.

    taxesPrice numberrequired

    Reservation taxes price.

    adultCount integerrequired

    Number of adults in the reservation.

    childrenCount integerrequired

    Number of children in the reservation.

    childrenAges integer[]required

    List of children's ages in the reservation.

    roomDescription stringrequired

    Reservation room name.

    ratePlanName stringrequired

    Reservation rate plan name.

    isNonRefundable booleanrequired

    Indicates if the reservation is non-refundable, true if the reservation is non-refundable.

    penaltyDate stringrequired

    Date on which the cancellation penalty applies, if the reservation is refundable. (ISO 8601)

    meal stringrequired

    Meal plan.

    comissionPrice numbernullable

    Comission price.

    comment stringnullable

    Reservation comments.

    guestJourneyStatus stringnullable

    Guest Journey Status [CHECKED_IN, CHECKED_OUT, NO_SHOW].

    primaryGuestExternalId stringnullable

    Your system's external ID for the primary guest.

    primaryGuestPassport stringnullable

    Primary guest passport number.

    primaryGuestNationality stringnullable

    Nationality of the primary guest (ISO 3166-1 alpha-2 country code).

Responses​

CreateExternalReservationResponse()

Schema
    reservationId stringrequired

    Niara's external reservation ID.

Loading...