Rivier/ Reference/ bookings

Reserve a stay from a hold, a quote or the live price

post/lodging/reservations

Reserve a stay from a hold, a quote or the live price. Idempotent on the key; a dry run returns the reservation it would make.

Before you call

Credential
Authorization: Bearer $KEY
Scope
bookings:write
Mcp
rivier_lodging_reserve
Graphql
Mutation.createReservation
Sdk
bookings.reservation.create
Cli
bookings reservation create
Events
bookings.reservation.created, bookings.reservation.confirmed

Parameters

  • dryRunstring
    In the query

Request bodyapplication/json, required

  • propertyIdstring (uuid)required
  • roomTypeIdstring (uuid)required
  • ratePlanIdstring (uuid)required
  • arrivalstringrequired
    Pattern: ^\d{4}-\d{2}-\d{2}$.
  • departurestringrequired
    Pattern: ^\d{4}-\d{2}-\d{2}$.
  • adultsinteger
    Default: 2. At least 1. At most 20.
  • childreninteger
    Default: 0. At least 0. At most 20.
  • infantsinteger
    Default: 0. At least 0. At most 10.
  • promoCodestring
    At most 24 characters.
  • extraslist of object
    Default: [].
    • extraIdstring (uuid)required
    • quantityinteger
      Default: 1. At least 1. At most 50.
  • quotestring
    At most 4000 characters.
  • holdIdstring (uuid)
  • contactobjectrequired
    • namestringrequired
      At most 160 characters.
    • emailstring (email)
      At most 254 characters.
    • phonestring
      Pattern: ^+?[0-9 ()-]{6,20}$.
    • localestring
      At most 20 characters.
    • companystring
      At most 160 characters.
    • vatIdstring
      At most 40 characters.
  • consentobject
    Default: {}.
    • emailboolean
    • smsboolean
    • whatsappboolean
  • specialRequestsstring
    Default: . At most 2000 characters.
  • channelstring
    One of: owner, widget, api, mcp, phone, chat, import. Default: api.
  • sourcestring
    Default: direct. At most 40 characters.
  • externalIdstring
    At most 80 characters.
  • idempotencyKeystringrequired
    At most 120 characters.

Responses

  • 201application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown