Ride Request

๐Ÿ‘

Duplications

to prevent order duplicates you can send X-Request-ID ( value: string) in the header

โ—๏ธ

Roaming/global rides

To request a global/roaming ride (out of the client's country of origin) providing full address breakdown is mandatory

Request

Request URL

--request POST 'https://business-api.gett.com/v1/orders?businessId={businessid}
NameTypeDescription
businessIdUUIDAccount identifier obtained from Gett while generating credentials
categorystringTransportation for a ride
Delivery to send a package
product_IDstringUUID corresponds to available product in the pickup. Obtained from Get Products request.
scheduled_atstringThe schedule time in format ISO8601: yyyy-mm-ddThh:mm:ss+Z
(example: 2017-12-05T18:59:23+03:00).

If the parameter is not passed it will default to on-demand
quote_idstringUnique id for pre-requested price estimation. Obtained from Price estimation request
stopsarrayThe object containing the information about the stops/waypoints, for the ride.
stops[x].type stringRepresents the type of the stops:
origin
on_going
destination
stops[x].actions arrayThe object contains the passengers info and the relationship for the specific stops e.g. pickup/drop-off in stops
stops[x].actions.type stringRepresents the type of the action to be performed by the driver:
pick_up
stop_by
drop_off
stops[x].actions.user objectA JSON dictionary containing the the passenger name and phone number
stops[x].actions.user. name stringPassenger name
stops[x].actions.user. phone stringThe phone number of the rider.
NOTE:phone numbers must be passed in the international format (without "+" sign) as specified in RFC3966.
stops[x].location objectA JSON dictionary containing the the location details
stops[x].location.lat floatLocation latitude
stops[x].location.lng floatLocation longitude
stops[x].location.full_address (optional)stringAddress display name
stops[x].location.address (optional)objectA JSON dictionary containing the the address details
stops[x].location.address.address_place (optional)objectAddress provider details
stops[x].location.address.id(optional)stringAddresses id from provider e.g google provider id
stops[x].location.address.provider (optional)stringProvider name, Gett supports different address providers e.g GOOGLE, POSTCODE, and HERE
stops[x].location.address.city (optional)stringCity name for stop point address
stops[x].location.address.country (optional)stringCountry name for stop point address
stops[x].location.address.full_address (optional)stringAddress in one string for stop point
stops[x].location.address.house (optional)stringHouse number for stop point address
stops[x].location.address.notes (optional)stringNotes for stop point
stops[x].location.address.postcode (optional)stringPostal code for stop point address
stops[x].location.address.state (optional)stringState for stop point address
stops[x].location.address.street (optional)stringStreet name for stop point address
note_to_driver (optional)stringMessage to the driver up to 100 chars
references (optional)object Additional fields for ride - for some clients this object is mandatory. review company settings

if your are integrating on behalf of a client, be mindful that the client can add mandatory reference fields at any moment from the web platform and the integration should be able to support it
reference[x].id (optional)intAdditional field identificator
reference[X].value (optional)stringAdditional field value
payment_type (optional)stringThe payment method of the company, if not provided company default will be used
flight_details objectflight details are required for airport pickups, mainly for pre-booked orders
flight_details.flight_numberstringIATA flight code e.g. "BA164"
flight_details.flight_trackingbooleanif TRUE the flight will be tracked and rider scheduled_at will be adjusted automatically

flight details and ride scheduled time must be valid and aligned
flight_details.offset_from_flightintthe time in minutes you have added after flight landing time, if provided the system will keep this time as additional minutes after the new landing time, if the flight landing time was updated/changed.

e.g.
flight lands at 10:00
the requested scheduled_at is 10:50
the offset value must be set to 50 if flight tracking is set to TRUE

if the offset was set but not added to scheduled_at, it won't be added automatically at booking but only in case of landing time change

โ—๏ธ

please note

Two or more consecutive addresses on the route can't be identical.

Single Passenger Ride Request

curl --location --request POST 'https://business-api.gett.com/v1/orders?businessId=<companyUUID>' \
--header 'Authorization: Bearer <access token>' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
    "category": "transportation",
    "product_id": "d839bf31-200d-4b5c-b735-3f2101c19a6c",
    "scheduled_at": "2023-01-25T20:45:00+00:00",
    "quote_id": null,
    "stops": [
        {
            "type": "origin",
            "actions": [
                {
                    "type": "pick_up",
                    "user": {
                        "name": "Passenger 1",
                        "phone": "447000000000"
                    }
                }
            ],
            "location": {
                "lat": 51.4585709149735,
                "lng": -0.4453791457396373,
                "address": {
                    "full_address": "Heathrow Terminal 4, Hounslow TW6 3XA, UK",
                    "address_place": {
                        "id": "ChIJJV-0krhzdkgRp4xHVJwUCVQ",
                        "provider": "GOOGLE"
                    }
                }
            }
        },
        {
            "type": "destination",
            "actions": [
                {
                    "type": "drop_off",
                    "user": {
                        "name": "Passenger 1",
                        "phone": "447000000000"
                    }
                }
            ],
            "location": {
                "lat": 51.52289,
                "lng": -0.1136,
                "address": {
                    "full_address": "Gett UK, Elm House 10-16, Elm Street, London WC1X 0BJ",
                    "address_place":{
                     "id": "GB|RM|A|55201188",
                     "provider":"POSTCODE"  
                    }
                }
            }
        }
    ],
    "note_to_driver": "",
    "flight_details": {
        "flight_number": "BA164",
        "flight_tracking": true,
        "offset_from_flight": 60
    },
    "references": [
        {
            "id": 8946,
            "value": "Tech"
        },
        {
            "id": 9557,
            "value": "Product"
        }
    ]
}'

