Skip to main content

CriteriaBookingListInput

CriteriaBookingListInput supports filtering bookings by ids or dates.

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)
    CriteriaBookingListInput
    {
    "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": {}
    }