Booking Details
After requesting an order you can request the order details via the API, all orders of the customer can be retrieved via API even if they were created from the web or the app. but only if you have the order id
the order details may include new fields every time you will request them according to the order state
e.g. if the ride in routing state and there is no driver assigned you won't have the driver fields in the response but you will have them once the driver is assigned
Please note
Driver details are available only during the ride. you are not allowed to use any of the driver details for any reason except for the in-progress ride itself.
in some cases, the driver's phone will be masked as part of the supplier/Gett privacy policy.
Order details response doesn't include financial info, you can request financial info via Order receipt
Request
| Name | Value | Description |
|---|---|---|
| URL | /v1/orders/<order_id>?businessId={{businessid}} | Request URL to get order info |
| orderId | string | Order ID obtained in Create order request |
| businessId | UUID | UUID corresponds to the company. (given by Gett Support) |
curl --location -g --request GET 'https://business-api.gett.com/v1/orders/<orderId>?businessId=<companyUUID>' \
--header 'Authorization: Bearer <access token>' \
--header 'Accept: application/json'
| name | description |
|---|---|
| requested_at | The time of order creation |
| scheduled_at | The time for when the order was scheduled, for on-demand order the scheduled_at = requested_at |
| will_arrive_at_pickup | Estimated time of the driver/courier arrival |
| pickedup_at | The time when driver/courier left the origin |
| droppedoff_at | The time when the order completed |
| supplier.name | supplier name |
| supplier.code | some suppliers require a code to be given to the driver to start/complete the ride |
| supplier.driver.name | Driver name |
| supplier.driver.phone | Driver phone number - usually masked number |
| supplier.driver.image_url | Photo of the driver |
| supplier.driver.rating | Driver rating |
| supplier.driver.vehicle.model | Car model |
| supplier.driver.vehicle.color | Car color |
| supplier.driver.vehicle.license_plate | Car plate number |
| supplier.driver.location.lat | Latitude of driver location |
| supplier.driver.location.lng | Longitude of driver location |
| supplier.driver.location.bearing | Driving direction |
| supplier.driver.license.number | driver license number provided by the supplier |
| supplier.driver.license.type | type of driver license e.g. PHL and TLC |
Please note
Part of driver details may be missing due to supplier technology
Response
Response format see in Create order request body.
{
"id": 3487119,
"status": "Confirmed",
"business_id": "6eaaa6cf-3bdc-500f58006",
"category": "transportation",
"product_id": "8d50ef79-2530-4924-b89e-10ed9f035d8b",
"scheduled_at": "2021-03-14T09:50:52+02:00",
"quote_id": "64f78b1d-c19a-4f3c-8bb4-af518ab8478d",
"stops": [
{
"type": "origin",
"actions": [
{
"type": "pick_up",
"user": {
"name": "Hindi Hindi",
"phone": "972500000000"
}
},
"status": "picked_up"
],
"location": {
"lat": 31.95272,
"lng": 34.8957085,
"address": {
"full_address": "HaRav Kuk St 10, Lod, Israel",
"city": "Lod",
"house": "10",
"street": "HaRav Kuk Street",
"country": "IL",
"address_place": {
"provider": "google",
"id": "ChIJlUmBflfKAhURwtmnxNXKX-Q"
}
}
},
"progress_status": "Completed"
},
{
"type": "destination",
"actions": [
{
"type": "drop_off",
"user": {
"name": "Hindi Hindi",
"phone": "972500000000"
},
"status": "dropped_off"
},
],
"location": {
"lat": 31.984621,
"lng": 34.951736,
"address": {
"full_address": "Bet Nehemya Junction, Israel",
"city": "Center District",
"country": "IL",
"address_place": {
"provider": "google",
"id": "ChIJbwHyOVYzHRURSuxz1Pcry4Q"
}
}
},
"progress_status": "Completed"
}
],
"payment_type": "account",
"note_to_driver": "another test",
"references": [
{
"id": 39,
"title": "Reason for travel",
"value": "123"
}
],
"supplier": {
"name": "",
"code": "",
"driver": {
"name": "Jhon smith",
"phone": "054-0000000",
"image_url": "https://public.gett.com/prod/img/drivers/prod.3d2a9a3d-7a9c-46e1-9ec5-05244e06722c.jpeg",
"rating": 4.98,
"vehicle": {
"model": "mercedes-C200",
"color": "white",
"license_plate": "2621626"
},
"location": {
"lat": 32.1082395,
"lng": 34.8381143,
"bearing": 187.00612
},
"license": {
"number":"",
"type" :""
}
},
"requested_at": "2021-03-13T23:00:27+02:00",
"will_arrive_at_pickup": "2021-03-14T09:38:52+02:00"
}
Delivery
{
"id": 9629185,
"status": "confirmed",
"business_id": <companyUUID>,
"category": "delivery",
"product_id": "cef53771-ab20-48d9-a5bd-64d0160eed4d",
"scheduled_at": "2022-04-18T16:40:00+03:00",
"quote_id": "99f48eb9-5b7c-4795-811c-9313ad11b367",
"stops":[
{
"type": "origin",
"actions": [
{
"type": "pick_up",
"user": {
"name": "Morvius H",
"phone": "972500000000"
},
"parcel": {
"id": "4af534f9-e5cc-49fb-82bf-8eba818f4eb7",
"name": "4455"
},
"status": "not_picked_up"
},
{
"type": "pick_up",
"user": {
"name": "Morvius H",
"phone": "972500000000"
},
"parcel": {
"id": "70b3e5ea-c490-4eea-815c-c935c2426df2",
"name": "5665"
},
"status": "picked_up"
},
{
"type": "pick_up",
"user": {
"name": "Morvius H",
"phone": "972500000000"
},
"parcel": {
"id": "d71a616e-18e8-4736-adc8-5c9c4c026df6",
"name": "5566"
},
"status": "picked_up"
}
],
"location": {
"lat": 32.1147634,
"lng": 34.8342194,
"address": {
"full_address": "Atarot St 6, Tel Aviv-Yafo, Israel",
"city": "Tel Aviv-Yafo",
"house": "6",
"state": "",
"street": "Atarot Street",
"country": "IL",
"postcode": "",
"notes": "call me on arrival",
"address_place": {
"provider": "google",
"id": "ChIJ8fpB-r1JHRURwnQJ-G4A2IE"
}
}
},
"progress_status": "Completed"
},
{
"type": "on_going",
"actions": [
{
"type": "drop_off",
"user": {
"name": "Dan",
"phone": "972500000001"
},
"parcel": {
"id": "4af534f9-e5cc-49fb-82bf-8eba818f4eb7",
"name": "4455"
},
"status": "not_dropped_off"
}
],
"location": {
"lat": 32.1137948,
"lng": 34.8053246,
"address": {
"full_address": "Klausner St 15, Tel Aviv-Yafo, 6139202, Israel",
"city": "Tel Aviv-Yafo",
"house": "15",
"state": "",
"street": "Klausner Street",
"country": "IL",
"postcode": "6139202",
"notes": "floor 1, door 3",
"address_place": {
"provider": "google",
"id": "ChIJP7Ftj29JHRURuSCAhmPbOHs"
}
}
},
"progress_status": "Cancelled"
},
{
"type": "destination",
"actions": [
{
"type": "drop_off",
"user": {
"name": "John",
"phone": "972500000002"
},
"parcel": {
"id": "70b3e5ea-c490-4eea-815c-c935c2426df2",
"name": "5665"
},
"status": "dropped_off"
},
{
"type": "drop_off",
"user": {
"name": "John",
"phone": "972500000002"
},
"parcel": {
"id": "d71a616e-18e8-4736-adc8-5c9c4c026df6",
"name": "5566"
},
"status": "dropped_off"
}
],
"location": {
"lat": 32.1470845,
"lng": 34.8403358,
"address": {
"full_address": "Yehuda St 10, Ramat Hasharon, Israel",
"city": "Ramat Hasharon",
"house": "10",
"state": "",
"street": "Yehuda Street",
"country": "IL",
"postcode": "",
"notes": "enterance code 112254",
"address_place": {
"provider": "google",
"id": "ChIJJ7iKVUdIHRUROGXzzVDZqWk"
}
}
},
"progress_status": "Completed"
}
],
"payment_type": "account",
"note_to_driver": "",
"references": [
{
"id": 8946,
"title": "cost centre",
"value": "delivery to employees"
}
],
"supplier": {
"name": "",
"code": "",
"driver": {
"name": "Jhon smith",
"phone": "972540000000",
"image_url": "https://public.gett.com/prod/img/drivers/prod.3d2a9a3d-7a9c-46e1-9ec5-05244e06722c.jpeg",
"rating": 4.98,
"vehicle": {
"model": "Scooter",
"color": "",
"license_plate": "2621626"
},
"location": {
"lat": 32.1082395,
"lng": 34.8381143,
"bearing": 187.00612
},
"license": {
"number":"",
"type" :""
}
},
"will_arrive_at_pickup": "2022-04-18T16:30:52+03:00",
"requested_at": "2022-04-09T13:08:36+00:00"
}
Updated 4 days ago
What’s Next