HotelsRequest

Request payload for retrieving hotels

scope object

Preferred filter payload for hotel queries.

connectionCodestring

Optional connection code for filtering

providerCodestring

Optional provider scope; defaults to the provider inferred from the connection

hotelCodesstring[]

List of hotel codes to filter by

providerHotelCodesstring[]

Provider-specific hotel codes

destinationCodesstring[]

Destination codes where hotels should be located

countriesstring[]

Country codes to filter by

ranksinteger[]

Hotel ranking values to filter by

maxSizeinteger

Maximum number of results to return

hotelNamestring

Hotel name to search for (partial match)

groupstring

Hotel group identifier

query object

Standard filter payload for hotel queries.

connectionCodestring

Optional connection code for filtering

providerCodestring

Optional provider scope; defaults to the provider inferred from the connection

hotelCodesstring[]

List of hotel codes to filter by

providerHotelCodesstring[]

Provider-specific hotel codes

destinationCodesstring[]

Destination codes where hotels should be located

countriesstring[]

Country codes to filter by

ranksinteger[]

Hotel ranking values to filter by

maxSizeinteger

Maximum number of results to return

hotelNamestring

Hotel name to search for (partial match)

groupstring

Hotel group identifier

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",
    "hotelCodes": [
      "string"
    ],
    "providerHotelCodes": [
      "string"
    ],
    "destinationCodes": [
      "string"
    ],
    "countries": [
      "string"
    ],
    "ranks": [
      0
    ],
    "maxSize": 0,
    "hotelName": "string",
    "group": "string"
  },
  "query": {
    "connectionCode": "string",
    "providerCode": "string",
    "hotelCodes": [
      "string"
    ],
    "providerHotelCodes": [
      "string"
    ],
    "destinationCodes": [
      "string"
    ],
    "countries": [
      "string"
    ],
    "ranks": [
      0
    ],
    "maxSize": 0,
    "hotelName": "string",
    "group": "string"
  },
  "token": "string"
}