Creating new freight at Trans.eu Platform and sending it to Freight exchange.
Url parameters and connection settings
- URL: https://api.platform.trans.eu
- Endpoint: /ext/freights-api/v1/freight-exchange
- Method: POST
Headers:
- Content-type: application/json
- Accept: application/json
- Authorization: Bearer {access_token}
- Api-key: {unique_app_api_key}
Authorization
Authorization process is described here.
| Json | Example | Type | Is required | Description |
| shipment_external_id | 2020/ABC/1/1 | String | No | External identification number |
| external_source | 1_api | String | No | Freight source identifier assigned to client_id provided by Trans.eu |
| capacity | 12 | Float | Yes | Total freight capacity in tonnes. This value is being validated in comparison to the sum of all loads weight. Range: 0,001 – 100000 |
| publish | True | Boolean | Yes | Determines if the freight is automatically published or only created |
| payment | Object | No | Payment conditions for publication using groups or smart match | |
| requirements | Object | Yes | Main freight requirements, including truck body and size adr classes, ways of loading | |
| loads | Array | No | Collection of freights’ loads. It is possible to send empty array of loads, nevertheless an array has to be set | |
| spots | Object | Yes | Collection of freights’ spots – at least one loading and one unloading is required | |
Example
Sample Json for creating new freight using required data only
{
"publish": true,
"external_source": "1_api",
"capacity": 29,
"requirements": {
"is_ftl": true,
"required_truck_bodies": [
"curtainsider",
"cooler"
]
},
"loads": [
],
"spots": [
{
"spot_order": 1,
"place": {
"address": {
"country": "GB",
"postal_code": "SK7 1",
"locality": "London"
}
},
"operations": [
{
"operation_order": 1,
"timespans": {
"begin": "2021-09-30T13:10:00+0000",
"end": "2021-09-30T15:10:00+0000"
},
"type": "loading"
}
]
},
{
"spot_order": 2,
"place": {
"address": {
"country": "PL",
"postal_code": "61-625",
"locality": "Poznań"
}
},
"operations": [
{
"operation_order": 1,
"type": "unloading",
"timespans": {
"begin": "2021-10-01T13:00:00+0000",
"end": "2021-10-01T14:00:00+0000"
}
}
]
}
]
}
Response
{
"accepted_price": null,
"capacity": 29,
"carrier": null,
"id": 890677,
"loading_meters": null,
"loads": [],
"publication_price": {
"currency": "eur",
"value": null
},
"reference_number": "FR/2021/09/28/L1D2",
"requirements": {
"is_ftl": true,
"monitoring": "expected",
"other_requirements": [],
"required_adr_classes": [],
"required_truck_bodies": [
"curtainsider",
"cooler"
],
"required_ways_of_loading": [],
"shipping_remarks": null,
"temperature": {
"max": null,
"min": null
},
"vehicle_size": "any_size"
},
"shipment_external_id": null,
"spots": [
{
"description": null,
"name": null,
"operations": [
{
"loads": [],
"operation_order": 1,
"timespans": {
"begin": "2021-09-30T15:10:00+02:00",
"end": "2021-09-30T17:10:00+02:00"
},
"type": "loading"
}
],
"place": {
"address": {
"country": "gb",
"description": null,
"locality": "London",
"number": null,
"postal_code": "SK7 1",
"street": null
},
"coordinates": {
"latitude": null,
"longitude": null
}
},
"spot_order": 1
},
{
"description": null,
"name": null,
"operations": [
{
"loads": [],
"operation_order": 1,
"timespans": {
"begin": "2021-10-01T15:00:00+02:00",
"end": "2021-10-01T16:00:00+02:00"
},
"type": "unloading"
}
],
"place": {
"address": {
"country": "pl",
"description": null,
"locality": "Poznań",
"number": null,
"postal_code": "61-625",
"street": null
},
"coordinates": {
"latitude": 52.436170987,
"longitude": 16.951637018
}
},
"spot_order": 2
}
],
"status": "new"
}