Delivery
Please note
- The service allows one pickup and multi dropoffs
- the service is limited to 1 pickup and up to 6 dropoffs per order, subjected to availability of the service (get products endpoint)
- Return delivery can be set as a second dropoff
- To prevent order duplicates you can send X-Request-ID ( value: string) in the header
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 Delivery to send a package |
| 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 (example: 2017-12-05T18:59:23+03:00). 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: origin on_going destination |
| 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: pick_up drop_off |
| 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. NOTE:phone numbers must be passed in the international format (without "+" sign) as specified in RFC3966. |
| stops[x].actions.parcel. name | string | parcel Id/ Name, can't be empty |
| stops[x].location | object | A JSON dictionary containing the the location details |
| stops[x].location.lat | string | Location latitude |
| stops[x].location.lng | string | 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, POSTCODE, and HERE |
| stops[x].location.address.city (optional) | string | City name for stop address |
| stops[x].location.address.country (optional) | string | Country name for stop address |
| stops[x].location.address.full_address (optional) | string | Address in one string for stop |
| stops[x].location.address.house (optional) | string | House number for stop address |
| stops[x].location.address.notes (optional) | string | Notes for stop |
| stops[x].location.address.postcode (optional) | string | Postal code for stop address |
| stops[x].location.address.state (optional) | string | State for stop address |
| stops[x].location.address.street (optional) | string | Street name for stop 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].value (optional) | string | Additional field value |
| payment_type (optional) | string | The payment method of the company, if not provided company default will be used |
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": "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": "Hindi",
"phone": "97250000001"
},
"parcel": {
"name": "4455"
}
},
{
"type": "pick_up",
"user": {
"name": "Hindi",
"phone": "97250000001"
},
"parcel": {
"name": "5665"
}
},
{
"type": "pick_up",
"user": {
"name": "Hindi",
"phone": "97250000001"
},
"parcel": {
"name": "5566"
}
}
],
"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"
}
}
}
},
{
"type": "on_going",
"actions": [
{
"type": "drop_off",
"user": {
"name": "David",
"phone": "97250000002"
},
"parcel": {
"name": "4455"
}
}
],
"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"
}
}
}
},
{
"type": "destination",
"actions": [
{
"type": "drop_off",
"user": {
"name": "John",
"phone": "97250000003"
},
"parcel": {
"id": "70b3e5ea-c490-4eea-815c-c935c2426df2",
"name": "5665"
}
},
{
"type": "drop_off",
"user": {
"name": "John",
"phone": "97250000003"
},
"parcel": {
"id": "d71a616e-18e8-4736-adc8-5c9c4c026df6",
"name": "5566"
}
}
],
"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"
}
}
}
}
],
"note_to_driver": "",
"references": [
{
"id": 8946,
"value": "delivery to employees"
}
]
}'
Response
{
"id": 9629185,
"status": "Pending",
"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": "Hindi",
"phone": "972500000001"
},
"parcel": {
"id": "4af534f9-e5cc-49fb-82bf-8eba818f4eb7",
"name": "4455"
}
},
{
"type": "pick_up",
"user": {
"name": "Hindi",
"phone": "972500000001"
},
"parcel": {
"id": "70b3e5ea-c490-4eea-815c-c935c2426df2",
"name": "5665"
}
},
{
"type": "pick_up",
"user": {
"name": "Hindi",
"phone": "972500000001"
},
"parcel": {
"id": "d71a616e-18e8-4736-adc8-5c9c4c026df6",
"name": "5566"
}
}
],
"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"
}
}
}
},
{
"type": "on_going",
"actions": [
{
"type": "drop_off",
"user": {
"name": "David",
"phone": "972500000002"
},
"parcel": {
"id": "4af534f9-e5cc-49fb-82bf-8eba818f4eb7",
"name": "4455"
}
}
],
"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"
}
}
}
},
{
"type": "destination",
"actions": [
{
"type": "drop_off",
"user": {
"name": "John",
"phone": "972500000003"
},
"parcel": {
"id": "70b3e5ea-c490-4eea-815c-c935c2426df2",
"name": "5665"
}
},
{
"type": "drop_off",
"user": {
"name": "John",
"phone": "972500000003"
},
"parcel": {
"name": "5566"
}
}
],
"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"
}
}
}
}
],
"payment_type": "account",
"note_to_driver": "",
"references": [
{
"id": 8946,
"title": "cost centre",
"value": "delivery to employees"
}
],
"requested_at": "2022-04-09T13:08:36+00:00"
}
Updated 9 months ago