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

Objects are described in dedicated tables in this article.

Field Type Example Description
id string abc123-def456-ghi789 Freight identification number assigned during freight creation
external_shipment_id string 9876-aaa-123 Freight identification number from external system
external_source string 1_system Freight source identifier
status string accepted Freight status
capacity int or float 12 Total freight capacity in tonnes. This value is being validated in comparison to the sum of all loads.
Range: 0,001 – 100000
Required
loading_meters int or float 8 Total freight loading meters
Range: 0,01 – 417
multistop boolean true Freight with more than two stops needs to be declared as multistop
requirements Object Collection of freight general requirements
requirements.is_ftl boolean true Determines if freight is a full truck load or less than truckload.
Required
requirements.required_truck_bodies array [“mega”,”tent”] Array of available truck body types
publish string auto Determines if freight is automatically published using rules set on Platform’s user interface. If left empty or null, freight will be created and not published
publication_price Object Price given by user during freight creation
publication_price.currency string eur Price currency
publication_price.value string 1000 Price value
accepted_price Object Price given by the result of freight negotiation process
accepted_price.currency string auto
accepted_price.value string auto Price currency
loads Object Collection of freights’ loads.
It is possible to send empty array of loads, nevertheless an array has to be set.
loads.id string 123456 Load given id
loads.name string First load Name of a load
loads.type_of_load string palette Name of supported type of load
loads.weight int or float 7 The weight of a given load in tonnes
loads.height int or float 2 The height of a given load in meters
loads.width int or float 2 The width of a given load in meters
loads.length int or float 6 The length of a given load in meters
loads.volume int or float 5 The volume of the load in cubic meters
loads.amount int 1 The amount of loads with given parameters.
loads.description string Load description Description of given load
loads.is_stackable boolean true Specifies whether the type of load allows stacking
loads.is_exchangeable boolean false Determines if there are palettes available for exchange at unloading place
spots.name string Example name Name of the loading or unloading place
spots.description string Example description Description of the loading or unloading place
spots.spot_order int 1 Information about the order of operations at this location
spots.place Object Information related to single place on freight’s route
spots.place.address string Object Address data
spots.place.address.country string DE Country using ISO values
Required
spots.place.address.postal_code string 52-200 Postal code
Required
spots.place.address.locality string Paris City name
Required
spots.place.address.street string Champs elysees Street name
spots.place.address.number string 44 Number
spots.place.coordinates Object Longitude and latitude for selected point
spots.place.coordinates.latitude float 51.8338 Latitude of the point along the freight route
spots.place.coordinates.longitude float 16.5792 Longitude of the point along the freight route
spots.operations Object Array of operations to be completed in given spot
spots.operations.operation_order int 1 The order of loading and unloading operations at a given spot.
spots.operations.loads string 123456 Reference to a previously defined load that is to be partially or completely unloaded or loaded at a given location.
spots.operations.timespans Object Timespan for selected operation
spots.operations.timespans.begin timestamp 2018-07-18T14:30:00+0200 Beginning of time slot for loading or unloading operation
Required
spots.operations.timespans.end timestamp 2018-07-18T14:30:00+0200 End of time slot for loading or unloading operation
Required
spots.operations.type string loading Could be either loading or unloading, at least one of each is required
Required
carrier Object Carrier
Is determined during freight publication process
carrier.id string id Company identifier
carrier.name string name Company legal name
carrier.vat string vat VAT number
carrier.address Object Address
carrier.address.country string country Country code using ISO values
carrier.address.postal_code string postal code Postal code
carrier.address.locality string city City name
carrier.address.street string street Street
carrier.address.number string number Number

Important!
Weight is always represented in tons.
Height, length and width are always represented in meters.

 

Json

{
	"id": "abc123-def456-ghi789",
	"external_shipment_id": "9876-aaa-123",
	"external_source": "1_system", 
	"status": "accepted", 
	"capacity": 12,
	"loading_meters": 8, 
	"multistop" : true, 
	"requirements": {
		"is_ftl": true, 
		"required_truck_bodies": [ 
			"curtainsider",
			"tent"
		]
	},
	"publish": auto, 
	"publish_price" : {
		"currency" : "eur", 
		"value"	: 111 
	},
	"exchange_recipients": "all", 
	"publish_date" : "2019-12-13T13:38:18+02:00",
	"decision_date" : "2019-12-13T13:38:18+02:00",
	"accepted_price": {
		"currency" : "eur", 
		"value"	: 200
	},
	"carrier": { 
		"id": "123", 
		"name": "Example company name",
		"vat": "PL123456789",
		"address": {
			"country": "pl",
			"locality": "Sopot",
			"postal_code": "12-345",
			"street": "Example street",
			"number": "13a"
		}
	},
	"loads": [{ 
		"id": 279606,
		"name": "Example load no 1",
		"type_of_load": "palette",
		"weight": 12,
		"height": 1,
		"width": 2,
		"length": 9,
		"volume": 20,
		"amount": 1,
		"description": null,
		"is_stackable": false,
		"is_exchangeable": false
	}],
	"spots": [{ 
		"name": "string",
		"description": "string",
		"spot_order": 0,
		"place": {
			"address": {
				"country": "pl",
				"street": "Racławicka",
				"number": "2-4",
				"locality": "Wrocław",
				"postal_code": "53-146",
				"description": "Trans.eu office"
				},
				"coordinates": {
					"latitude": 51.085615,
					"longitude": 17.0105
				}
			},
		"operations": [{ 
			"operation_order": 0,
			"loads": [{
				"id" : 279606, 
				"weight" : 12 
			}],
        "timespans": {
          "end": "2019-12-13T13:38:18+02:00", 
          "begin": "2019-12-14T13:38:18+02:00" 
        },
        "type": "loading" 
		}]
		},
	  {
			"name": "string",
			"description": "string",
			"spot_order": 0,
			"place": {
				"address": {
					"country": "pl",
					"street": "Racławicka",
					"number": "2-4",
					"locality": "Wrocław",
					"postal_code": "53-146",
					"description": "Trans.eu office"
				},
				"coordinates": {
					"latitude": 51.085615,
					"longitude": 17.0105
				}
			},
		"operations": [{ 
        "operation_order": 0,
        "loads": [{
			    "id" : 279606, 
			    "weight" : 12 
		    }],
        "timespans": {
          "end": "2019-12-17T13:38:18+02:00", 
          "begin": "2019-12-18T13:38:18+02:00" 
        },
        "type": "unloading" 
      }]
	}
]
}