1. Trans.eu Api
  2. Freights section
  3. Get archived freights list

Get archived freights list

Down­load­ing a list of archived freights cre­at­ed in the com­pa­ny accounts both via API and on the Trans.eu Plat­form. End­point returns freights in closed freight sta­tus.
The returned results are pag­i­nat­ed with max­i­mum of 30 per page.

For down­load accept­ed freights vis­it Get accept­ed freights list, for down­load new and active freights vis­it Get freights list.

GET
/ext/freights-api/v1/archive

This method sup­ports query mod­i­fiers that allow you to cus­tomize the list of returned results to your own needs. The list of all para­me­ters is spec­i­fied below in Query Para­me­ters.

  • Fil­ter­ing — allows you to down­load a list accord­ing to spec­i­fied cri­te­ria
  • Sort­ing — allows you to arrange the results in the spec­i­fied order
  • Pag­i­na­tion — allows you to down­load results from a spe­cif­ic list page
  • Fields selec­tion — allows you to down­load a list with a lim­it­ed num­ber of fields for each result
Request Authorization

Every request MUST include a valid access token obtained dur­ing the user autho­riza­tion process, pro­vid­ed using the Bear­er token scheme in the Autho­riza­tion head­er.

Request

Request Head­er

Request Para­me­ters (Query)

Successful Response

Response Fields

Response Body

Error Response

Client errors (400)

Gen­er­al API errors

Request Header
GET /ext/freights-api/v1/archive 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 lim­it­ed accord­ing to the spec­i­fied con­di­tions.

Fil­tered freight fieldFil­ter exam­ple
truck body/ext/freights-api/v1/archive?filter={"truck_body_type":"cooler"}
truck bod­ies/ext/freights-api/v1/archive?filter={"truck_body_types":["box","curtainsider"]}
load­ing place/ext/freights-api/v1/archive?filter={"loading_place":{"country":"it","postal_code":"88100"}}
unload­ing place/ext/freights-api/v1/archive?filter={"unloading_place":{"country":"pl","postal_code":"53-146"}}
load­ing date/ext/freights-api/v1/archive?filter={"loading_date":{"start_date":"2025-01-29","end_date":"2025-02-12"}}
unload­ing date/ext/freights-api/v1/archive?filter={"unloading_date":{"start_date":"2025-01-31","end_date":"2026-02-18"}}
Sorting

The results will be arranged in the spec­i­fied order.

Sort­ed freight fieldFil­ter exam­ple
freight sta­tus/ext/freights-api/v1/archive?sortBy=status
load­ing date/ext/freights-api/v1/archive?sortBy=loading_date
unload­ing date/ext/freights-api/v1/archive?sortBy=unloading_date
cre­ation date/ext/freights-api/v1/archive?sortBy=created_at

You can sort­ing in ascend­ing or descend­ing mode by adding order para­me­ter with val­ue asc or desc. Exam­ple:

/ext/freights-api/v1/archive?sortBy=created_at&order=desc
Pagination

The results will be down­loaded from a spe­cif­ic list page. Each page con­tains max­i­mum of 30 results.

/ext/freights-api/v1/archive?page=2
Fields selection

The results will be down­loaded only with the list of fields spec­i­fied in the query. List of avail­able fields for the query is men­tioned below in Response Fields table.

Example Request 1

The id, shipment_external_id and load­ing place fields are returned.

/ext/freights-api/v1/archive?fields={"id":true,"shipment_external_id":true,"loading":true}
Example Request 2

All fields are returned except the pub­li­ca­tion sec­tion.

