API Reference
Start typing to search…

Vehicle Object

The vehicle object is included in some callbacks and contains the details of vehicles and trailers.

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**
    int32

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**
    int32

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**
    int32

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_id**
    int32

Bringg's ID for the vehicle profile.

Required if vehicle_type_external_id is not included.

  • *user_id**
    int32

Bringg's ID for the driver associated with this vehicle.

Response and Webhook Data