Single Passenger Ride Response

{
    "id": 1307,
    "status": "Pending",
    "business_id": "6eaaa6cf-3bdc-4393-a8cf-22b500f58006",
    "category": "transportation",
    "product_id": "d839bf31-200d-4b5c-b735-3f2101c19a6c",
    "scheduled_at": "2023-01-25T20:45:00+00:00",
    "quote_id": "",
    "stops": [
        {
            "type": "origin",
            "actions": [
                {
                    "type": "pick_up",
                    "user": {
                        "name": "Passenger 1",
                        "phone": "447000000000"
                    }
                }
            ],
            "location": {
                "lat": 51.4585709149735,
                "lng": -0.4453791457396373,
                "address": {
                    "full_address": "Heathrow Terminal 4, Hounslow TW6 3XA, UK",
                    "city": "Hounslow",
                    "house": "",
                    "state": "England",
                    "street": "",
                    "country": "UK",
                    "postcode": "TW6 3XA",
                    "address_place": {
                        "provider": "GOOGLE",
                        "id": "ChIJJV-0krhzdkgRp4xHVJwUCVQ"
                    }
                }
            }
        },
        {
            "type": "destination",
            "actions": [
                {
                    "type": "drop_off",
                    "user": {
                        "name": "Passenger 1",
                        "phone": "447000000000"
                    }
                }
            ],
            "location": {
                "lat": 51.52289,
                "lng": -0.1136,
                "address": {
                    "full_address": "Gett UK, Elm House 10-16, Elm Street, London WC1X 0BJ",
                    "city": "London",
                    "house": "",
                    "state": "Camden",
                    "street": "Elm Street",
                    "country": "United Kingdom",
                    "postcode": "WC1X 0BJ",
                    "address_place": {
                        "provider": "POSTCODE",
                        "id": "GB|RM|A|55201188"
                    }
                }
            }
        }
    ],
    "payment_type": "account",
    "note_to_driver": "",
    "references": [
        {
            "id": 8946,
            "title": "",
            "value": "Tech"
        },
        {
            "id": 9557,
            "title": "",
            "value": "Product"
        }
    ],
    "flight_details": {
        "flight_number": "BA164",
        "flight_tracking": true,
        "offset_from_flight": 60
    },
    "requested_at": "2022-12-22T19:16:16+00:00"
}

Multi Passenger Ride Request

