Order 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

📘

Access token

The Access token should be requested with order scope

Request

Name

Value

Description

URL

https://business-api.gett.com/v1/orders/<orderId>?businessId=<companyUUID>;

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"
                    }
                }
            ],
            "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"
                    }
                }
            }
        },
        {
            "type": "destination",
            "actions": [
                {
                    "type": "drop_off",
                    "user": {
                        "name": "Hindi Hindi",
                        "phone": "972500000000"
                    }
                }
            ],
            "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"
                    }
                }
            }
        }
    ],
    "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"
}

What’s Next
Did this page help you?