On the Trans.eu Platform, a freight is used to define and offer a shipment / transport job that is to be carried out by a carrier. The freight can then be published (e.g. on the freight exchange or to selected carriers) to find a contractor for the transport.
In practice, a freight includes key information needed to complete the transport, such as:
- the route (loading and unloading locations),
- dates (loading and unloading operations),
- cargo requirements and parameters,
- settlement terms and price.
- contact employees
To create a freight, you can use one of several API requests, which can also be used simultaneously to publish the freight. If you create a freight without publishing it (new status), it will not be visible to other users, even within your own company. A freight created this way can be updated by API method but it can be published only from the Trans.eu Platform.
The rules of of publishing via the API are described in Freight publication.
Components of a single freight
- Route – a list of consecutive locations that the vehicle must reach with the cargo or to pick up cargo, together with the operation to be performed at each route point.
- Data from this section is represented by the
spotsobject in the request/response parameters. - At the first route point, the mandatory operation is
loading. - At the last route point, the mandatory operation is
unloading. - In multi-stop routes, more than two route points may occur.
- More than one operation can be performed at a single route point.
- Within an operation, it is possible to specify the quantity of specific loads intended for loading or unloading — it is necessary to maintain a weight balance of the cargo during loading and unloading operations so that it is consistent with the values provided in the Load details section.
- The chronology of the times provided for individual operations must be increasing as the route is completed.
- Data from this section is represented by the
- Vehicle requirements – a set of parameters describing the requirements for the vehicle dedicated to transporting the cargo.
- Data from this section is represented by the
requirementsobject and a list of individual attributes in the request/response parameters. - On the Platform, in the Create freight window, the relevant data is entered in the Vehicle requirements, Transport details, and Vehicle details sections.
- Some parameters in this section are mandatory, while others are optional, as described for each attribute.
- Data from this section is represented by the
- Load details – a detailed description of the loads that may be included in the transport covered by the freight.
- Data from this section is represented by the
loadsobject in the request/response parameters. - On the Platform, in the Create freight window, the relevant data is entered in the Load details section.
- The total weight of the specified loads must not exceed the value specified in Capacity.
- The entire Load details section is optional — the minimum requirement to describe the size of the freight is the Capacity field in main parameters of request.
- Data from this section is represented by the
- Payment conditions – attributes describing the payment terms proposed by the publishing party for the transport of the cargo, including the transport price.
- Data from this section is represented by the
paymentobject in the request/response parameters. - On the Platform, in the Create freight window, the relevant data is entered in the section on the right-hand side of the window.
- Data from this section is represented by the
- Other freight parameters – including contact persons, publication parameters, and links to the customer’s external system.
- Data from this section is represented by a list of individual attributes in the request/response parameters.
- On the Platform, in the Create freight window, the relevant data is entered in the section on the right-hand side of the window.
A detailed list of freight attributes is described in the specification of each function used to create and download freights.
Multifreights
Multifreight allows publishing a freight offer that includes multiple transport operations, with settlement per route or per ton of cargo. To define multifreight, enter the multi_ftl value in the requirements.transport.transport.type field and complete the remaining fields in the section requirements.transport accordingly.
Internal notes
An internal note can be added to a freight and is only visible to users from your company and is not visible to carriers negotiating the offer. Only one note can be added to the freight. The note cannot be longer than 500 characters.
Archiving
Freights for which the planned execution time has passed are moved to the archive so that they do not occupy space on the list of currently processed freights.
The Platform runs an automatic freight archiving process which, at the end of the day, archives freights whose loading date has passed and for which:
- the publication period ends without any offers being submitted for the freight, or
- the publication period ends and at least one offer was submitted by a carrier, but the person publishing the freight did not select any offer
Freights can also be moved to the archive manually, earlier than the automatic process. The freight status that allows archiving: unsuccessful_publication, in_progress.
Dedicated API functions are available for archiving and managing archived freights. The following operations are supported:
— manual archiving of a single freight
— bulk archiving of multiple freights
— searching the list of archived freights
Freight statuses
Values returned in the status field in GET method
| Freight status | Description |
| accepted | The freight has been accepted and the carrier has been selected |
| closed | An unaccepted freight that is in the archive |
| in_progress | When the freight is being published, is under negotiation or is in the process of selecting offers |
| new | Newly created freight |
| unsuccessful_publication | Freight publication ended, re-publication possible |
| waiting_for_publication | Freight scheduled to publication |
Dedicated Requests
| Link to details | Description | Request |
| Create freight | Allows you to create a new freight | POST /ext/freights-api/v1/freights Freight can also be created by any publication request with the "publish": false attribute set. |
| Get freights list | Allows you to download filtered list of freights created in your own company accounts | GET /ext/freights-api/v1/freights |
| Get freight details | Allows you to download details of specified freight | GET /ext/freights-api/v1/freights/{freight-id} |
| Get accepted freights list | Allows you to download filtered list of accepted freights created in your own company accounts | GET /ext/freights-api/v1/accepted |
| Update freight | Allows you to replace content of specified freight that has not yet been published | PUT /ext/freights-api/v1/freights/{freight-id} PUT /ext/freights-api/v1/freight-exchange/{freight-id} PUT /ext/freights-api/v1/private-exchange/{freight-id} PUT /ext/freights-api/v1/freight-corporate/{freight-id} PUT /ext/freights-api/v1/freight-companies/{freight-id} PUT /ext/freights-api/v1/freight-employees/{freight-id} PUT /ext/freights-api/v1/freight-auto/{freight-id} |
| Delete freight | Allows you to delete specified freight in draft status | DELETE /ext/freights-api/v1/freights/{freight-id} |
| Add an internal note | Allows you to add an internal note to the freight | POST /ext/freights-api/v1/freights/{freight-id}/internal-note |
| Update an internal note | Allows you to update internal note created for the freight | PUT /ext/freights-api/v1/freights/{freight-id}/internal-note |
| Get an internal note | Allows you to download content of an internal note created for the freight | GET /ext/freights-api/v1/freights/{freight-id}/internal-note |
| Delete an internal note | Allows you to delete content of an internal note created for the freight | DELETE /ext/freights-api/v1/freights/{freight-id}/internal-note |
| Archive freight | Allows you to archive selected, not active freight created in your own company accounts | POST /ext/freights-api/v1/freights/{freight-id}/archive |
| Bulk freight archiving | Allows you to archive selected, not active freights created in your own company accounts | POST /ext/freights-api/v1/freights/archive |
| Get archived freights list | Allows you to download filtered list of archived freights created in your own company accounts | GET /ext/freights-api/v1/archive |