About Vehicles

In Bringg, vehicles represent individual trucks, trailers, and other forms of transportation used for delivering goods and services. With the Bringg API, you can create and update vehicles, get the details of all or get the details of a specific vehicle, and delete a specific vehicle.

The vehicle object includes the following:

A vehicle type, which specifies additional characteristics like capacity and trailer attachment.
The parking spot assigned to the vehicle.
The ID of the trailer attached to the vehicle (using the truck_id).
The team or company associated with the vehicle. Vehicles can only be assigned to routes associated with the team or company they belong to.

Additional information is included when vehicles are returned in webhooks and responses.

When the vehicle object is returned in a GET request, it also signifies if the vehicle is available to be assigned to a route.
When attached to another vehicle as a trailer, it is returned in the trailer object, which is identical to the vehicle object.

Vehicle Details

Below is a list of parameters you can send to Bringg as part of the vehicle object, for example, when sending the Create Vehicle or Update Vehicle requests.

Read our Data Formatting article for more details about how different parameter types, such as datetime, are formatted and used in Bringg.

Parameter	Description	Validation & Notes
color _string	The color of the vehicle.
company_external_id _string	When using subcontracted drivers as your own fleet, specify your external system's ID for the contracted organization.
default_parking_spot_external_id _int64	Your `external_id` for the parking spot associated with this vehicle.	Include only if `default_parking_spot_id` is not included.
default_parking_spot_id _int64	Bringg's `id` for the parking spot associated with this vehicle.	Include only if `default_parking_spot_external_id` is not included.
external_id _string	Your external system's ID for the vehicle.
external_vehicle _boolean	Specifies if this vehicle is owned by a subcontracted or other external company.	Possible values: `false` or `0` - Internally owned vehicle `true` or `1` - Externally owned vehicle
license_plate _string	The vehicle's license plate number.	Required.
model _string	The car's type or other identifying features.
name _string	Your custom identifier for the vehicle.
skills _{array of strings}	An array of vehicle capabilities.	For example, `refrigeration`. Must be an exact match to the skills configured in Bringg.
team_external_id _string	Your external system's ID for the team associated with this vehicle.
team_id _int64	Bringg's ID for the team associated with this vehicle.
truck_id _string	Bringg's ID for a trailer towed by this vehicle.
vehicle_type_external_id _string	Your external system's ID for the vehicle profile.	Required if `vehicle_type_id` is not included.
vehicle_type_i` _int64	Bringg's ID for the vehicle profile.	Required if `vehicle_type_external_id` is not included.
user_id _int64	Bringg's ID for the driver associated with this vehicle.

Response and Webhook Data

Below is a list of the data returned in webhooks and responses to your API requests. The inclusion of specific parameters may depend on your use case, your API request, and the webhook fields you have subscribed to.

Parameter	Description
success _boolean	Indicates whether the service completed successfully. false - the service failed. true - the service succeeded
message _string	If an error occurred, a message indicating the error is included.
rc _integer	If an error occurred, the return code is included.
available _boolean	Specifies if this vehicle is available to be assigned to a route. Possible values: `false` or `0` - the vehicle is not available to be assigned `true` or `1` - the vehicle is available to be assigned
color _string	The color of the vehicle.
company_id _int64	When using subcontracted drivers as your own fleet, specify Bringg's ID for the contracted organization.
default_parking_spot_id _int64	Bringg's ID for the parking spot associated with this vehicle.
external_id _string	Your external system's ID for the vehicle.
id _int64	Bringg's ID for the vehicle.
is_trailer _boolean	Indicates whether this vehicle is a trailer.
license_plate _string	The vehicle's license plate number.
merchant_id _int64	The ID of the merchant to which the vehicle belongs.
model _string	The vehicle's type or other identifying features.
name _string	Your custom identifier for the vehicle.
skills _string	An array of vehicle capabilities.
team_id _int64	Bringg's ID for the team associated with this vehicle.
trailer _object	Vehicle object if a trailer is associated with this vehicle.
truck_id _int64	Bringg's ID for a trailer towed by this vehicle.
user_id _int64	Bringg's ID for the driver associated with this vehicle.
vehicle_type_id _int64	Bringg's ID for the vehicle profile.