Privileged and Confidential This endpoint design has been confidentially shared with you. It is still under development and is subject to change without notice. Please do not share this document or API endpoint details with anyone who is not authorized to have access. For more information read about scopes.
Use case
Use this endpoint to retrieve information for a specific trip.
If translation for product description and vehicle color fields are needed in the response of this call, please add the header Accept-Language
and specify the value (for example, to translate to French, use “FR” as the value for this header)
If the request is from a third party (3P) app, please add x-uber-organizationuuid header and the Organization UUID as the value or the request will be denied.
Authorization
OAuth 2.0 Bearer token with the business.trips
scope.
Request
Example request
curl -X GET \
-H "authorization: Bearer $UBER_TOKEN" \
'https://api.uber.com/v2/employees/trips/<request_id>?include_editable_fields=true'
Request URL path parameters
URL Path Parameters |
Type |
Required? |
Description |
request_id |
string |
Yes |
A unique identifier of a trip request returned when creating a trips. (required) |
include_editable_fields |
bool |
No |
If true returns the editable fields in the response. If not provided or false, omits editable_fields from response. (optional) |
Response
Editable fields example
"editable_fields": {
"PICKUP": {
"editable": false,
"max_radius_meters": 200
},
"DROPOFF": {
"editable": false
}
}
Example accepted
trip response
{
"destination": {
"address": "Bryant Park, New York, NY 10018",
"eta": 18,
"latitude": 40.7535965,
"longitude": -73.9832326,
"place": {
"place_id": "ChIJvbGg56pZwokRp_E3JbivnLQ",
"provider": "google_places"
},
"subtitle": "New York, NY 10018",
"timezone": "America/New_York",
"title": "Bryant Park"
},
"driver": {
"id": "42d53206-d8ba-5d5e-9f9b-c9e4a33d3a4c",
"name": "Joe",
"phone_number": "+11234567891",
"picture_url": "https://d1w2poirtb3as9.cloudfront.net/exampleurl",
"rating": 4.9,
"regulatory_info": "Licensed by TfL, PHL 123456789",
"sms_number": "+11234567891"
},
"expense_memo": "Memo note example",
"customer": {
"phone_number": "+11234567890"
},
"location": {
"bearing": 0,
"latitude": 40.775573965137674,
"longitude": -73.98604690473967
},
"location_uuid": "a18860d5-ffee-429f-acb3-2f74641a0bf9",
"note_for_driver": "Example note to driver",
"pickup": {
"address": "Lincoln Square, New York, NY",
"eta": 1,
"latitude": 40.77417690000001,
"longitude": -73.98491179999999,
"place": {
"place_id": "ChIJYWvLK15YwokR9nuSX-MHTZA",
"provider": "google_places"
},
"subtitle": "New York, NY",
"timezone": "America/New_York",
"title": "Lincoln Square"
},
"product": {
"display_name": "UberX",
"product_id": "b8e5c464-5de2-4539-a35a-986d6e58f186"
},
"request_id": "da790cea-31b4-4131-8cd9-7adb1c06db99",
"request_time": 1564758590788,
"requester_name": "David Example",
"requester_uuid": "f3a604eb-8b90-4068-932c-13d6a5002f86",
"status": "accepted",
"surge_multiplier": 1,
"vehicle": {
"license_plate": "ABC1234",
"make": "Oldsmobile",
"model": "Intrigue",
"vehicle_color_name": "white"
}
"client_fare": "$10.23"
"fare": {
"currency_code": "USD"
"value": 10.23
}
}
Example in_progress
trip response
{
"begin_trip_time": 1564758770223,
"destination": {
"address": "Bryant Park, New York, NY 10018",
"eta": 17,
"latitude": 40.7535965,
"longitude": -73.9832326,
"place": {
"place_id": "ChIJvbGg56pZwokRp_E3JbivnLQ",
"provider": "google_places"
},
"subtitle": "New York, NY 10018",
"timezone": "America/New_York",
"title": "Bryant Park"
},
"driver": {
"id": "42d53206-d8ba-5d5e-9f9b-c9e4a33d3a4c",
"name": "Example",
"phone_number": "+11234567891",
"picture_url": "https://d1w2poirtb3as9.cloudfront.net/exampleurl",
"rating": 4.9,
"sms_number": "+11234567891"
},
"expense_memo": "Memo note example",
"customer": {
"phone_number": "+11234567890"
},
"location_uuid": "a18860d5-ffee-429f-acb3-2f74641a0bf9",
"note_for_driver": "Example note to driver",
"pickup": {
"address": "Lincoln Square, New York, NY",
"latitude": 40.77417690000001,
"longitude": -73.98491179999999,
"place": {
"place_id": "ChIJYWvLK15YwokR9nuSX-MHTZA",
"provider": "google_places"
},
"subtitle": "New York, NY",
"timezone": "America/New_York",
"title": "Lincoln Square"
},
"product": {
"display_name": "UberX",
"product_id": "b8e5c464-5de2-4539-a35a-986d6e58f186"
},
"request_id": "da790cea-31b4-4131-8cd9-7adb1c06db99",
"request_time": 1564758590788,
"requester_name": "David Example",
"requester_uuid": "f3a604eb-8b90-4068-932c-13d6a5002f86",
"status": "in_progress",
"surge_multiplier": 1,
"vehicle": {
"license_plate": "ABC1234",
"make": "Oldsmobile",
"model": "Intrigue",
"vehicle_color_name": "white"
}
"client_fare": "$10.23"
"fare": {
"currency_code": "USD"
"value": 10.23
}
}
Example completed
trip response
{
"begin_trip_time": 1564758770000,
"can_tip": true,
"client_fare": "$10.41",
"client_fare_without_tip": "$10.41",
"currency_code": "USD",
"fare": {
"currency_code": "USD"
"value": 10.41
}
"destination": {
"address": "Bryant Park, New York, NY 10018",
"latitude": 40.7535965,
"longitude": -73.9832326,
"place": {
"place_id": "ChIJvbGg56pZwokRp_E3JbivnLQ",
"provider": "google_places"
},
"subtitle": "New York, NY 10018",
"timezone": "America/New_York",
"title": "Bryant Park"
},
"driver": {
"id": "42d53206-d8ba-5d5e-9f9b-c9e4a33d3a4c",
"name": "Joe",
"picture_url": "https://d1w2poirtb3as9.cloudfront.net/exampleurl",
"rating": 4.9
},
"dropoff_time": 1564758815000,
"expense_memo": "Memo note example",
"customer": {
"phone_number": "+11234567890"
},
"location_uuid": "a18860d5-ffee-429f-acb3-2f74641a0bf9",
"note_for_driver": "Example note to driver",
"pickup": {
"address": "Lincoln Square, New York, NY",
"latitude": 40.77417690000001,
"longitude": -73.98491179999999,
"place": {
"place_id": "ChIJYWvLK15YwokR9nuSX-MHTZA",
"provider": "google_places"
},
"subtitle": "New York, NY",
"timezone": "America/New_York",
"title": "Lincoln Square"
},
"product": {
"display_name": "UberX",
"product_id": "b8e5c464-5de2-4539-a35a-986d6e58f186"
},
"request_id": "da790cea-31b4-4131-8cd9-7adb1c06db99",
"request_time": 1564758590000,
"requester_name": "David Example",
"requester_uuid": "f3a604eb-8b90-4068-932c-13d6a5002f86",
"status": "completed",
"surge_multiplier": 1,
"trip_distance_miles": 0.01770572790936,
"trip_duration_seconds": 900,
"trip_end_location": {
"latitude": 40.7530483614,
"longitude": -73.9837700287
},
"vehicle": {
"make": "Oldsmobile",
"model": "Intrigue",
"vehicle_color_name": "white",
"license_plate": "ABC1234"
},
"waypoints": [
{
"latitude": 40.7741769,
"longitude": -73.9849118,
"type": "pickup"
},
{
"latitude": 40.7535965,
"longitude": -73.9832326,
"type": "dropoff"
}
]
}
Example scheduled
hourly trip response
{
"request_id": "be0e4bc3-725d-4c89-bad7-22252ef054bd",
"product": {
"product_id": "ff4fe398-6cc6-4931-9076-d5bfdde928b6",
"display_name": "Black SUV Hourly",
"parent_product_type_id": "5354dad7-2f82-405b-b99a-9ff8acd70223"
},
"status": "scheduled",
"pickup": {
"latitude": 37.7693926,
"longitude": -122.388946,
"address": "1515 3rd St, San Francisco, CA 94158, US",
"place": {
"place_id": "5c8db4b8-ecb8-4610-933e-4499742406ed",
"provider": "uber_places"
},
"timezone": "America/Los_Angeles",
"title": "Uber Mission Bay 2",
"subtitle": "1515 3rd St, San Francisco, CA"
},
"destination": {
"latitude": 37.80083,
"longitude": -122.41001,
"address": "Washington Square, Filbert St, San Francisco, CA",
"place": {
"place_id": "160a5155-7ed2-a267-20c2-6849f11a9c70",
"provider": "uber_places"
},
"timezone": "America/Los_Angeles",
"title": "Washington Square",
"subtitle": "Filbert St, San Francisco, CA"
},
"scheduling": {
"pickup_time": 1698183956000
},
"request_time": 1698176494962,
"client_fare": "$165.32",
"expense_code": null,
"is_reserve": true,
"customer": {
"phone_number": "+11234567890"
},
"fare": {
"value": 165.32,
"currency_code": "USD"
},
"stops": [
{
"latitude": 37.751507,
"longitude": -122.433136,
"address": "4054 24th St, San Francisco, CA 94114, US",
"place": {
"place_id": "877fbdb7-358e-5aa4-a061-cc6b14b682fd",
"provider": "uber_places"
},
"timezone": "America/Los_Angeles",
"title": "The Valley Tavern",
"subtitle": "4054 24th St, San Francisco, CA"
},
{
"latitude": 37.75976,
"longitude": -122.42711,
"address": "Mission Dolores Park",
"place": {
"place_id": "5ef9f628-c8d6-3d70-bb10-7503f23165bf",
"provider": "uber_places"
},
"timezone": "America/Los_Angeles",
"title": "Mission Dolores Park",
"subtitle": "566 Dolores St, San Francisco, CA"
}
],
"hourly": {
"tier": {
"time_in_mins": 120,
"distance": 30,
"distance_unit": "MILE"
}
}
}
Example in_progress
hourly trip response with overage
{
"request_id": "264623c5-4a9f-4125-bd13-780af995235a",
"product": {
"product_id": "ff4fe398-6cc6-4931-9076-d5bfdde928b6",
"display_name": "Black SUV Hourly",
"parent_product_type_id": "5354dad7-2f82-405b-b99a-9ff8acd70223"
},
"status": "in_progress",
"vehicle": {
"make": "Jeep",
"model": "Grand Wagoneer",
"license_plate": "",
"picture_url": "https://d3a74cgiihgn4m.cloudfront.net/2022/jeep/grand-wagoneer/15517_F5F5F5_3.png",
"vehicle_color_name": "White"
},
"driver": {
"name": "Driver",
"rating": 5,
"picture_url": "https://d1w2poirtb3as9.cloudfront.net/exampleurl",
"pin_based_phone_number": {
"phone_number": "+14153603326",
"pin": "67440034"
}
},
"location": {
"latitude": 37.76889,
"longitude": -122.388176,
"bearing": 0
},
"pickup": {
"latitude": 37.7693926,
"longitude": -122.388946,
"address": "1515 3rd St, San Francisco, CA 94158, US",
"place": {
"place_id": "5c8db4b8-ecb8-4610-933e-4499742406ed",
"provider": "uber_places"
},
"timezone": "America/Los_Angeles",
"title": "Uber Mission Bay 2",
"subtitle": "1515 3rd St, San Francisco, CA"
},
"destination": {
"latitude": 37.80083,
"longitude": -122.41001,
"eta": 47,
"address": "Washington Square, Filbert St, San Francisco, CA",
"place": {
"place_id": "160a5155-7ed2-a267-20c2-6849f11a9c70",
"provider": "uber_places"
},
"timezone": "America/Los_Angeles",
"title": "Washington Square",
"subtitle": "Filbert St, San Francisco, CA"
},
"scheduling": {
"pickup_time": 1698441651000
},
"request_time": 1698434359353,
"begin_trip_time": 1698439029268,
"client_fare": "$165.32",
"expense_code": null,
"is_reserve": true,
"customer": {
"phone_number": "+11234567890"
},
"fare": {
"value": 165.32,
"currency_code": "USD"
},
"stops": [
{
"latitude": 37.751507,
"longitude": -122.433136,
"address": "4054 24th St, San Francisco, CA 94114, US",
"place": {
"place_id": "877fbdb7-358e-5aa4-a061-cc6b14b682fd",
"provider": "uber_places"
},
"timezone": "America/Los_Angeles",
"title": "The Valley Tavern",
"subtitle": "4054 24th St, San Francisco, CA"
},
{
"latitude": 37.75976,
"longitude": -122.42711,
"address": "Mission Dolores Park",
"place": {
"place_id": "5ef9f628-c8d6-3d70-bb10-7503f23165bf",
"provider": "uber_places"
},
"timezone": "America/Los_Angeles",
"title": "Mission Dolores Park",
"subtitle": "566 Dolores St, San Francisco, CA"
}
],
"hourly": {
"overage": {
"overage_status": "TIME_EXCEEDED",
"time_overage_in_mins": 12
},
"tier": {
"time_in_mins": 120,
"distance": 30,
"distance_unit": "MILE"
}
}
}
Example completed
hourly trip response
{
"request_id": "aeb2895e-0ccd-4c3e-991f-de579bdc7be7",
"product": {
"product_id": "ff4fe398-6cc6-4931-9076-d5bfdde928b6",
"display_name": "Black SUV Hourly",
"parent_product_type_id": "5354dad7-2f82-405b-b99a-9ff8acd70223"
},
"status": "completed",
"vehicle": {
"make": "Ford",
"model": "Expedition",
"picture_url": "https://d3a74cgiihgn4m.cloudfront.net/2021/ford/expedition/14931_FCFCFC_3.png",
"vehicle_color_name": "White"
},
"driver": {
"name": "Driver",
"rating": 5,
"picture_url": "https://d1w2poirtb3as9.cloudfront.net/exampleurl"
},
"pickup": {
"latitude": 37.7693926,
"longitude": -122.388946,
"address": "1515 3rd St, San Francisco, CA 94158, US",
"place": {
"place_id": "5c8db4b8-ecb8-4610-933e-4499742406ed",
"provider": "uber_places"
},
"timezone": "America/Los_Angeles",
"title": "Uber Mission Bay 2",
"subtitle": "1515 3rd St, San Francisco, CA"
},
"destination": {
"latitude": 37.7515078,
"longitude": -122.4331331,
"address": "4054 24th St, San Francisco, CA 94114, US",
"place": {
"place_id": "877fbdb7-358e-5aa4-a061-cc6b14b682fd",
"provider": "uber_places"
},
"timezone": "America/Los_Angeles",
"title": "The Valley Tavern",
"subtitle": "4054 24th St, San Francisco, CA"
},
"scheduling": {
"pickup_time": 1698252055000
},
"request_time": 1698249415597,
"begin_trip_time": 1698249454000,
"dropoff_time": 1698258729000,
"client_fare": "$216.15",
"expense_code": null,
"is_reserve": true,
"customer": {
"phone_number": "+11234567890"
},
"fare": {
"value": 216.15,
"currency_code": "USD"
},
"stops": [
{
"latitude": 37.751507,
"longitude": -122.433136,
"address": "4054 24th St, San Francisco, CA 94114, US",
"place": {
"place_id": "877fbdb7-358e-5aa4-a061-cc6b14b682fd",
"provider": "uber_places"
},
"timezone": "America/Los_Angeles",
"title": "The Valley Tavern",
"subtitle": "4054 24th St, San Francisco, CA"
},
{
"latitude": 37.75976,
"longitude": -122.42711,
"place": {
"place_id": "5ef9f628-c8d6-3d70-bb10-7503f23165bf",
"provider": "uber_places"
},
"timezone": "America/Los_Angeles",
"title": "Mission Dolores Park",
"subtitle": "566 Dolores St, San Francisco, CA"
},
{
"latitude": 37.80083,
"longitude": -122.41001,
"place": {
"place_id": "160a5155-7ed2-a267-20c2-6849f11a9c70",
"provider": "uber_places"
},
"timezone": "America/Los_Angeles",
"title": "Washington Square",
"subtitle": "Filbert St, San Francisco, CA"
}
],
"hourly": {
"tier": {
"time_in_mins": 120,
"distance": 30,
"distance_unit": "MILE"
}
}
}
*** In the fare object, when we have a fixed fare, we only receive value. When the fare estimate is a range we receive low_estimate and high_estimate.
*** The fare object will contain the estimates wehn the trip is in non-terminal state. When the trip is in terminal state, the fate object will have the actual final fare.
Example Canceled with a follow-up rebooked trip (follow_up_trip_details
)
{
"request_id": "afdb6d61-80eb-4425-b5b2-516a750697b9",
"status": "driver_canceled",
"surge_multiplier": 1,
"guest": {
"guest_id": "a74e20d1-83f0-40d0-9b91-5b39f6b81b50",
"first_name": "Peter",
"last_name": "Parker",
"phone_number": "+1122334455",
"locale": "en"
},
"driver": {
"id": "01543370-86e6-489c-adda-1043a1284f16",
"name": "Norman",
"rating": 4.98,
},
"vehicle": {
"make": "Honda",
"model": "Civic",
"license_plate": "BRZ5351",
"vehicle_color_name": "Black"
},
"pickup": {
"latitude": 45.4577,
"longitude": -73.7513929,
"address": "Curbside Terminal Aéroport International Pierre-Elliott-Trudeau de Montréal (YUL), Dorval, QC H4Y 1H1, CA",
"place": {
"place_id": "46e51b4a-7ef3-4186-8d00-26b0a4c1e6df",
"provider": "uber_geofences",
"zone_id": "25c19143-eae9-4531-a072-64d3d45568e8"
},
"timezone": "America/Toronto",
"title": "Door 7 (Faster Pickup) - Departure",
"subtitle": "YUL Terminal"
},
"destination": {
"latitude": 45.50400661709105,
"longitude": -73.62522599934351,
"address": "3175 ch de la Côte-Sainte-Catherine, Montréal, QC H3T 1C5, CA",
"place": {
"place_id": "bc3ae611-e9a4-3337-1cc0-8358e5e712d0",
"provider": "uber_places"
},
"timezone": "America/Toronto",
"title": "Centre Hospitalier Universitaire Sainte-Justine",
"subtitle": "3175 ch de la Côte-Sainte-Catherine, Montréal, QC H3T 1C5"
},
"request_time": 1727197493000,
"client_fare": "CA$0.00",
"requester_uuid": "953b1aaf-d6a5-4d15-abc1-abbeeff6b821",
"requester_name": "Gabriel Diniz",
"trip_distance_miles": 0,
"trip_duration_seconds": 0,
"waypoints": [
{
"latitude": 45.4577,
"longitude": -73.751396,
"type": "pickup"
},
{
"latitude": 45.504005,
"longitude": -73.62523,
"type": "dropoff"
}
],
"location_uuid": "5d7363a4-5b1a-4c2b-ac58-1fba1af7f21a",
"product": {
"product_id": "d34e8e9e-5e71-484a-bda3-15fd5540d2c5",
"display_name": "UberX"
},
"currency_code": "CAD",
"can_tip": false,
"client_fare_without_tip": "CA$0.00",
"trip_end_location": {
"latitude": 45.4577,
"longitude": -73.751396
},
"client_fare_numeric": 0,
"stops": null,
"trip_leg_number": 0,
"total_trip_legs": 1,
"follow_up_trip_details": {
"trip_uuid": "15f5f1ac-f799-4539-8e36-bd51e07231b5"
}
}
Response
Name |
Type |
Description |
request_id |
string |
The unique ID of the trip request |
product.product_id |
string |
Unique identifier representing a specific product for a given latitude & longitude. |
product.parent_product_type_id |
string |
ID of the product_group. Can be used in place of product_group to identify the top-level product type. Warning: currently missing |
product.display_name |
string |
Product display name. |
status |
string |
The status of the trip request indicating state |
status_detail |
string |
More detail about the status, this field is only populated for rider_canceled status, and it helps to differentiate when trip was canceled by the Coordinator (coordinator_canceled) or the Rider (guest_rider_canceled). |
trip_distance_miles |
float |
The actual distance traveled on the trip, in miles. |
trip_duration_seconds |
int |
The trip duration, in seconds. |
vehicle |
object |
The object that contains vehicle details. Only non-null during an ongoing trip. |
vehicle.make |
string |
The vehicle make or brand. |
vehicle.model |
string |
The vehicle model or type. |
vehicle.license_plate |
string |
The license plate number of the vehicle. |
vehice.picture_url |
string |
The vehicle model picture |
vehicle.vehicle_color_name |
string |
The vehicle color |
driver |
object |
The object that contains driver details. Only non-null during an ongoing trip. |
driver.phone_number |
string |
The formatted phone number for calling a driver. Note, this may be different from driver.sms_number. |
driver.rating |
float |
The driver’s star rating out of 5 stars. |
driver.name |
string |
The first name of the driver. |
driver.sms_number |
string |
The formatted phone number for sms a driver. Note, this may be different from driver.phone_number. |
driver.picture_url |
string |
The driver picture |
driver.regulatory_info |
string |
Regulatory and compliance information related to the driver (only available in some regions) |
customer.email |
string |
Registered email address of the employee with uber |
customer.phone_number |
string |
Registered phone no of the employee with uber (country code concatenated with the phone no) |
location |
object |
Location is only available if Request status is accepted or arriving. Location data is not available while the trip is in_progress |
location.latitude |
float |
The current latitude of the vehicle. Values may not be available at all times since it depends on device capabilities, network, and location. |
location.longitude |
float |
The current longitude of the vehicle. Values may not be available at all times since it depends on device capabilities, network, and location. |
location.bearing |
float |
The current bearing of the vehicle in degrees, ranging from negative to 360. North is represented by 0 degrees, east is 90 degrees, south is 180 degrees, west 270 degrees, and so on. Values may not be available at all times since it depends on device capabilities, network, and location. A negative value indicates that the information is invalid. |
pickup |
object |
Object containing the location and ETA of the trip’s pickup point. See below for more details. |
destination |
object |
Object containing the location and ETA of the trip’s destination. See below for more details. |
stops |
array |
An array of objects containing the location and ETA of the trip’s intermediate stops. See below for more details. |
request_time |
int |
The time in milliseconds the Request was made |
begin_trip_time |
int |
The time in milliseconds the trip was begun. This is the time the rider is actually in the vehicle and the trip begins. Will be null unless the trip has begun. Warning: currently missing |
dropoff_time |
int |
The time in milliseconds the rider is dropped off and the trip is complete. Will be null unless the rider has been dropped off. |
scheduling.pickup_time |
int |
The time in milliseconds the pickup is scheduled for. This is only displayed for scheduled trips. |
hourly |
object |
This is used for hourly products. Root object containing hourly information. |
hourly.tier |
object |
This is used for hourly products. Object containing hourly tier booking parameters. See below for more details. |
hourly.overage |
object |
This is used for hourly products. Object containing hourly overage information. Only present when the trip is in progress and in an overage condition. See below for more details. |
client_fare |
string |
The formatted price of the trip |
expense_code |
string |
A free text field to add the code for the trip for expense reporting. Warning: currently missing |
expense_memo |
string |
A free text field to describe the purpose of the trip for expense reporting. |
is_reserve |
bool, nullable |
Denotes whether the trip is an Uber Reserve trip. |
fare.currency_code |
string |
Currency code of the location of the trip |
fare.value |
float |
Value of the fare in number format |
fare.low_estimate |
float |
Low estimate of the fare in cases where there is a fare range |
fare.high_estimate |
float |
High estimate of the fare in cases where there is a fare range |
editable_fields[FIELD_ID] |
object |
Specifies the fields in a trip that can be updated. Each field is identified by a FIELD_ID . |
shared_trip_info |
object |
The root for shared trip information. This field is only visible for shared trips. |
shared_trip_info.status |
string |
The status of the shared trip. |
follow_up_trip_details |
object |
The object with details about Rebooked trip (Follow-up trip). This field is only visible for rebooked trips. |
follow_up_trip_details.trip_uuid |
string |
The unique ID of the follow-up trip. |
Location and ETA object details
Name |
Type |
Description |
address |
string |
The location’s complete address. |
eta |
int |
The estimated time in minutes until arrival at the location. For pickup, only available when the trip state is accepted or arriving. For destination, only available during an ongoing trip. Not currently available for intermediate stops. |
latitude |
float |
The latitude of the location. |
longitude |
float |
The longitude of the location. |
place.place_id |
string |
The place ID in provider’s namespace. |
place.provider |
string |
The name of a provider of location data, e.g. google_places. |
place.zone_id |
string |
Zone ID for location ePUDO (optional). |
subtitle |
string |
The location city and state, where applicable. |
timezone |
string |
The timezone at location address. |
title |
string |
The location street address. |
hourly.tier
details
Name |
Type |
Description |
time_in_mins |
int |
Booked time in minutes. |
distance |
int |
Booked distance. |
distance_unit |
string |
Unit of distance used in distance . Possible values are mile and km . |
hourly.overage
details
Name |
Type |
Description |
overage_status |
string |
Possible values are TIME_EXCEEDED , MILEAGE_EXCEEDED and TIME_AND_MILEAGE_EXCEEDED . |
time_overage_in_mins |
int |
Time overage in minutes. |
distance_overage |
int |
Distance overage. |
distance_unit |
string |
Unit of distance used in distance_overage . Possible values are mile and km . |
editable_fields
details
FIELD_ID |
Name |
Type |
Description |
PICKUP |
editable |
bool |
Specifies if the Pickup is editable in the current trip status. |
PICKUP |
max_radius_meters |
int |
Specifies from the original pickup point within which a location field can be updated. |
DROPOFF |
editable |
bool |
Specifies if the Dropoff is editable in the current trip status. |
Trip request status
values
All possible status values of Request life cycle.
Status |
Description |
processing |
The request is matching to the most efficient available driver. |
no_drivers_available |
The request was unfulfilled because no drivers were available. |
accepted |
The request has been accepted by a driver and is “en route” to the start location (i.e. start_latitude and start_longitude). |
arriving |
The driver has arrived or will be shortly. |
in_progress |
The request is “en route” from the start location to the end location. |
driver_canceled |
The request has been canceled by the driver. |
rider_canceled |
The request was canceled by the rider. |
completed |
The request has been completed by the driver. |
scheduled |
The request is scheduled to be dispatched at a later time. |
failed |
The request failed |
Trip request status_detail
values
All possible status_detail
values for a request with rider_canceled
status.
Status |
Description |
coordinator_canceled |
The request was canceled by the Coordinator. |
guest_rider_canceled |
The request was canceled by the Rider. |
Shared trip info status
values
All possible status
values for a shared trip.
status |
Description |
co_rider_might_join |
A co-rider might join the trip. |
co_rider_joined |
A co-rider has joined the trip. |
Error Responses
Http Status Code |
Code |
Message |
404 |
entity_not_found |
Unknown trip uuid |