Description of available fields and its values in vehicle offer object with mandatory fields marked.

Json Is required Example Type Description
vehicle_size
Yes Bus String Available vehicle sizes
truck_body Yes Curtainsider String Allowed truck bodies
adr_classes No Adr_1 Array Allowed ADR classes
equipment No Lift, Hds Array Allowed equipment
available_ways_of_loading No Top Array Allowed ways of loading
loading_place Yes Object Loading place
loading_place.address Yes Object Loading place address
loading_place_address.locality Yes
Wroclaw
String City name
loading_place_address.postal_code Yes
56-111
String Postal code
loading_place_address.country Yes PL String Country using ISO values
loading_place.coordinates No Object Longitude and latitude for selected point
loading_place.coordinates.latitude No 53.35801 Float Latitude of the point along the freight route
loading_place.coordinates.longitude No 58.78801 Float Longitude of the point along the freight route
loading_place.range Yes 50 Int
Range must be one of the following values: 50,75,100,125,150,200,250
unloading_place Yes Object Unloading place
unloading_place.address Yes Object Unloading place address
unloading_place.address.locality Yes Wroclaw String City name
unloading_place.address.postal_code Yes 55-261 String Postal code
unloading_place.address.country Yes PL String Country using ISO values
unloading_place.coordinates No Object Longitude and latitude for selected point
unloading_place.coordinates.latitude No 53.36789 Float Latitude of the point along the freight route
unloading_place.coordinates.longitude No 58.78999 Float Longitude of the point along the freight route
unloading_place.range Yes 50 Int Range must be one of the following values: 50,75,100,125,150,200,250
cargo
Yes Object Cargo description
cargo.height
No Float Cargo height
cargo.width No Float Cargo width
cargo.length No Float Cargo length
cargo.volume No Float Cargo volume
cargo.capacity Yes Float Cargo capacity
available_on
Yes Object Vehicle availability
available_on.begin
Yes
2021-02-20T17:25:00+0000
Timestamp Vehicle availability begin
available_on.end
Yes
2021-02-21T19:25:00+0000
Timestamp Vehicle availability end

 

Json example

{
  "vehicle_size": "bus",
  "truck_body": "standard-tent",
  "adr_classes": [
    "adr_1"
  ],
  "equipment": [
    "hds"
  ],
  "available_ways_of_loading": [
    "top"
  ],
  "loading_place": {
    "address": {
      "locality": "Wroclaw",
      "postal_code": "56-111",
      "country": "pl"
    },
    "coordinates": {
      "latitude": 12,
      "longitude": 11
    },
    "range": 100
  },
  "unloading_place": {
    "address": {
      "locality": "Wroclaw",
      "postal_code": "56-111",
      "country": "pl"
    },
    "coordinates": {
      "latitude": 12,
      "longitude": 11
    },
    "range": 100
  },
  "cargo": {
    "height": 2,
    "width": 2,
    "length": 2,
    "volume": 2,
    "capacity": 2
  },
  "available_on": {
    "begin": "2021-03-15T17:25:00+0000",
    "end": "2021-03-16T19:25:00+0000"
  }
}

Important!
Weight is always represented in tonnes.
Height, length and width are always represented in meters.
Volume is always represented in cubic meters.