TRtrack-pod
Vehicle

Add vehicle

Changed on
post/Vehicle

Request

  • Base URL
    https://api.track-pod.com (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header X-API-KEY

Request body

Numberstring nullable

Required (*)

Number

CarrierCodestring nullable

Carrier Code

Carrierstring nullable

Carrier

Weightnumber double nullable

Capacity Weight

Volumenumber double nullable

Capacity Volume

Palletsnumber double nullable

Capacity Pallets

Lengthnumber double nullable

Max Length

Widthnumber double nullable

Max Width

Heightnumber double nullable

Max Height

DriverIdstring uuid nullable

Required (*)

Driver's Track-POD unique identifier (DriverId or DriverUsername is Required)

DriverUsernamestring nullable

Required (*)

Driver's username (DriverId or DriverUsername is Required)

DepotIdstring nullable

Required (*)

Unique identifier in user accounting system (DepotId or Depot is Required)

Depotstring nullable

Required (*)

Depot address (DepotId or Depot is Required)

MaxNodesinteger nullable

Maximum number of sites/orders

MaxWorkTimeinteger nullable

Maximum work time, h

MaxDistanceinteger nullable

Maximum distance, km

SpeedRationumber double nullable

Speed ratio restriction (should be grater than 0 and less or equal 2)

CostPerDistancenumber double nullable

Cost per distance (km)

CostPerHournumber double nullable

Cost per hour

BaseFarenumber double nullable

Base fare

StartTimestring date-span nullable

Start time

VehicleTypeinteger nullable

Vehicle type: 0 - Truck/Car, 1 - Motorcycle, 2 - Bicycle

EmissionCo2integer nullable

Vehicle emission g/km or g/mile

VehicleCheckListIdstring uuid nullable

Vehicle check list identifier

Example request

{
  "Number": "XXX777",
  "CarrierCode": "31",
  "Carrier": "Big Logistics",
  "Weight": 100,
  "Volume": 14.5,
  "Pallets": 16,
  "Length": 2.7,
  "Width": 0.9,
  "Height": 1.6,
  "DriverId": "00000000-0000-0000-0000-000000000000",
  "DriverUsername": "MyDriver",
  "DepotId": "1",
  "Depot": "9 Riverside, Salford M7 1PA ",
  "MaxNodes": 5,
  "MaxWorkTime": 8,
  "MaxDistance": 1000,
  "SpeedRatio": 1,
  "CostPerDistance": 1.1,
  "CostPerHour": 10,
  "StartTime": "08:00:00",
  "VehicleType": 1,
  "EmissionCo2": 250
}

Response

Vehicle was created successfully

Statusinteger nullable

The HTTP status code for the response

Titlestring nullable

A short, human-readable summary of the response

Detailstring nullable

A human-readable explanation specific to this response.

Changes

  • 1aff579d2957Revision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/xml)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/xml)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/xml)

  • 833e05afe46eRevision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/xml)

    • info

      added the non-success response with the status