Get list bookings

GET 
/v1/bookings

Get list bookings

Supported roles

• Partner
• Fleet manager

Request

Query Parameters

fromDate string

Pickup date from

toDate string

Pickup date to

page integer

Possible values: >= 1

Page number, starts at 1

Responses

200

List of bookings

application/json

Schema

Schema

page integer
size integer
total integer
list object[]
Array [
bookId stringrequired
source string
Booking source:
• Command Center
• Car-hailing
• Street sharing
• Partner
• Passenger app
• API
• PWA
• Booking.com
• HolidayTaxis
• Hoppa
status string
Booking status:
• accepted - Provider accepted
• driverAssigned - Booking has been assigned to driver
• driverOnTheWay - Driver has started job and on the way to the pickup point
• passengerOnBoard - Passenger has been picked up
• droppedOff - Dropped off
• canceled - Canceled
• passengerNoShow - Passenger was a no-show
• incident - Booking has been marked as incident by the provider
• completed - Completed
bookingReference string
passenger object
title string
firstName string
lastName string
phone stringrequired
Phone number in E.164 format
email string
driver object
phone string
Phone number in E.164 format
firstName string
lastName string
pickup object
latitude numberrequired
Possible values: >= -90 and <= 90
longitude numberrequired
Possible values: >= -180 and <= 180
address string
city string
country string
postcode string
destination object
latitude numberrequired
Possible values: >= -90 and <= 90
longitude numberrequired
Possible values: >= -180 and <= 180
address string
city string
country string
postcode string
pickupDateTime date-time
Pickup time in UTC timezone
vehicleType string
comment string
noPassengers integer
Number of passengers
noLuggage integer
Number of luggage
price object
value numberrequired
currency stringrequired
]

Example (from schema)

{
  "page": 0,
  "size": 0,
  "total": 0,
  "list": [
    {
      "bookId": "93123613947",
      "source": "Passenger app",
      "status": "accepted",
      "bookingReference": "62549263846",
      "passenger": {
        "title": "Mr",
        "firstName": "David",
        "lastName": "James",
        "phone": "+12051234567",
        "email": "passenger@example.com"
      },
      "driver": {
        "phone": "+12051234567",
        "firstName": "Curtis",
        "lastName": "Jones"
      },
      "pickup": {
        "latitude": 42.94389871922842,
        "longitude": -87.90088398474458,
        "address": "Milwaukee Mitchell International Airport",
        "city": "Milwaukee",
        "country": "US",
        "postcode": "53207"
      },
      "destination": {
        "latitude": 43.203405744324265,
        "longitude": -87.90498301216061,
        "address": "225 Trillium Rd, Mequon, WI 53092, USA",
        "city": "Mequon",
        "country": "US",
        "postcode": "53092"
      },
      "pickupDateTime": "2024-02-19T16:46:45.000Z",
      "vehicleType": "Sedan",
      "comment": "simple notes",
      "noPassengers": 3,
      "noLuggage": 0,
      "price": {
        "value": 68.86,
        "currency": "USD"
      }
    }
  ]
}

400

Invalid input

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "string"
}

401

Unauthorized

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "string"
}

Loading...