/vehicles

post https://api-dev.orbit.do/v5/vehicles

Body Params

vehicle to create.

carrierId

string

required

The carrier ID associated with the vehicle.

status

string

required

The status of the vehicle. Can be 'Active' or 'Inactive'.

make

string

The manufacturer of the vehicle.

model

string

The model of the vehicle.

numberPlate

string

numberPlateCountryCode

string

length between 3 and 3

The country code of the number plate (ISO Alpha-3)

VIN

string

Vehicle Identification Number

class

string

required

length ≥ 1

The class of the vehicle. Must be at least 1 character.

extras

array of strings

required

A list of extra features for the vehicle.

extras*

containerWidth

number

required

≥ 0

The width of the vehicle's container in meters.

containerLength

number

required

≥ 0

The length of the vehicle's container in meters.

containerHeight

number

required

≥ 0

The height of the vehicle's container in meters.

outerWidth

The outer width of the vehicle in meters.

outerLength

The outer length of the vehicle in meters.

outerHeight

The outer height of the vehicle in meters.

weightCapacity

number

required

≥ 0

The weight capacity of the vehicle in kilograms.

maxTotalWeight

number

required

≥ 0

The maximum total weight the vehicle can carry in kilograms.

internalComment

string

Internal comments about the vehicle.

properties

object | null

A set of key-value properties related to the vehicle.

accessDirection

array of strings

The access directions for the vehicle. Can be 'Back', 'Left', and/or 'Right'.

accessDirection

fuelType

string

The type of fuel used by the vehicle.

combustionNorm

string

The emission standard of the vehicle.

emissionClass

string

The emission class of the vehicle.

axleCount

The number of axles on the vehicle.

Responses

Response body

object

string

required

The unique identifier for the vehicle.

tenantId

string

required

The tenant ID associated with the vehicle.

carrierId

string

required

The carrier ID associated with the vehicle.

status

string

required

The status of the vehicle. Can be 'Active' or 'Inactive'.

Active Inactive

make

string

The manufacturer of the vehicle.

model

string

The model of the vehicle.

numberPlate

string

numberPlateCountryCode

string

length between 3 and 3

The country code of the number plate (ISO Alpha-3)

VIN

string

Vehicle Identification Number

class

string

required

length ≥ 1

The class of the vehicle. Must be at least 1 character.

extras

array of strings

required

A list of extra features for the vehicle.

extras*

containerWidth

number

required

≥ 0

The width of the vehicle's container in meters.

containerLength

number

required

≥ 0

The length of the vehicle's container in meters.

containerHeight

number

required

≥ 0

The height of the vehicle's container in meters.

outerWidth

The outer width of the vehicle in meters.

outerLength

The outer length of the vehicle in meters.

outerHeight

The outer height of the vehicle in meters.

weightCapacity

number

required

≥ 0

The weight capacity of the vehicle in kilograms.

maxTotalWeight

number

required

≥ 0

The maximum total weight the vehicle can carry in kilograms.

internalComment

string

Internal comments about the vehicle.

createdAt

number

required

The creation timestamp of the vehicle in seconds since epoch.

properties

object | null

A set of key-value properties related to the vehicle.

Has additional fields

accessDirection

array of strings

The access directions for the vehicle. Can be 'Back', 'Left', and/or 'Right'.

accessDirection

fuelType

string

The type of fuel used by the vehicle.

petrol diesel syntheticDiesel hydrogen compressedNaturalGas liquefiedNaturalGas liquefiedPetroleumGas electric

combustionNorm

string

The emission standard of the vehicle.

euro1 euro2 euro3 euro4 euro5 euro6

emissionClass

string

The emission class of the vehicle.

1 2 3 4 5

axleCount

The number of axles on the vehicle.

tenant

string

required

deprecated

This parameter is deprecated. Use 'tenantId' instead.

carrier

string

required

deprecated

This parameter is deprecated. Use 'carrierId' instead.

401

unauthorized

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-dev.orbit.do/v5/vehicles \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"status":"Active"}'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200created vehicle