SearchRequest

SearchRequest aggregates settings and criteria for hotel availability searches.

criteria objectrequired

Stay details, guests, filters, and preferences.

checkInstring<date-time>required

Check-in date for the requested stay.

checkOutstring<date-time>required

Check-out date for the requested stay.

hotelsstring[]

Provider hotel identifiers to limit the search scope.

exclusions object[]

Elements that must be excluded from the results.

Array [

typetype (string)

Type of element being excluded (for example HOTEL or ROOM).

keykey (string)

Identifier or field associated with the exclusion type.

valuesstring[]

Values that should be excluded for the given type/key combination.

]

occupancies object[]required

Occupancies requested; one entry per room configuration.

Array [

paxes object[]required

Travellers assigned to the room.

Array [

ageinteger<int32>

Traveller age at check-in time.

]

]

businessRules object

Business rules to apply when curating results.

businessRulesTypebusinessRulesType (string)

Optimisation strategy that the aggregator should apply.

Possible values: [CHEAPER_AMOUNT, ROOM_TYPE]

optionsQuotainteger<int32>

Maximum number of options per board and rate plan to return per provider when applicable.

languagelanguage (string)

ISO 639-1 language code for textual content.

currencycurrency (string)

ISO 4217 currency code used for prices.

nationalitynationality (string)

ISO 3166 alpha-2 nationality code for guests.

additionalParams object

Provider-specific additional parameters forwarded as-is.

property name*value (string)

settings objectrequired

Execution settings shared across aggregator requests.

requestIdrequestId (string)

Unique identifier used to correlate downstream provider calls and responses.

accessIdsstring[]

Provider access identifiers that the request should target.

pos object

Point of sale information for commercial routing.

branchOfficebranchOffice (string)

Branch or office that originated the enquiry, when available.

auditTransactionsauditTransactions (boolean)

When true, raw provider transactions are collected for auditing.

timeoutinteger<int32>

Maximum time in milliseconds allowed for the aggregator to respond.

testModetestMode (boolean)

Enables sandbox flows where providers expose dedicated mock behaviour.

debugDatadebugData (boolean)

Enables diagnostic payloads that surface debug data in responses.

tokentoken (string)

Token that propagates caller authentication to downstream services.

SearchRequest

{
  "criteria": {
    "checkIn": "2024-07-29T15:51:28.071Z",
    "checkOut": "2024-07-29T15:51:28.071Z",
    "hotels": [
      "string"
    ],
    "exclusions": [
      {
        "type": "string",
        "key": "string",
        "values": [
          "string"
        ]
      }
    ],
    "occupancies": [
      {
        "paxes": [
          {
            "age": 0
          }
        ]
      }
    ],
    "businessRules": {
      "businessRulesType": "CHEAPER_AMOUNT",
      "optionsQuota": 0
    },
    "language": "string",
    "currency": "string",
    "nationality": "string",
    "additionalParams": {}
  },
  "settings": {
    "requestId": "string",
    "accessIds": [
      "string"
    ],
    "pos": {
      "branchOffice": "string"
    },
    "auditTransactions": true,
    "timeout": 0,
    "testMode": true,
    "debugData": true,
    "token": "string"
  }
}