curl --location --request POST 'https://business-api.gett.com/v1/orders?businessId=<companyUUID>' \
--header 'Authorization: Bearer <access token>' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
    "category": "transportation",
    "product_id": "8d50ef79-2530-4924-b89e-10ed9f035d8b",
    "quote_id": "df49c6e9-23ed-4e8d-af4c-80bd90d2c7d7",
    "scheduled_at": "2021-01-30T15:00:00+02:00",
    "stops": [
        {
            "type": "origin",
            "actions": [
                {
                    "type": "pick_up",
                    "user": {
                        "name": "passenger 1",
                        "phone": "972500000000"
                    }
                },
                {
                    "type": "pick_up",
                    "user": {
                        "name": "passenger 2",
                        "phone": "972500000001"
                    }
                }
            ],
            "location": {
                "lat": 32.101128,
                "lng": 34.856651,
                "address": {
                    "full_address": "Shlomo Shmeltzer Road/HaShfela, Petah Tikva, Israel",
                    "address_place": {
                        "id": "sddfrerwq123",
                        "provider": "google"
                    },
                    "city": "Petah Tikva",
                    "country": "Israel",
                    "house": "23",
                    "notes": "",
                    "postcode": "",
                    "state": "israel",
                    "street": "Shlomo Shmeltzer Road/HaShfela"
                }
            }
        },
        {
            "type": "destination",
            "actions": [
                {
                    "type": "drop_off",
                    "user": {
                        "name": "passenger 1",
                        "phone": "972500000000"
                    }
                },
                {
                    "type": "drop_off",
                    "user": {
                        "name": "passenger 2",
                        "phone": "972500000001"
                    }
                }
            ],
            "location": {
                "lat": 31.984621,
                "lng": 34.951736,
                "address": {
                    "full_address": "Bet Nehemya Junction, Israel"
                }
            }
        }
    ],
    "references": [
        {
            "id": 39,
            "title": "Reason for travel",
            "value": "123"
        }
    ],
    "note_to_driver": "call me",
    "payment_type": "account"
}'

Multi Passenger Ride Response

{
    "id": 2832,
    "status": "Pending",
    "business_uuid": "6eaaa6cf-3bdc-4393-a8cf-22b500f58006",
    "category": "transportation",
    "product_id": "8d50ef79-2530-4924-b89e-10ed9f035d8b",
    "scheduled_at": "2021-01-30T15:00:00+02:00",
    "quote_id": "",
    "stops": [
        {
            "type": "origin",
            "actions": [
                {
                    "type": "pick_up",
                    "user": {
                        "name": "passenger 2",
                        "phone": "972500000001"
                    }
                },
                {
                    "type": "pick_up",
                    "user": {
                        "name": "passenger 1",
                        "phone": "972500000000"
                    }
                }
            ],
            "location": {
                "lat": 32.101128,
                "lng": 34.856651,
                "address": {
                    "full_address": "Shlomo Shmeltzer Road/HaShfela, Petah Tikva, Israel",
                    "country": "IL"
                }
            }
        },
        {
            "type": "on_going",
            "actions": [
                {
                    "type": "stop_by",
                    "user": {
                        "name": "passenger 1",
                        "phone": "972500000000"
                    }
                },
                {
                    "type": "drop_off",
                    "user": {
                        "name": "passenger 2",
                        "phone": "972500000001"
                    }
                }
            ],
            "location": {
                "lat": 32.1140861,
                "lng": 34.8293653,
                "address": {
                    "full_address": "Shmu'el Romanili St 36, Tel Aviv-Yafo, Israel",
                    "country": "IL"
                }
            }
        },
        {
            "type": "on_going",
            "actions": [
                {
                    "type": "stop_by",
                    "user": {
                        "name": "passenger 1",
                        "phone": "972500000000"
                    }
                }
            ],
            "location": {
                "lat": 31.954088,
                "lng": 34.8226,
                "address": {
                    "full_address": "ื”ืืœื•ืŸ 7, ืจืืฉื•ืŸ ืœืฆื™ื•ืŸ",
                    "country": "IL"
                }
            }
        },
        {
            "type": "destination",
            "actions": [
                {
                    "type": "drop_off",
                    "user": {
                        "name": "passenger 1",
                        "phone": "972500000000"
                    }
                }
            ],
            "location": {
                "lat": 31.984621,
                "lng": 34.951736,
                "address": {
                    "full_address": "Bet Nehemya Junction, Israel",
                    "country": "IL"
                }
            }
        }
    ],
    "references": [
        {
            "id": 39,
            "title": "Reason for travel",
            "value": "123"
        }
    ],
    "payment_type": "account",
    "note_to_driver": "call me",
    "requested_at": "2021-01-27T23:37:21+02:00"
}