[API] Update Vehicle
The Update Vehicle is specifically designed for vehicle suppliers managing Rental services, enabling them to update details of an existing vehicle in their system.
¶ Use case
By using the Update Vehicle API, suppliers can easily modify vehicle details such as make, model, year, and color, among others, with data refreshness time being less than 2 minutes. This capability is essential for maintaining an up-to-date vehicle inventory, which supports operational efficiency and regulatory compliance.
¶ Support for Hierarchical Data
The Update Vehicle API automatically operates within the hierarchical structure of the organization linked to the developer’s account at the time of setup.
¶ Supported supplier types
Rentals
¶ Scopes
vehicle_suppliers.vehicles.write
¶ Resource
/v1/vehicle-suppliers/vehicles/:vehicle_id
¶ HTTP Method
PATCH
¶ Authorization
¶ Example Request
curl -X PATCH "https://api.uber.com/v1/vehicle-suppliers/vehicles/:vehicle_id" \
-H "Authorization: Bearer <TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"make":"Honda",
"model":"Civic",
"year":2020,
"vin":"KM8JU3AC6DU590931",
"license_plate":"LP1234",
"color_hex_code":"FFFFFF"
}'
¶ Request Path Parameters
Name | Type | Description |
---|---|---|
vehicle_id |
string | Vehicle ID returned from Create Vehicle response. |
¶ Request Body Parameters
Name | Type | Description |
---|---|---|
make (optional) |
string | Make of the vehicle. |
model (optional) |
string | Model of the vehicle. |
year (optional) |
string | Make year of the vehicle. |
vin (optional) |
string | VIN (chassis number) of the vehicle. |
license_plate (optional) |
string | License plate ID of the vehicle. |
color_hex_code (optional) |
string | Hex code of the vehicle color, e.g. FFFFFF for white color |
¶ Example Response
Status-code: 200
{
"vehicle": {
"id": "<vehicle_id>",
"owner_id": "<owner_id>",
"make": "Honda",
"model": "Civic",
"year": 2020,
"vin": "KM8JU3AC6DU590931",
"license_plate": "LP1234",
"color_hex_code": "FFFFFF",
"color_name": "white",
"last_updated": 1583365226000
}
}
¶ Response Body parameters
Name | Type | Description |
---|---|---|
vehicle |
object | Vehicle object |
Vehicle Object
Name | Type | Description |
---|---|---|
id |
string | Vehicle ID |
owner_id |
string | ID of the vehicle supplier that owns the vehicle |
make |
string | Make of the vehicle |
model |
string | Model of the vehicle |
year |
int | Make year of the vehicle |
vin |
string | Vin (chassis number) of the vehicle |
license_plate |
string | License plate ID of the vehicle |
color_hex_code |
string | Hex code of the vehicle color, e.g. FFFFFF for white color |
color_name |
string | Name of the vehicle color, e.g. White |
last_updated |
int | Last updated timestamp of the vehicle in milliseconds |
¶ Endpoint Specific Errors
Http Status Code | Code | Message |
---|---|---|
400 |
bad_request | The request parameters are invalid |
401 |
unauthorized | Invalid OAuth 2.0 credentials provided |
404 |
vehicle_not_found | Vehicle was not found or not authorized |
404 |
organization_not_found | Supplier organization was not found or not authorized |
409 |
vehicle_already_exists | Vehicle with same VIN already exists |
422 |
update_readonly_field | It is not allowed to update the readonly fields |
429 |
rate_limited | Number of requests exceeds allowed limit |
500 |
internal_server_error | Internal server error |
503 |
service_unavailable | Service unavailable |
Notes
- The API allows for the flexible updating of certain vehicle details without requiring all information to be provided in each request. Additionally, the response from a successful update will include the last_updated field, which is a timestamp in milliseconds indicating when the vehicle data was last modified. Users create a vehicle and submit a document. At Uber, a manual approval of the document is done. Post manual approval, the document is transcribed, and vehicle entity is updated and then few fields like license plate and vin are non-updatable fields