Downloading a list of not accepted and not archived freights created in the same customer (company) account both via API and on the Trans.eu Platform.
The returned results are paginated with maximum of 30 per page.
Endpoint returns freights in status: new, in_progress, unsuccesful_publication, waiting_for_publication.
For download accepted freights visit Get accepted freights list, for download archived freights visit Get archived freights list.
GET
/ext/freights-api/v1/freights
This method supports query modifiers that allow you to customize the list of returned results to your own needs. The list of all parameters is specified below in Query Parameters.
- Filtering — allows you to download a list according to specified criteria
- Sorting — allows you to arrange the results in the specified order
- Pagination — allows you to download results from a specific list page
- Field selection — allows you to download a list with a limited number of fields for each result
Request Authorization
Every request MUST include a valid access token obtained during the user authorization process, provided using the Bearer token scheme in the Authorization header.
Successful Response
Error Response
Request Header
GET /ext/freights-api/v1/freights HTTP/1.1
Host: api.platform.trans.eu
Content-Type: application/json
Accept: application/json
Authorization: Bearer {access_token)
Api-key: {unique_app_api-key}Request Parameters (Query)
Filters
The results will be limited according to the specified conditions.
| Filtered freight field | Filter example |
| freight status | /ext/freights-api/v1/freights?filter={"status":"in_progress"} |
| publication types | /ext/freights-api/v1/freights?filter={"publication_type":["exchange"]} |
| truck body | /ext/freights-api/v1/ |
| truck bodies | /ext/freights-api/v1/ |
| loading place | /ext/freights-api/v1/ |
| unloading place | /ext/freights-api/v1/ |
| loading date | /ext/freights-api/v1/ |
| unloading date | /ext/freights-api/v1/ |
Sorting
The results will be arranged in the specified order.
| Sorted freight field | Filter example |
| freight status | /ext/freights-api/v1/ |
| loading date | /ext/freights-api/v1/ |
| unloading date | /ext/freights-api/v1/ |
| creation date | /ext/freights-api/v1/ |
You can sorting in ascending or descending mode by adding order parameter with value asc or desc. Example:
/ext/freights-api/v1/freights?sortBy=created_at&order=descPagination
The results will be downloaded from a specific list page. Each page contains maximum of 30 results.
/ext/freights-api/v1/freights?page=2Fields selection
The results will be downloaded only with the list of fields specified in the query. List of available fields for the query is mentioned below in Response Fields table.
Example Request 1
The id, shipment_external_id and loading place fields are returned.
/ext/freights-api/v1/freights?fields={"id":true,"shipment_external_id":true,"loading":true}Example Request 2
All fields are returned except the publication section.
/ext/freights-api/v1/freights?fields={"publication":false}Response Fields
| Attribute | Type | Example | Description |
| contact_employees | Array of Objects | List of employees assigned to freight negotiation. Default is publisher. | |
| contact_employees.last_name | String | Nowak | Surname of assigned employee |
| contact_employees.name | String | Jan | First name of assigned employee |
| contact_employees.trans_id | String | 13443–1 | TransId of assigned employee |
| created | String | “2025–02-13T13:06:36+01:00” | Freight creation date |
| ftl | Boolean | True | Indication whether the freight is of type FTL (full truck load) |
| height | Float | 3.1 | Vehicle height (range: 0.01–10) |
| id | Int | 234923 | Freight identification number, assigned automatically during creation of a new freight. |
| length | Float | 12 | Vehicle length (range: 0.01–100) |
| loading (see details) | Object | Place and time of loading | |
| publication (see details) | Object | Publication details | |
| reference_number | String | FR/2025/12/30/2NNQ | Freight reference number — a unique, automatically assigned business identifier of the freight |
| requirements | Object | Main transport requirements | |
| requirements.transport | Object | Transport details | |
| requirements.transport.count | Int | 3 | Number of transports — only occurs for multi_ftl transport type |
| requirements.transport.settlement | String | route | Type of settlement. Available values: route, ton. |
| requirements.transport.settlement_basis | String | loading | Settlement basis. No values for route. Acceptable values for ton: loading, unloading |
| shipment_external_id | String | 2023/NWX/1/3 | External identification number |
| status | String | new | Freight status. See details in Freight creation. |
| temperature | Object | Required freight transport temperature. It can be set only for the following truck bodies: cooler, isotherm, hook-truck. | |
| temperature.max | Float | 3 | Maximum temperature |
| temperature.min | Float | -5.5 | Minimum temperature |
| transit_time | Int | 460 | Time expressed in minutes (positive integer) for transport, if specified. |
| transport_type | String | ftl | Possible values for transport type: ftl, ltl, multi_ftl. |
| truck_bodies | Array of String | [“box”,“curtainsider”] | Vehicle body types set in freight (see dictionary). |
| unloading (see details) | Object | Place and time of unloading | |
| vehicle_size | String | “lorry_solo” | Vehicle sizes set in freight. Basic or Composite vehicle size name according to dictionary. |
| volume | Float | 21 | Vehicle volume (range 0.01–10000). |
| width | Float | 3.1 | Vehicle width (range 0.01–10). |
Response Body
[
// ------------------ Freight no. 1 ---------------------
{
"contact_employees": [
{
"last_name": "Nowak",
"name": "Jan",
"trans_id": "1007374-1"
}
],
"created": "2026-02-23T13:08:11+01:00",
"ftl": true,
"height": 4.3,
"id": 3830015,
"length": 5.8,
"loading": {
"coordinates": {
"latitude": 51.142329074,
"longitude": 16.937462521
},
"place": {
"country": "pl",
"locality": "Wroclaw",
"postal_code": "54-128"
},
"timespans": {
"begin": "2026-02-23T13:30:58+01:00",
"begin_local": "2026-02-23T13:30:58+01:00",
"end": "2026-02-23T15:30:58+01:00",
"end_local": "2026-02-23T15:30:58+01:00",
"timezone": "Europe/Warsaw"
}
},
"publication": {
"end_reason": null,
"id": 3304223,
"is_quick_pay": false,
"is_recommended": false,
"is_shared": false,
"price": {
"currency": "eur",
"period": {
"days": 21,
"payment": "deferred"
},
"value": 450
},
"publish_date": "2026-02-23T13:08:11+01:00",
"publish_type": "exchange",
"received_offers": null,
"receivers": {
"corporate_exchanges": [
{
"id": "006e95ea-f307-4a67-bc28-336dfc1cd679",
"name": "API test"
}
],
"private_exchanges": [
{
"id": "49b9aa2b-1987-48d9-9a77-147f97594233",
"name": "Private"
}
]
},
"refresh_from": "2026-02-23T13:23:12+01:00",
"sent_offers": 5,
"sent_to": {
"companies": false,
"corporate_exchange": true,
"direct": true,
"private_exchange": true
},
"smart_match_offers": null,
"status": "active",
"stock_id": null
},
"reference_number": "FR/2026/02/23/2NTS",
"requirements": {
"transport": {
"count": null,
"remaining": null,
"settlement": "route",
"settlement_basis": null
}
},
"shipment_external_id": "1123dfd121",
"status": "in_progress",
"temperature": {
"max": null,
"min": null
},
"transit_time": null,
"transport_type": "ftl",
"truck_bodies": [
"curtainsider"
],
"unloading": {
"coordinates": {
"latitude": 52.519971677,
"longitude": 13.404467562
},
"place": {
"country": "de",
"locality": "Berlin",
"postal_code": "10178"
},
"timespans": {
"begin": "2026-02-26T15:30:58+01:00",
"begin_local": "2026-02-26T15:30:58+01:00",
"end": "2026-02-26T17:30:58+01:00",
"end_local": "2026-02-26T17:30:58+01:00",
"timezone": "Europe/Berlin"
}
},
"vehicle_size": "solo",
"volume": 12.6,
"width": 3.1
},
// ------------------ Freight no. 2 ---------------------
{
"contact_employees": [
{
"last_name": "Brewston",
"name": "Albert",
"trans_id": "1007374-2"
},
{
"last_name": "Smith",
"name": "John",
"trans_id": "1007374-5"
}
],
"created": "2026-02-23T12:20:37+01:00",
"ftl": true,
"height": null,
"id": 3829709,
"length": null,
"loading": {
"coordinates": {
"latitude": 51.142329074,
"longitude": 16.937462521
},
"place": {
"country": "pl",
"locality": "Wroclaw",
"postal_code": "54-128"
},
"timespans": {
"begin": "2026-02-23T13:30:58+01:00",
"begin_local": "2026-02-23T13:30:58+01:00",
"end": "2026-02-23T15:30:58+01:00",
"end_local": "2026-02-23T15:30:58+01:00",
"timezone": "Europe/Warsaw"
}
},
"publication": {
"end_reason": "timeout",
"id": 3303951,
"is_quick_pay": false,
"is_recommended": false,
"is_shared": false,
"price": {
"currency": "eur",
"period": {
"days": 14,
"payment": "deferred"
},
"value": 400
},
"publish_date": "2026-02-23T12:20:37+01:00",
"publish_type": "exchange",
"received_offers": null,
"receivers": {
"corporate_exchanges": [
{
"id": "006e95ea-f307-4a67-bc28-336dfc1cd679",
"name": "API test"
}
]
},
"refresh_from": null,
"sent_offers": 2,
"sent_to": {
"companies": false,
"corporate_exchange": true,
"direct": false,
"private_exchange": false
},
"smart_match_offers": null,
"status": "finished",
"stock_id": null
},
"reference_number": "FR/2026/02/23/2N0X",
"requirements": {
"transport": {
"count": null,
"remaining": null,
"settlement": "route",
"settlement_basis": null
}
},
"shipment_external_id": "1123dfd121",
"status": "unsuccessful_publication",
"temperature": {
"max": null,
"min": null
},
"transit_time": null,
"transport_type": "ftl",
"truck_bodies": [
"platform-trailer"
],
"unloading": {
"coordinates": {
"latitude": 45.397205283,
"longitude": 9.21659417
},
"place": {
"country": "it",
"locality": "Milan",
"postal_code": "20097"
},
"timespans": {
"begin": "2026-02-26T13:30:58+01:00",
"begin_local": "2026-02-26T13:30:58+01:00",
"end": "2026-02-26T15:30:58+01:00",
"end_local": "2026-02-26T15:30:58+01:00",
"timezone": "Europe/San_Marino"
}
},
"vehicle_size": "double_trailer",
"volume": null,
"width": null
},
// ------------------ Freight no. 3 ---------------------
{
"contact_employees": [
{
"last_name": "Nowak",
"name": "Jan",
"trans_id": "1007374-1"
}
],
"created": "2026-02-20T10:28:59+01:00",
"ftl": true,
"height": 9.1,
"id": 3828341,
"length": 6.1,
"loading": {
"coordinates": {
"latitude": 51.142329074,
"longitude": 16.937462521
},
"place": {
"country": "pl",
"locality": "Wroclaw",
"postal_code": "54-128"
},
"timespans": {
"begin": "2026-02-23T10:28:57+01:00",
"begin_local": "2026-02-23T10:28:57+01:00",
"end": "2026-02-23T12:28:57+01:00",
"end_local": "2026-02-23T12:28:57+01:00",
"timezone": "Europe/Warsaw"
}
},
"publication": null,
"reference_number": "FR/2026/02/20/2NNQ",
"requirements": {
"transport": {
"count": null,
"settlement": "route",
"settlement_basis": null
}
},
"shipment_external_id": "1111",
"status": "new",
"temperature": {
"max": null,
"min": null
},
"transit_time": 4300,
"transport_type": "ftl",
"truck_bodies": [
"dump-truck"
],
"unloading": {
"coordinates": {
"latitude": 47.61,
"longitude": 13.7824
},
"place": {
"country": "pl",
"locality": "Wroclaw",
"postal_code": "54-128"
},
"timespans": {
"begin": "2026-02-26T10:28:57+01:00",
"begin_local": "2026-02-26T10:28:57+01:00",
"end": "2026-02-26T12:28:57+01:00",
"end_local": "2026-02-26T12:28:57+01:00",
"timezone": "Europe/Warsaw"
}
},
"vehicle_size": "lorry",
"volume": 12.1,
"width": 6.6
}
]Client errors (code 400)
HTTP 4xx status codes indicate client errors, meaning that the request could not be processed due to an issue on the client side. Below is a list of request-specific errors.
Example error 1
Incorrect field in query
{
"detail": "Failed Validation",
"status": 422,
"title": "Unprocessable Entity",
"validation_messages": {
"sortBy": {
"notInArray": "Allowed values: status, created_at, loading_date, unloading_date, archived_at"
}
}
}