v1

latestOpenAPI 3.0.32026-07-14133451.7 KB
Booking

Retrieve one or more booking orders

An OrdersResponse containing one or more matching booking Order records will be returned, given one or more criteria in the query string.

Results will also be paged based on offset and size.

get/booking/orders

Query parameters

customerPhoneNumberstring
Example:1234567890

Customer phone number (without country code)

customerEmailstring
Example:peter_parker@yahoo.com

Customer email address

passengerTravelDocumentNumberstring
Example:EG12345678

Travel document number, such as passport number, of a passenger

offsetinteger
sizeinteger
dateTimeStartstring date-time

A start date-time earlier than any booking order returned. It should be in ISO 8601 format (UTC).

dateTimeEndstring date-time

A end date-time later than any booking order returned. It should be in ISO 8601 format (UTC).

orderStatus'creating' | 'ready' | 'cancelled' | 'completed' | 'error'

For status definition, see OrderStatus under Order Schemas.

Response

OK

This is an OrdersResponse containing an array of zero or more Order records.

messagestring

message returned by server side if there is any