Rivier/ Reference/ bookings

Add a room type (a sellable product with occupancy and beds)

post/lodging/room-types

Before you call

Credential
Authorization: Bearer $KEY
Scope
bookings:admin
Mcp
rivier_lodging_room_type_create
Sdk
bookings.roomType.create
Cli
bookings room type create

Request bodyapplication/json, required

  • propertyIdstring (uuid)required
  • namestringrequired
    At most 120 characters.
  • codestringrequired
    Pattern: ^[A-Za-z0-9_-]{1,24}$.
  • descriptionstring
    Default: . At most 4000 characters.
  • maxAdultsinteger
    Default: 2. At least 1. At most 20.
  • maxChildreninteger
    Default: 0. At least 0. At most 20.
  • maxInfantsinteger
    Default: 0. At least 0. At most 20.
  • prepNightsinteger
    Default: 0. At least 0. At most 7.
  • baseAdultsinteger
    Default: 2. At least 1. At most 20.
  • bedslist of object
    Default: [].
    • typestringrequired
      At most 40 characters.
    • countintegerrequired
      At least 1. At most 10.
  • sizeM2integer or null
  • amenitieslist of string
  • sleepinglist of object
    • namestringrequired
      At most 60 characters.
    • kindstring
      One of: bedroom, living_room, studio, other. Default: bedroom.
    • bedslist of objectrequired
      • typestringrequired
        One of: single, double, queen, king, twin, sofa_bed, bunk, futon, crib, extra_bed.
      • countintegerrequired
        At least 1. At most 10.
  • bedOptionslist of object
    Default: [].
    • labelstringrequired
      At most 80 characters.
    • bedslist of objectrequired
      • typestringrequired
        One of: single, double, queen, king, twin, sofa_bed, bunk, futon, crib, extra_bed.
      • countintegerrequired
        At least 1. At most 10.
  • bedroomsinteger or null
  • bathroomsnumber or null
  • smokingstring
    One of: non_smoking, smoking, either. Default: non_smoking.
  • viewslist of string
    Default: [].
  • contentobject
    Default: {}.
  • overbookAllowanceinteger
    Default: 0. At least 0. At most 100.
  • positioninteger
    Default: 0. At least 0. At most 10000.
  • publishedboolean
    Default: false.

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