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

Field Example Type Is required Description
is_bus true Boolean Yes Determines if this vehicle max capacity is below 3,5 t
is_set false Boolean Yes
size bus String Yes Size of vehicle (bus, solo, any)
truck_body standard-tent String Yes Truck body type
adr_classes [] Array Yes List of ADR classes
available_ways_of_loading Object Object Yes Available ways of loading for this vehicle
loading_place Object Yes Information related to single place on freight’s route
loading_place.address Object Yes Address data
loading_place.address.country pl string Yes Country using ISO values
loading_place.address.street Street example string Yes Street name
loading_place.address.number 12a string Yes Number
loading_place.address.locality Bay City string Yes City name
loading_place.address.postal_code UL1 938 string Yes Postal code
loading_place.address.coordinates Object Yes Longitude and latitude for selected point
loading_place.address.coordinates.latitude Object Yes Latitude of the point along the freight route
loading_place.address.coordinates.longitude Object Yes Longitude of the point along the freight route
cargo.height 2 int Yes Cargo height value
cargo.width 3 int Yes Cargo width value
cargo.length 4 int Yes Cargo length value
cargo.volume 5 int Yes Cargo volume value
cargo.capacity string int Yes Cargo weight value
available_on Object Yes Availability time period
available_on.begin 2018-07-18T14:30:00+0200 timestamp Yes Beginning of availability period
available_on.end 2018-07-18T14:30:00+0200 timestamp Yes End of availability period

Json example

{
  "is_bus": true,
  "is_set": false,
  "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": 10
  },
  "unloading_place": {
    "address": {
      "locality": "Wroclaw",
      "postal_code": "56-111",
      "country": "pl"
    },
    "coordinates": {
      "latitude": 12,
      "longitude": 11
    },
    "range": 20
  },
  "cargo": {
    "height": {
      "value": 2,
      "unit_code": "MTR"
    },
    "width": {
      "value": 2,
      "unit_code": "MTR"
    },
    "length": {
      "value": 2,
      "unit_code": "MTR"
    },
    "volume": {
      "value": 2,
      "unit_code": "MTQ"
    },
    "capacity": {
      "value": 2,
      "unit_code": "TNE"
    }
  },
  "available_on": {
    "begin": "2018-11-15T17:25:00+0000",
    "end": "2018-11-16T19:25:00+0000"
  }
}