USusenash
Vehicles

Create a vehicle

Changed on

Register a new vehicle for the organization's internal fleet with type and capacity details.

post/v1/vehicle

Request

Request body

namestring required

The name of the vehicle.

enabledboolean required

Whether the vehicle is enabled.

externalidentifierstring nullable

The external identifier of the vehicle.

courieridsstring[] nullable

The couriers of the vehicle.

Example request

{
  "name": "Vehicle 1",
  "enabled": true,
  "externalidentifier": "vehicle_ext_1",
  "courierids": [
    "cor_1",
    "cor_2"
  ]
}

Response

OK

idstring required

The ID of the vehicle.

namestring required

The name of the vehicle.

provideridstring required

The provider ID of the vehicle.

externalidentifierstring required

The external identifier of the vehicle.

enabledboolean required

Whether the vehicle is enabled.

courieridsstring[] required

The couriers of the vehicle.

Changes