GuidesAPI Reference
Log In
API Reference

Update Vehicle Profile

put
https://developer-api.bringg.com/services/2PkSfi3n/service_uuid1/service_uuid2 (COPY)

Update an existing Vehicle Profile entity in Bringg. Vehicle profiles are also known as vehicle types in Bringg.

Body Params
int32
required

The Bringg ID of the Vehicle Profile you wish to update. Required, unless external_id is present.

string
required

ID of the vehicle profile in your system. Required, unless ID is present.

string

Your name for the vehicle profile. This is how the vehicle profile will appear in the Bringg UI. Minimum of two characters.

string

A free text description of the vehicle profile.

boolean
Defaults to false

Should be set to true if new vehicles created should use this vehicle profile by default. Creating a vehicle profile and setting this flag to true will clear any previously selected default vehicle profile.

json

Used to specify the maximum capacity in custom units for vehicles using this vehicle profile. For example. a maximum pallet count of 12 pallets.

float

A relative cost allocated to vehicles using this profile that is used in someA relative cost allocated to vehicles using this profile that is used in some types of route optimization. Serves to reduce the number of vehicles used in a given optimization.types of Route Optimization. Cost per shift serves to reduce the number of vehicles that are used in a given optimization.

boolean
Defaults to false

Set to true if vehicles using this profile should be considered "Green" vehicles as they approach net zero carbon emissions.

boolean
Defaults to false

A flag specifying whether or not vehicles with this profile can attach to trailers.

boolean
Defaults to false

A flag specifying whether or not vehicles with this profile are considered trailers.

double

The internal length capacity (cm) of the vehicle with this profile. Used when determining vehicle volume. If specified, must be > 0.

double

The internal width capacity (cm) of a vehicle with this profile. Used when determining vehicle volume. If specified, must be > 0.

double

The internal height capacity (cm) of a vehicle with this profile. Used when determining vehicle volume. If specified, must be > 0.

float

The longest distance that a vehicle using this profile can serve on a single route, in kilometers. Used in route optimization. If specified, must be > 0.

double

The maximum weight capacity a vehicles with this profile can carry at a time. Unit agnostic, should be in the same unit as the inventory weight specified on orders. If specified, must be > 0.

integer

The maximum number of orders that a vehicle using this profile can transport at a time. If undefined, the optimization reverts to vehicle capacity. If specified, must be > 0.

float

The maximum speed (miles or kilometers per hour) a vehicle with this profile can travel. Route optimization uses this field to predict timing.

double

The maximum duration (minutes) you set for a route to last for a vehicle using this profile..

double

The standard length of time that you assign to the vehicle loading process prior to optimization. If specified, must be > 0.

double

The standard length of time that you assign to the vehicle unloading process prior to optimization. If specified, must be > 0.

json

The type of vehicle (car, bicycle, or type of truck) using this profile. Applicable only when using Bringg's advanced traffic integration.

json

The type of vehicle (car, bicycle or truck) using this profile. Applicable only when using Bringg's basic traffic plan.

integer

1 = Overall cost per minute 2 = Order cost percentage 3 = Cost calculation method

route_cost_calculation_configuration
object

Used when * route_cost_calculation_type * is not null

Responses

Updated 17 days ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated 17 days ago