Create custom booking
POST/v2/bookings
Create custom booking
Supported roles
- Fleet manager
Request
- application/json
Body
- Array [
- ]
Possible values: Value must match regular expression ^[0-9a-f]{24}$
Vehicle Type ID: Get vehicle types
Possible values: Value must match regular expression ^[0-9a-f]{24}$
Corporate ID
Pickup time can either be a specific date-time in ISO 8601 format for reservation or the string ASAP
for on-demand booking.
Pickup timezone. Default is based on the pickup location
price objectrequired
pickup objectrequired
Pick up point
Possible values: >= -90
and <= 90
Possible values: >= -180
and <= 180
destination objectrequired
Drop off point
Possible values: >= -90
and <= 90
Possible values: >= -180
and <= 180
passenger objectrequired
Phone number in E.164 format
extraFees object[]
Responses
- 200
- 400
- 401
- 403
Create booking successfully
- application/json
- Schema
- Example (from schema)
Schema
API
accepted
- Provider accepted
Booking source:
Booking status:
passenger object
Phone number in E.164 format
driver object
Phone number in E.164 format
pickup object
Possible values: >= -90
and <= 90
Possible values: >= -180
and <= 180
destination object
Possible values: >= -90
and <= 90
Possible values: >= -180
and <= 180
Pickup time in UTC timezone
Number of passengers
Number of luggage
price object
{
"bookId": "93123613947",
"source": "API",
"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"
}
}
Validation error
- application/json
- Schema
- Example (from schema)
Schema
{
"message": "string"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
{
"message": "string"
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
{
"message": "string"
}