BookingListRequest

BookingListRequest retrieves multiple bookings based on filters.

criteria object

Criteria that define which bookings should be returned.

typeSearchtypeSearch (string)

Defines whether filtering is performed by dates or references.

Possible values: [BOOKING_LIST_CRITERIA_TYPE_DATES, BOOKING_LIST_CRITERIA_TYPE_REFERENCES]

references object[]

Booking references used when performing a reference lookup.

Array [

bookingIDbookingID (string)

Aggregator booking identifier.

clientReferenceclientReference (string)

Client reference provided at booking time.

providerReferenceproviderReference (string)

Provider booking reference.

confirmationReferenceconfirmationReference (string)

Confirmation reference provided to the traveller.

]

dates object

Date range used when filtering by time period.

dateTypedateType (string)

Date dimension used for the range filter.

Possible values: [BOOKING_LIST_CRITERIA_DATE_TYPE_BOOKING, BOOKING_LIST_CRITERIA_DATE_TYPE_ARRIVAL]

startstring<date-time>

Range start timestamp.

endstring<date-time>

Range end timestamp.

additionalParams object

Additional provider-specific parameters.

property name*value (string)

settings object

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.

BookingListRequest

{
  "criteria": {
    "typeSearch": "BOOKING_LIST_CRITERIA_TYPE_DATES",
    "references": [
      {
        "bookingID": "string",
        "clientReference": "string",
        "providerReference": "string",
        "confirmationReference": "string"
      }
    ],
    "dates": {
      "dateType": "BOOKING_LIST_CRITERIA_DATE_TYPE_BOOKING",
      "start": "2024-07-29T15:51:28.071Z",
      "end": "2024-07-29T15:51:28.071Z"
    },
    "additionalParams": {}
  },
  "settings": {
    "requestId": "string",
    "accessIds": [
      "string"
    ],
    "pos": {
      "branchOffice": "string"
    },
    "auditTransactions": true,
    "timeout": 0,
    "testMode": true,
    "debugData": true,
    "token": "string"
  }
}