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 country origin) providing full address breakdown is mandatory
Request
Name | Type | Description |
|---|---|---|
URL | /v1/orders?businessId={{businessid}} | Request url to create order |
businessId | UUID | Company UUID identificator obtained from Gett in registration process |
category | string | Transportation for a ride |
product_ID | string | UUID corresponds to available product in the pickup. Obtained from Get Products request. |
scheduled_at | string | The schedule time in format ISO8601: yyyy-mm-ddThh:mm:ss+Z If the parameter is not passed it will default to on-demand |
quote_id | string | Unique id for pre-requested price estimation. Obtained from Price estimation request |
stops | array | The object containing the information about the stops/waypoints, for the ride. |
stops[x].type | string | Represents the type of the stops:
|
stops[x].actions | array | The object contains the passengers info and the relationship for the specific stops e.g. pickup/drop-off in stops |
stops[x].actions.type | string | Represents the type of the actions:
|
stops[x].actions.user | object | A JSON dictionary containing the the passenger name and phone number |
stops[x].actions.user. name | string | Passenger name |
stops[x].actions.user. phone | string | The phone number of the rider. |
stops[x].location | object | A JSON dictionary containing the the location details |
stops[x].location.lat | float | Location latitude |
stops[x].location.lng | float | Location longitude |
stops[x].location.full_address (optional) | string | Address display name |
stops[x].location.address (optional) | object | A JSON dictionary containing the the address details |
stops[x].location.address.address_place (optional) | object | Address provider details |
stops[x].location.address.id(optional) | string | Addresses id from provider e.g google provider id |
stops[x].location.address.provider (optional) | string | Provider name, Gett supports different address providers e.g Google and Postcode anywhere and *here |
stops[x].location.address.city (optional) | string | City name for stop point address |
stops[x].location.address.country (optional) | string | Country name for stop point address |
stops[x].location.address.full_address (optional) | string | Address in one string for stop point |
stops[x].location.address.house (optional) | string | House number for stop point address |
stops[x].location.address.notes (optional) | string | Notes for stop point |
stops[x].location.address.postcode (optional) | string | Postal code for stop point address |
stops[x].location.address.state (optional) | string | State for stop point address |
stops[x].location.address.street (optional) | string | Street name for stop point address |
note_to_driver (optional) | string | Message to the driver up to 100 chars |
references (optional) | object | Additional fields for ride - for some customer this object is mandatory. review company settings |
reference[x].id (optional) | int | Additional field identificator |
reference[x].title (optional) | string | Additional field name |
reference[X].value (optional) | string | Additional field value |
payment_type (optional) | string | The payment method of the company, if not provided company default will be used |
flight_details | object | flight details are required for airport pickups, mainly for pre-booked orders |
flight_details.airline_code | string | IATA airline code e.g. "BA" |
flight_details.flight_code | string | IATA flight code e.g. "164" |
flight_details.flight_number | string | IATA flight number e.g. "BA164" / "LY001" |
please note
Two or more consecutive addresses on the route can't be identical.
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": "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"
}
}
},
{
"type": "on_going",
"actions": [
{
"type": "stop_by",
"user": {
"name": "passenger 1",
"phone": "972500000000"
}
}
],
"location": {
"lat": 31.954088,
"lng": 34.822600,
"address": {
"full_address": "האלון 7, ראשון לציון"
}
}
},
{
"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"
}
}
}
],
"references": [
{
"id": 39,
"title": "Reason for travel",
"value": "123"
}
],
"note_to_driver": "call me",
"payment_type": "account"
}'
Request for Multi passenger ride for the same origin and destination
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"
}'
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"
}
Updated 4 months ago