This overview highlights the functions of the Vehicle endpoints and how it is useful for your company.
Create a new vehicle
- Endpoint: v1/vehicles
- Description: Use this endpoint to add a new vehicle to your fleet.
- Use Case: Add a vehicle to the Motive, to start tracking the vehicle and its information such as speed, idle time, driver information and others.
Update and existing vehicle
- Endpoint: v1/vehicles{id}
- Description: Use this endpoint to update an existing vehicle of your fleet. You must specify the ID of the vehicle that you want to update.
- Use Case: This endpoint allows you to add important information to an existing vehicle, such as assigning a Vehicle Gateway, changing the group ID of a vehicle and others.
Fetch a list of all the vehicles of a company
- Endpoint: v1/vehicles
- Description: Use this endpoint to fetch a list of all the existing vehicles in your fleet.
- Use Case: View all the available vehicles in your company and see how many of them are active and how many of them are not. This endpoint gives you a great picture of your current fleet, and allows you to manage the operations more effectively.
Fetch the details of vehicle using its ID
- Endpoint: v1/vehicles/{id}
- Description: Use this endpoint to fetch the details of a specific vehicle of your fleet.
- Use Case: In case you want to view the details of a specific vehicle, you can do so by using its ID. Look up its details and take necessary action on the vehicle.
Lookup a vehicle by its number
- Endpoint: v1/vehicles/lookup
- Description: Use this endpoint to search of a vehicle using its number.
- Use Case: Look up the details of a vehicle using its number and take actions accordingly.
Lookup a vehicle by an external identifier
- Endpoint: v1/vehicles/lookup_by_external_id
- Description: Use this endpoint to fetch the details of a vehicle by using its external identifier. Do note that if you provide an external identifier, you must also specify the name of the integration that it is associated with.
- Use Case: This endpoint allows you to use the unique identifier provided by an external integration such as ADP, or Komtrax, to view the vehicle information. Check which of your fleet vehicles are integrated with these third-party softwares, as this allows for easy retrieval of data.