/ext/freights-api/v1/archive?fields={"publication":false}
Response Fields
AttributeTypeExam­pleDescrip­tion
archived_atString“2025–02-17T13:06:36+01:00”Freight archiv­ing time
contact_employeesArray of ObjectsList of employ­ees assigned to freight nego­ti­a­tion. Default is pub­lish­er.
contact_employees.last_nameStringNowakSur­name of assigned employ­ee
contact_employees.nameStringJanFirst name of assigned employ­ee
contact_employees.trans_idString13443–1Tran­sId of assigned employ­ee
cre­at­edString“2025–02-13T13:06:36+01:00”Freight cre­ation date
ftlBooleanTrueIndi­ca­tion whether the freight is of type FTL (full truck load)
heightFloat3.1Vehi­cle height (range: 0.01–10)
idInt234923Freight iden­ti­fi­ca­tion num­ber, assigned auto­mat­i­cal­ly dur­ing cre­ation of a new freight.
lengthFloat12Vehi­cle length (range: 0.01–100)
load­ing (see details)ObjectPlace and time of load­ing
pub­li­ca­tion (see details)ObjectPub­li­ca­tion details
reference_numberStringFR/2025/12/30/2NNQFreight ref­er­ence num­ber — a unique, auto­mat­i­cal­ly assigned busi­ness iden­ti­fi­er of the freight
require­mentsObjectMain trans­port require­ments
requirements.transportObjectTrans­port details
requirements.transport.countInt3Num­ber of all trans­ports in freight — only occurs for multi_ftl trans­port type
requirements.transport.remainingInt1Num­ber of remain­ing trans­ports in freight — only occurs for multi_ftl trans­port type
requirements.transport.settlementStringrouteType of set­tle­ment. Avail­able val­ues: route, ton.
requirements.transport.settlement_basisStringload­ingSet­tle­ment basis.
No val­ues for route. Accept­able val­ues for ton: loading, unloading
shipment_external_idString2023/NWX/1/3Exter­nal iden­ti­fi­ca­tion num­ber
sta­tusStringnewFreight sta­tus. See oth­er sta­tus­es.
tem­per­a­tureObjectRequired freight trans­port tem­per­a­ture. It can be set only for the fol­low­ing truck bod­ies: cooler, isotherm, hook-truck.
temperature.maxFloat3Max­i­mum tem­per­a­ture
temperature.minFloat-5.5Min­i­mum tem­per­a­ture
transit_timeInt460Time expressed in min­utes (pos­i­tive inte­ger) for trans­port, if spec­i­fied.
transport_typeStringftlPos­si­ble val­ues for trans­port type: ftl, ltl, multi_ftl.
truck_bodiesArray of String[“box”,“curtainsider”]Vehi­cle body types set in freight (see dic­tio­nary).
unload­ing (see details)ObjectPlace and time of unload­ing
vehicle_sizeString“lorry_solo”Vehi­cle sizes set in freight. Basic or Com­pos­ite vehi­cle size name accord­ing to dic­tio­nary.
vol­umeFloat21Vehi­cle vol­ume (range 0.01–10000).
widthFloat3.1Vehi­cle width (range 0.01–10).
Response Body
[
    {
        "archived_at": "2026-02-10T06:12:42+01:00",
        "contact_employees": [
            {
                "last_name": "Jan",
                "name": "Nowakowski",
                "trans_id": "1007374-1"
            }
        ],
        "created": "2026-02-06T14:40:08+01:00",
        "ftl": false,
        "height": null,
        "id": 3815468,
        "length": null,
        "loading": {
            "coordinates": {
                "latitude": 53.601226847,
                "longitude": 21.417734311
            },
            "place": {
                "country": "pl",
                "locality": "Wroclaw",
                "postal_code": "53-146"
            },
            "timespans": {
                "begin": "2026-02-09T14:40:06+01:00",
                "begin_local": "2026-02-09T14:40:06+01:00",
                "end": "2026-02-09T16:40:06+01:00",
                "end_local": "2026-02-09T16:40:06+01:00",
                "timezone": "Europe/Warsaw"
            }
        },
        "publication": {
            "end_reason": "timeout",
            "id": 3290464,
            "is_quick_pay": false,
            "is_recommended": false,
            "is_shared": false,
            "price": {
                "currency": "eur",
                "period": {
                    "days": null,
                    "payment": null
                },
                "value": null
            },
            "publish_date": "2026-02-06T14:40:08+01:00",
            "publish_type": "exchange",
            "received_offers": null,
            "receivers": {},
            "refresh_from": null,
            "sent_offers": 1,
            "sent_to": {
                "companies": true,
                "corporate_exchange": null,
                "direct": false,
                "private_exchange": false
            },
            "smart_match_offers": null,
            "status": "finished"
        },
        "reference_number": "FR/2026/02/06/22V5",
        "requirements": {
            "transport": {
                "count": null,
                "remaining": null,
                "settlement": null,
                "settlement_basis": null
            }
        },
        "shipment_external_id": null,
        "status": "closed",
        "temperature": {
            "max": null,
            "min": null
        },
        "transit_time": null,
        "transport_type": "ltl",
        "truck_bodies": [
            "curtainsider"
        ],
        "unloading": {
            "coordinates": {
                "latitude": 50.801536987,
                "longitude": 13.076077393
            },
            "place": {
                "country": "de",
                "locality": "Nürnberg",
                "postal_code": "09876"
            },
            "timespans": {
                "begin": "2026-02-12T14:40:06+01:00",
                "begin_local": "2026-02-12T14:40:06+01:00",
                "end": "2026-02-12T16:40:06+01:00",
                "end_local": "2026-02-12T16:40:06+01:00",
                "timezone": "Europe/Berlin"
            }
        },
        "vehicle_size": "any_size",
        "volume": null,
        "width": null
    }
]

Client errors (code 400)

HTTP 4xx sta­tus codes indi­cate client errors, mean­ing that the request could not be processed due to an issue on the client side. Below is a list of request-spe­cif­ic errors.

Example error 1

Incor­rect field in query

{
    "detail": "Failed Validation",
    "status": 422,
    "title": "Unprocessable Entity",
    "validation_messages": {
        "sortBy": {
            "notInArray": "Allowed values: status, created_at, loading_date, unloading_date"
        }
    }
}
Example error 2

Incor­rect query

{
    "detail": "Failed Validation",
    "status": 422,
    "title": "Unprocessable Entity",
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "validation_messages": {
        "filter": {
            "truck_body_types": {
                "notArray": "Given value must be valid array"
            }
        }
    }
}