BookingListRequest

Request payload for booking list

criteria objectrequired

Set typeSearch to choose the mode. With BOOKING_LIST_CRITERIA_TYPE_DATES, send dates. With BOOKING_LIST_CRITERIA_TYPE_REFERENCES, send references (one object per lookup).

typeSearchstring

Search mode

Possible values: [BOOKING_LIST_CRITERIA_TYPE_DATES, BOOKING_LIST_CRITERIA_TYPE_REFERENCES]

dates object

Date range for booking list

dateTypestring

ARRIVAL filters by stay/check-in window; BOOKING filters by booking creation time

Possible values: [BOOKING_LIST_CRITERIA_DATE_TYPE_BOOKING, BOOKING_LIST_CRITERIA_DATE_TYPE_ARRIVAL]

startstring<date-time>

Start date

endstring<date-time>

End date

references object[]

Reference-based lookup (booking id, client reference, supplier refs)

Array [

bookingIDstring

Bundleport booking id

clientReferencestring

Client-supplied reference from the book request

providerReferencestring

confirmationReferencestring

]

settings objectrequired

Common settings for all requests

requestIdstring

Unique request identifier for tracking

Example: req-123456789

connectionCodesstring[]required

List of provider connection codes to query

Possible values: >= 1

Example: ["testb-conn-1876","testb-conn-1877"]

auditTransactionsboolean

When true, responses may include auditData.transactions with supplier-level traces for debugging. Use sparingly in production; redact sensitive data in logs.

Default value: false

timeoutinteger<int32>

Client timeout hint in milliseconds; platform and supplier minimums may still apply (especially for book). For availability it is also clamped to the server maximum (60000 by default), and the clamped value is the budget forwarded to the connections, so a larger figure is silently reduced rather than honoured. No schema-level default is declared on purpose: this object is shared by every operation and the effective fallback is per-operation (availability uses 10000, book is considerably higher). Omit the field to take the server's fallback for the operation you are calling rather than sending one that would cut a longer operation short.

testModeboolean

When true, enables non-production / sandbox-oriented behaviour where supported for the connection.

Default value: false

debugData object

Additional debug data

property name*any

Additional debug data

BookingListRequest

{
  "criteria": {
    "typeSearch": "BOOKING_LIST_CRITERIA_TYPE_DATES",
    "dates": {
      "dateType": "BOOKING_LIST_CRITERIA_DATE_TYPE_BOOKING",
      "start": "2024-07-29T15:51:28.071Z",
      "end": "2024-07-29T15:51:28.071Z"
    },
    "references": [
      {
        "bookingID": "string",
        "clientReference": "string",
        "providerReference": "string",
        "confirmationReference": "string"
      }
    ]
  },
  "settings": {
    "requestId": "req-123456789",
    "connectionCodes": [
      "testb-conn-1876",
      "testb-conn-1877"
    ],
    "auditTransactions": false,
    "timeout": 0,
    "testMode": false,
    "debugData": {}
  }
}