Skip to navigation

List bookings

List your bookings.

What: your organisation’s bookings, newest first (cursor-paginated via meta.pagination.nextCursor). Only the bookings of the environment your key belongs to (Test or Live).

When: an itinerary / orders dashboard, or to find a booking whose /book answer you never received.

Filters (all optional, combined with AND):

  • status — one status, or repeat the parameter for several (?status=HELD&status=CONFIRMED, at most 10): a booking in any of them is listed. Each value must be a known status.
  • supplierCode, pnr (exact airline PNR).
  • externalReference — exact, case-sensitive match on the reference you sent on /book. After a lost /book answer, list with it: each row is a booking that carries that reference (Kitionz does not require references to be unique); an empty list means none does.
  • departureFrom / departureTo — the departure date (the first flight), YYYY-MM-DD, both inclusive. Not the day the booking was made.
  • createdFrom / createdTo — the day the booking was created, YYYY-MM-DD in India time (IST): 27 October runs from 00:00 to 23:59:59 IST (18:30 UTC on the 26th to 18:30 UTC on the 27th). Both inclusive. Use these for “bookings made today”.

Old names, accepted until the next release, which removes them: sourceCode (now supplierCode), fromDate / toDate (now departureFrom / departureTo). An old and a new name with different values → 400 VALIDATION_ERROR naming both. Any other parameter is refused with 400 VALIDATION_ERROR naming it, so a misspelt filter never returns an unfiltered list. Each row carries externalReference (null when none was sent).

Read the new names — the old ones are removed in the next release. Each new name has the same value as its old one until then, and the reference marks the old name deprecated. Each row: supplierCode for sourceCode; origin / destination ({ iataCode, name, city, countryCode, timezone }) for originCode / destCode; price { totalAmount, currency } for totalAmount / currency (the full price block is on GET /v1/flights/bookings/{id}).

Authentication

AuthorizationBearer

Your Kitionz API key, sent as Authorization: Bearer keyId:secret. Create a Test key at sandbox.kitionz.com → API keys, a Live key at kitionz.com → API → API keys.

Query parameters

statusenum or list of enumsOptional

Only bookings in this status. Repeat the parameter for several statuses (?status=HELD&status=CONFIRMED, at most 10): a booking in any of them is listed.

pnrstringOptionalformat: "^[^\u0000-\u0008\u000B\u000C\u000E-\u001F\u007F-\u009F]*$"1-64 characters
Only bookings with exactly this airline PNR.
externalReferencestringOptionalformat: "^[^\u0000-\u0008\u000B\u000C\u000E-\u001F\u007F-\u009F]*$"1-120 characters

Only bookings whose externalReference (the reference you sent on /book) is exactly this value. Case-sensitive.

createdFromstringOptional

Only bookings created on or after this calendar day, YYYY-MM-DD, counted in India time (IST, UTC+05:30): 27 October starts at 00:00 IST, which is 18:30 UTC on 26 October.

createdTostringOptional

Only bookings created on or before this calendar day (the whole day, to 23:59:59 IST), YYYY-MM-DD, counted in India time (IST, UTC+05:30).

supplierCodestringOptionalformat: "^[^\u0000-\u0008\u000B\u000C\u000E-\u001F\u007F-\u009F]*$"2-50 characters

Only bookings from this supplier (its supplier code).

departureFromstringOptional

Only bookings whose DEPARTURE date (the date of the first flight) is on or after this date, YYYY-MM-DD. Not the day the booking was made: use createdFrom for that.

departureTostringOptional

Only bookings whose DEPARTURE date (the date of the first flight) is on or before this date, YYYY-MM-DD. Not the day the booking was made: use createdTo for that.

limitintegerOptional1-100Defaults to 25
cursorstringOptionalformat: "^[^\u0000-\u0008\u000B\u000C\u000E-\u001F\u007F-\u009F]*$"<=120 characters

Response

Default Response
successboolean
statusCodedouble
datalist of objects
metaobject