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

Objects are described in dedicated tables in this entry.

Json Type Example Description
id Int
 546665
Freight identification number, assigned automatically during creation of a new freight.
Important: this value is only received (GET)
shipment_external_id String 2021/ABC/1/1 External identification number
external_source String 1_api Freight source identifier assigned to client_id provided by Trans.eu
status String Accepted Freight status
Important: this value is only received (GET)
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 Main freight requirements, including truck body and size adr classes, ways of loading
Required
requirements.is_ftl Boolean True Determines if freight is a full truck load or less than truckload.
Required
requirements.required_truck_bodies Array Curtainsider, Box Allowed vehicle types
Required
requirements.required_ways_of_loading Array Top Allowed vehicle types
requirements.required_adr_classes Array Adr_1 Allowed ADR classes
requirements.shipping_remarks String Shipping remarks Additional shipping remarks
requirements.vehicle_size String Bus Available vehicle sizes
requirements.other_requirements Array Lift, Hds Array of additional freight requirements
publish Boolean True Determines if the freight is automatically published or only created
Required
publication_price Object Price given by user during freight creation
publication_price.currency String Eur Price currency
publication_price.value Int 1000 Price value
accepted_price Object Price given by the result of freight negotiation process
accepted_price.currency String Eur Currency for freight price accepted during publication and negotiation process
accepted_price.value Int 123 Price value for freight accepted during publication and negotiation process
loads Array of objects Collection of freights’ loads.
It is possible to send empty array of loads, nevertheless an array has to be set.
Required
loads.load_id String 279606 Load id, which should help identify loads designated to freight
loads.name String Example load no 1 Name of a load
loads.type_of_load String Europalette Name of supported type of load
loads.weight Int or float 12 The weight of a given load in tonnes (range 0.001 – 100000)
loads.height Int or float 3 The height of a given load in meters (range 0.01-10)
loads.width Int or float 2 The width of a given load in meters (range 0.01-10)
loads.length Int or float 8 The length of a given load in meters (range 0.01-100)
loads.volume Int or float 21 The volume of the load in cubic meters (range 0.01-10000)
loads.amount Int 1 The amount of loads with given parameters.
loads.description String Example 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 type of load is available for exchange at unloading place
spots Array of objects Collection of freights’ spots – at least one loading and one unloading is required
spots.name String Magazine 1 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
Required
spots.place Object Information related to single place on freight’s route
Required
spots.place.address Object Address
Required
spots.place.address.country String GB Country using ISO values
Required
spots.place.address.postal_code String SK7 1 Postal code
Required
spots.place.address.locality String Londyn City name
Required
spots.place.address.street String The Mall Street name
spots.place.address.number String 1 Number
spots.place.address.description String Address desc Description of loading point
spots.place.coordinates Object Longitude and latitude for selected point
spots.place.coordinates.latitude Float 53.35801 Latitude of the point along the freight route
spots.place.coordinates.longitude Float -2.16539 Longitude of the point along the freight route
spots.operations Array of objects Array of operations to be completed in given spot
Required
spots.operations.operation_order Int 1 The order of loading and unloading operations at a given spot – first operation always has operation_order set to 1
Required
loads Object Array of loads to be loaded in unloaded during operation
loads.load_id String 279606 Reference to a previously defined load
loads.weight Int 10 Weight of load to be loaded or unloaded in this operation.
spots.operations.timespans Object Timespan for selected operation
Required
spots.operations.timespans.begin Timestamp 2021-01-23T18:00:00+01:00 Beginning of time slot for loading or unloading operation
Required
spots.operations.timespans.end Timestamp 2021-01-23T18:30:00+01:00 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 Trans.eu company identifier
carrier.name String Example name Company name
carrier.vat String 11111111111 Company tax identification number
carrier.address Object Address
carrier.address.country String PL Country code using ISO values
carrier.address.postal_code String 00-111 Postal code
carrier.address.locality String Warsaw City name
carrier.address.street String Street name Street
carrier.address.number String 1 Number
carrier.email String abc@trans.eu E-mail address
carrier.telephone Number 0048 111111111 Telephone number

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

 

Json example

{
	"id": "546665",
	"shipment_external_id": "2021/ABC/1/1",
	"external_source": " 1_api", 
	"status": "accepted", 
	"capacity": 12,
	"loading_meters": 8, 
	"multistop" : true, 
	"requirements": {
          "is_ftl": false,
          "other_requirements": [
               "hds",
               "lift"],
          "required_adr_classes": [
            "adr_1"
          ],
          "required_truck_bodies": [
            "cooler"
          ],
          "required_ways_of_loading": [
            "top",
            "side",
            "back"
          ],
          "shipping_remarks": "Inne wymagania",
          "vehicle_size": "bus"
        },
	"publish": true, 
	"publish_price" : {
		"currency" : "eur", 
		"value"	: 111 
	},
	"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": [{ 
		"load_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": "Magazine 1",
		"description": "Example description",
		"spot_order": 1,
		"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": 1,
			"loads": [{
				"load_id" : 279606, 
				"weight" : 12 
			}],
        "timespans": {
          "end": "2021-01-13T13:38:18+02:00", 
          "begin": "2021-01-14T13:38:18+02:00" 
        },
        "type": "loading" 
		}]
		},
	  {
			"name": "Magazine 2",
			"description": "Example description",
			"spot_order": 2,
			"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": 1,
        "loads": [{
			    "load_id" : 279606, 
			    "weight" : 12 
		    }],
        "timespans": {
          "end": "2021-01-17T13:38:18+02:00", 
          "begin": "2021-01-18T13:38:18+02:00" 
        },
        "type": "unloading" 
      }]
	}
]
}