HotelsRequest

scope object

Preferred filter payload for hotel queries.

connectionCodestring

Connection code; provider is resolved from it when using X-Environment.

providerCodestring

Provider scope; defaults to provider inferred from connectionCode when present.

languagestring

Language tag for the returned descriptions. The fallback chain is: exact tag, then the same base language (a request for es-MX accepts es), then English, then every language we hold. Omit it to receive all languages and filter client-side, which is the current behaviour. Content is ingested in English today, so most properties answer with en.

Example: es

hotelCodesstring[]

Hotel codes (provider-specific) to fetch.

hotelsstring[]

Alias for hotelCodes (frontend compatibility).

providerHotelCodesstring[]

Provider-specific hotel codes.

destinationCodesstring[]

Filter by destination/place codes (hotel_closest_destinations).

destinationNamestring

Search by destination name (partial match, case-insensitive).

countriesstring[]

Filter by country codes (ISO 3166-1 alpha-2).

ranksinteger[]

maxSizeinteger

Maximum number of results to return (0 = use default).

hotelNamestring

Partial match search on hotel name (case-insensitive).

categorystring

Single category filter (e.g. 3STAR). Prefer categories for multi-value.

groupstringdeprecated

Deprecated; use category instead.

outputCodeTypestring

Controls cross-reference ids on each hotel (parity with /hotels/by-destination and /hotels/by-coordinates):

• "bundleport" (default): include externalIds (bundleportBaseCode, providerPropertyIds).
• "provider": provider-native view; externalIds is omitted. Note: on this endpoint code and providerHotelCode are always the provider-native code. The Bundleport base code lives in externalIds.bundleportBaseCode, not in code.

Possible values: [provider, bundleport]

Default value: bundleport

returnHotelCodesstring[]

Accepted for cross-endpoint consistency but a NO-OP here: POST /hotels always returns the base code in externalIds.bundleportBaseCode. The two-array form (hotelCodes.base[]/provider[]) is exclusive to POST /hotels/filter. When set, the response includes a WARN_PARAM_FILTER_ONLY warning.

Possible values: [base, provider]

includeRoomDetailboolean

When true, hydrate each hotel's rooms[] with full detail (images, descriptions, beds, occupancy) inline instead of the basic room list. Opt-in; capped server-side.

query object

Standard filter payload for hotel queries.

connectionCodestring

Connection code; provider is resolved from it when using X-Environment.

providerCodestring

Provider scope; defaults to provider inferred from connectionCode when present.

languagestring

Language tag for the returned descriptions. The fallback chain is: exact tag, then the same base language (a request for es-MX accepts es), then English, then every language we hold. Omit it to receive all languages and filter client-side, which is the current behaviour. Content is ingested in English today, so most properties answer with en.

Example: es

hotelCodesstring[]

Hotel codes (provider-specific) to fetch.

hotelsstring[]

Alias for hotelCodes (frontend compatibility).

providerHotelCodesstring[]

Provider-specific hotel codes.

destinationCodesstring[]

Filter by destination/place codes (hotel_closest_destinations).

destinationNamestring

Search by destination name (partial match, case-insensitive).

countriesstring[]

Filter by country codes (ISO 3166-1 alpha-2).

ranksinteger[]

maxSizeinteger

Maximum number of results to return (0 = use default).

hotelNamestring

Partial match search on hotel name (case-insensitive).

categorystring

Single category filter (e.g. 3STAR). Prefer categories for multi-value.

groupstringdeprecated

Deprecated; use category instead.

outputCodeTypestring

Controls cross-reference ids on each hotel (parity with /hotels/by-destination and /hotels/by-coordinates):

• "bundleport" (default): include externalIds (bundleportBaseCode, providerPropertyIds).
• "provider": provider-native view; externalIds is omitted. Note: on this endpoint code and providerHotelCode are always the provider-native code. The Bundleport base code lives in externalIds.bundleportBaseCode, not in code.

Possible values: [provider, bundleport]

Default value: bundleport

returnHotelCodesstring[]

Accepted for cross-endpoint consistency but a NO-OP here: POST /hotels always returns the base code in externalIds.bundleportBaseCode. The two-array form (hotelCodes.base[]/provider[]) is exclusive to POST /hotels/filter. When set, the response includes a WARN_PARAM_FILTER_ONLY warning.

Possible values: [base, provider]

includeRoomDetailboolean

When true, hydrate each hotel's rooms[] with full detail (images, descriptions, beds, occupancy) inline instead of the basic room list. Opt-in; capped server-side.

tokenstring

Pagination token for the next page of results. To retrieve the next page, include this token in the 'token' field of the subsequent request. Tokens are valid for 4 minutes and are tied to the original query criteria. If the query criteria change, a new token must be generated.

HotelsRequest

{
  "scope": {
    "connectionCode": "string",
    "providerCode": "string",
    "language": "es",
    "hotelCodes": [
      "string"
    ],
    "hotels": [
      "string"
    ],
    "providerHotelCodes": [
      "string"
    ],
    "destinationCodes": [
      "string"
    ],
    "destinationName": "string",
    "countries": [
      "string"
    ],
    "ranks": [
      0
    ],
    "maxSize": 0,
    "hotelName": "string",
    "category": "string",
    "outputCodeType": "bundleport",
    "returnHotelCodes": [
      "base"
    ],
    "includeRoomDetail": true
  },
  "query": {
    "connectionCode": "string",
    "providerCode": "string",
    "language": "es",
    "hotelCodes": [
      "string"
    ],
    "hotels": [
      "string"
    ],
    "providerHotelCodes": [
      "string"
    ],
    "destinationCodes": [
      "string"
    ],
    "destinationName": "string",
    "countries": [
      "string"
    ],
    "ranks": [
      0
    ],
    "maxSize": 0,
    "hotelName": "string",
    "category": "string",
    "outputCodeType": "bundleport",
    "returnHotelCodes": [
      "base"
    ],
    "includeRoomDetail": true
  },
  "token": "string"
}