Skip to main content

RoomsResponse

rooms object
rooms object[]
  • Array [
  • codestring

    Room code

    roomData object

    Complete room data

    codestring

    Room code

    roomCodestring

    Provider-specific room code

    sourcestring

    Room source/provider

    maxOccupancyinteger

    Maximum occupancy when the provider stated it. Note that no provider currently populates it, so it is absent in practice.

    texts object[]

    Room descriptions in different languages

  • Array [
  • typestring

    Type of text (e.g., description, shortDescription)

    languageCodestring

    ISO 639-1 language code

    textstring

    Text content

  • ]
  • images object[]

    Room images

  • Array [
  • codestring

    Image code

    urlstring

    Image URL

    orderinteger

    Display order

    mediaTypestring

    Type of media

    captionstring

    Image caption

  • ]
  • occupancy object

    Occupancy details

    adultsinteger

    Number of adults

    childreninteger

    Number of children

    totalinteger

    Total occupancy

    beds object[]

    Bed information

  • Array [
  • typestring

    Bed type

    countinteger

    Number of beds

  • ]
  • bundleportRoomCodestringnullable

    Canonical room code from mapping_rooms when mapped.

    bundleportRoomCodeConfidencePctintegernullable

    How much bundleportRoomCode is worth. 0 means the canonical code is literally the provider's own code and no matching happened, so it groups nothing; 100 means a human reviewed it. Omitted when the mapping predates the confidence overlay, which should be read as unknown rather than as zero.

    Possible values: >= 0 and <= 100

    bundleportRoomCodeSourcestringnullable

    Where the mapping came from. mirror is the mapping generator, auto_passthrough is a placeholder with no matching behind it, matcher is an automatic room match and manual a human decision.

    Possible values: [mirror, auto_passthrough, matcher, manual]

    contentSourcestringnullable

    Provider code that supplied images/texts/beds when they were inherited via cross-provider fill (same hotel base + same bundleportRoomCode). Omitted when content comes from the room's own provider.

    createdAtstring<date-time>

    Record creation timestamp

    updatedAtstring<date-time>

    Record last update timestamp

  • ]
  • countinteger
    tokenstring
    warnings object[]

    Non-fatal hints about how the request was served. WARN_SANDBOX_SHARED_CATALOG means the sandbox provider has no catalog of its own and results come from the shared multi-provider catalog, so they are not scoped to that connection. WARN_PARAM_IGNORED names query fields this endpoint does not implement (for example offset, roomName or scope) and which therefore had no effect: paginate with token and filter with roomCodes or hotelCodes.

  • Array [
  • codestring
    typestring
    descriptionstring
  • ]
  • errors object[]
  • Array [
  • codestring
    typestring

    Possible values: [CLIENT, SERVER]

    descriptionstring
  • ]
  • RoomsResponse
    {
    "rooms": {
    "rooms": [
    {
    "code": "string",
    "roomData": {
    "code": "string",
    "roomCode": "string",
    "source": "string",
    "maxOccupancy": 0,
    "texts": [
    {
    "type": "string",
    "languageCode": "string",
    "text": "string"
    }
    ],
    "images": [
    {
    "code": "string",
    "url": "string",
    "order": 0,
    "mediaType": "string",
    "caption": "string"
    }
    ],
    "occupancy": {
    "adults": 0,
    "children": 0,
    "total": 0
    },
    "beds": [
    {
    "type": "string",
    "count": 0
    }
    ],
    "bundleportRoomCode": "string",
    "bundleportRoomCodeConfidencePct": 0,
    "bundleportRoomCodeSource": "mirror",
    "contentSource": "string"
    },
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }
    ],
    "count": 0,
    "token": "string"
    },
    "warnings": [
    {
    "code": "string",
    "type": "string",
    "description": "string"
    }
    ],
    "errors": [
    {
    "code": "string",
    "type": "CLIENT",
    "description": "string"
    }
    ]
    }