Skip to main content

HotelFilterResponse

hotelCodes object

Hotel codes in requested formats. base and provider are position-aligned (base[i] corresponds to provider[i]). Prefer pairs to avoid relying on index alignment.

basestring[]

Bundleport/canonical hotel codes (if returnHotelCodes includes "base"). Position-aligned with provider[].

providerstring[]

Provider-specific hotel codes (if returnHotelCodes includes "provider"). Position-aligned with base[].

pairs object[]

Explicit base<->provider pairing (index-independent). Present when both base and provider codes are requested. Use this to build the mapping without relying on array position.

  • Array [
  • basestringrequired

    Bundleport/canonical hotel code (provider code echoed when unmapped).

    providerstringrequired

    Provider-specific hotel code.

  • ]
  • totalCountinteger

    Number of matching hotels returned

    Example: 150
    nextCursorstringnullable

    Cursor for next page (null if no more results)

    filters object

    Tracks which filters were applied vs ignored

    appliedstring[]

    List of filter names that were applied

    Example: ["canonicalCityId","categories","boardCodes"]
    ignoredstring[]

    List of filters that were ignored (e.g., exceeded limits)

    Example: ["pageSize>5000 (capped to 5000)"]
    HotelFilterResponse
    {
    "hotelCodes": {
    "base": [
    "string"
    ],
    "provider": [
    "string"
    ],
    "pairs": [
    {
    "base": "string",
    "provider": "string"
    }
    ]
    },
    "totalCount": 150,
    "nextCursor": "string",
    "filters": {
    "applied": [
    "canonicalCityId",
    "categories",
    "boardCodes"
    ],
    "ignored": [
    "pageSize>5000 (capped to 5000)"
    ]
    }
    }