Skip to main content

HotelsByDestinationRequest

Request body for hotels by destination. When outputCodeType is "bundleport" and scope.providerCode is omitted, hotels from all providers are returned and Bundleport base-code mappings are resolved per provider (see path description).

scope object

Optional. Restrict to a single provider or connection; if omitted, hotels from all providers are returned.

providerCodestring

Provider code issued for the connection. If omitted, all providers.

connectionCodestring

Connection code; provider is resolved from it.

destination objectrequired
canonicalCityIdstringrequired

Canonical city ID (place UUID from places search). Required.

outputCodeTypestring

"provider" = only providerHotelCode per hotel. "bundleport" = providerHotelCode and bundleportHotelCode (base code) when mapped; without scope.providerCode, mappings are resolved per provider.

Possible values: [provider, bundleport]

Default value: provider
paging object
limitinteger

Possible values: >= 1 and <= 1000

Default value: 100
cursorstring

Pagination cursor from previous response

onlyBundleportRankboolean

If true, only return hotels in the bundleport rank list (source bundleport_rank_base). Ranked-only requests skip landmark spatial fallback.

Default value: false
sortstring

Use bundleport_rank to order by Bundleport rank (best sellers first); omit for default order. sort=bundleport_rank also skips landmark spatial fallback.

Possible values: [bundleport_rank]

HotelsByDestinationRequest
{
"scope": {
"providerCode": "string",
"connectionCode": "string"
},
"destination": {
"canonicalCityId": "string"
},
"outputCodeType": "provider",
"paging": {
"limit": 100,
"cursor": "string"
},
"onlyBundleportRank": false,
"sort": "bundleport_rank"
}