Skip to main content

External Reservation Creation

POST 
/v1/api/externalReservation/create

This API endpoint allows the creation of hotel reservations from an external source. It enables clients to create booking information based on specific criteria provided in the request payload.

Clients can send a POST request to this endpoint with appropriate parameters, including details such as guest information, desired room type and check-in/out dates.

The endpoint ensures flexibility by allowing optional parameters to be included, such as special requests, payment information, and loyalty program details.

Upon successful reservation creation, the client application will receive a confirmation response containing the created booking ID.

In case of errors or conflicts during reservation creation, the response structure is designed to provide detailed information on the issue encountered, facilitating efficient error handling and resolution.

Request​

Body

    externalId stringrequired

    ID único da reserva do sistema interno.

    locator stringrequired

    ID que o hóspede conhece.

    hotelId stringrequired

    ID do Hotel.

    startDate stringrequired

    Dia do check-in. (ISO 8601)

    endDate stringrequired

    Dia do check-out. (ISO 8601)

    numberOfNights integerrequired

    Número de noites.

    status stringrequired

    Status da reserva [CONFIRMED ou CANCELLED].

    source stringrequired

    Origem da reserva.

    primaryGuestName stringrequired

    Nome do hóspede principal.

    primaryGuestCpf stringrequired

    CPF do hóspede principal.

    primaryGuestEmail stringrequired

    Email do hóspede principal.

    currency stringrequired

    Moeda. (código ISO 4217)

    netPrice numberrequired

    Valor sem impostos.

    taxesPrice numberrequired

    Valor dos impostos.

    adultCount integerrequired

    Número de adultos.

    childrenCount integerrequired

    Número de crianças.

    childrenAges integer[]required

    Lista com a idade das crianças.

    roomDescription stringrequired

    Nome do quarto.

    ratePlanName stringrequired

    Nome da tarifa.

    isNonRefundable booleanrequired

    Indica se a tarifa é não reembolsável.

    penaltyDate stringrequired

    Dia em que começa a penalidada caso reserva seja reembolsável. (ISO 8601)

    meal stringrequired

    Regime de alimentação.

    comissionPrice numbernullable

    Valor da comissão.

    comment stringnullable

    Comentários da reserva.

    guestJourneyStatus stringnullable

    Status da jornada do Hóspede [CHECKED_IN, CHECKED_OUT, NO_SHOW].

    primaryGuestExternalId stringnullable

    ID do seu sistema do hóspede principal.

Responses​

CreateExternalReservationResponse()

Schema
    reservationId stringrequired

    ID Niara da reserva criada.

Loading...