Freight creation

On the Trans.eu Plat­form, a freight is used to define and offer a ship­ment / trans­port job that is to be car­ried out by a car­ri­er. The freight can then be pub­lished (e.g. on the freight exchange or to select­ed car­ri­ers) to find a con­trac­tor for the trans­port.
In prac­tice, a freight includes key infor­ma­tion need­ed to com­plete the trans­port, such as:

  • the route (load­ing and unload­ing loca­tions),
  • dates (load­ing and unload­ing oper­a­tions),
  • car­go require­ments and para­me­ters,
  • set­tle­ment terms and price.
  • con­tact employ­ees

To cre­ate a freight, you can use one of sev­er­al API requests, which can also be used simul­ta­ne­ous­ly to pub­lish the freight. If you cre­ate a freight with­out pub­lish­ing it (new sta­tus), it will not be vis­i­ble to oth­er users, even with­in your own com­pa­ny. A freight cre­at­ed this way can be updat­ed by API method but it can be pub­lished only from the Trans.eu Plat­form.
The rules of of pub­lish­ing via the API are described in Freight pub­li­ca­tion.

Components of a single freight
  1. Route – a list of con­sec­u­tive loca­tions that the vehi­cle must reach with the car­go or to pick up car­go, togeth­er with the oper­a­tion to be per­formed at each route point.
    • Data from this sec­tion is rep­re­sent­ed by the spots object in the request/response para­me­ters.
    • At the first route point, the manda­to­ry oper­a­tion is loading.
    • At the last route point, the manda­to­ry oper­a­tion is unloading.
    • In mul­ti-stop routes, more than two route points may occur.
    • More than one oper­a­tion can be per­formed at a sin­gle route point.
    • With­in an oper­a­tion, it is pos­si­ble to spec­i­fy the quan­ti­ty of spe­cif­ic loads intend­ed for load­ing or unload­ing — it is nec­es­sary to main­tain a weight bal­ance of the car­go dur­ing load­ing and unload­ing oper­a­tions so that it is con­sis­tent with the val­ues pro­vid­ed in the Load details sec­tion.
    • The chronol­o­gy of the times pro­vid­ed for indi­vid­ual oper­a­tions must be increas­ing as the route is com­plet­ed.
         
  2. Vehi­cle require­ments – a set of para­me­ters describ­ing the require­ments for the vehi­cle ded­i­cat­ed to trans­port­ing the car­go.
    • Data from this sec­tion is rep­re­sent­ed by the requirements object and a list of indi­vid­ual attrib­ut­es in the request/response para­me­ters.
    • On the Plat­form, in the Cre­ate freight win­dow, the rel­e­vant data is entered in the Vehi­cle require­ments, Trans­port details, and Vehi­cle details sec­tions.
    • Some para­me­ters in this sec­tion are manda­to­ry, while oth­ers are option­al, as described for each attribute.
        
  3. Load details – a detailed descrip­tion of the loads that may be includ­ed in the trans­port cov­ered by the freight.
    • Data from this sec­tion is rep­re­sent­ed by the loads object in the request/response para­me­ters.
    • On the Plat­form, in the Cre­ate freight win­dow, the rel­e­vant data is entered in the Load details sec­tion.
    • The total weight of the spec­i­fied loads must not exceed the val­ue spec­i­fied in Capac­i­ty.
    • The entire Load details sec­tion is option­al — the min­i­mum require­ment to describe the size of the freight is the Capac­i­ty field in main para­me­ters of request.
         
  4. Pay­ment con­di­tions – attrib­ut­es describ­ing the pay­ment terms pro­posed by the pub­lish­ing par­ty for the trans­port of the car­go, includ­ing the trans­port price.
    • Data from this sec­tion is rep­re­sent­ed by the payment object in the request/response para­me­ters.
    • On the Plat­form, in the Cre­ate freight win­dow, the rel­e­vant data is entered in the sec­tion on the right-hand side of the win­dow.
         
  5. Oth­er freight para­me­ters – includ­ing con­tact per­sons, pub­li­ca­tion para­me­ters, and links to the customer’s exter­nal sys­tem.
    • Data from this sec­tion is rep­re­sent­ed by a list of indi­vid­ual attrib­ut­es in the request/response para­me­ters.
    • On the Plat­form, in the Cre­ate freight win­dow, the rel­e­vant data is entered in the sec­tion on the right-hand side of the win­dow.

A detailed list of freight attrib­ut­es is described in the spec­i­fi­ca­tion of each func­tion used to cre­ate and down­load freights.

Multifreights

Mul­ti­freight allows pub­lish­ing a freight offer that includes mul­ti­ple trans­port oper­a­tions, with set­tle­ment per route or per ton of car­go. To define mul­ti­freight, enter the multi_ftl val­ue ​​in the requirements.transport.transport.type field and com­plete the remain­ing fields in the sec­tion requirements.transport accord­ing­ly.

Internal notes

An inter­nal note can be added to a freight and is only vis­i­ble to users from your com­pa­ny and is not vis­i­ble to car­ri­ers nego­ti­at­ing the offer. Only one note can be added to the freight. The note can­not be longer than 500 char­ac­ters.

Archiving

Freights for which the planned exe­cu­tion time has passed are moved to the archive so that they do not occu­py space on the list of cur­rent­ly processed freights.
The Plat­form runs an auto­mat­ic freight archiv­ing process which, at the end of the day, archives freights whose load­ing date has passed and for which:

  • the pub­li­ca­tion peri­od ends and at least one offer was sub­mit­ted by a car­ri­er, but the per­son pub­lish­ing the freight did not select any offer

Freights can also be moved to the archive man­u­al­ly, ear­li­er than the auto­mat­ic process. The freight sta­tus that allows archiv­ing: unsuccessful_publication, in_progress.

Ded­i­cat­ed API func­tions are avail­able for archiv­ing and man­ag­ing archived freights. The fol­low­ing oper­a­tions are sup­port­ed:
   — man­u­al archiv­ing of a sin­gle freight
   — bulk archiv­ing of mul­ti­ple freights
   — search­ing the list of archived freights

Freight statuses

Val­ues ​​returned in the sta­tus field in GET method

Dedicated Requests
Link to detailsDescrip­tionRequest
Cre­ate freightAllows you to cre­ate a new freightPOST /ex­t/freights-api/v1/freights

Freight can also be cre­at­ed by any pub­li­ca­tion request with the "publish": false attribute set.
Get freights listAllows you to down­load fil­tered list of freights cre­at­ed in your own com­pa­ny accountsGET /ex­t/freights-api/v1/freights
Get freight detailsAllows you to down­load details of spec­i­fied freightGET /ext/freights-api/v1/freights/{freight-id}
Get accept­ed freights listAllows you to down­load fil­tered list of accept­ed freights cre­at­ed in your own com­pa­ny accountsGET /ex­t/freights-api/v1/ac­cept­ed
Update freightAllows you to replace con­tent of spec­i­fied freight that has not yet been pub­lishedPUT /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 freightAllows you to delete spec­i­fied freight in draft sta­tusDELETE /ext/freights-api/v1/freights/{freight-id}
Add an inter­nal noteAllows you to add an inter­nal note to the freightPOST /ext/freights-api/v1/freights/{freight-id}/internal-note
Update an inter­nal noteAllows you to update inter­nal note cre­at­ed for the freightPUT /ext/freights-api/v1/freights/{freight-id}/internal-note
Get an inter­nal noteAllows you to down­load con­tent of an inter­nal note cre­at­ed for the freightGET /ext/freights-api/v1/freights/{freight-id}/internal-note
Delete an inter­nal noteAllows you to delete con­tent of an inter­nal note cre­at­ed for the freightDELETE /ext/freights-api/v1/freights/{freight-id}/internal-note
Archive freightAllows you to archive select­ed, not active freight cre­at­ed in your own com­pa­ny accountsPOST /ext/freights-api/v1/freights/{freight-id}/archive
Bulk freight archiv­ingAllows you to archive select­ed, not active freights cre­at­ed in your own com­pa­ny accountsPOST /ex­t/freights-api/v1/freight­s/archive
Get archived freights listAllows you to down­load fil­tered list of archived freights cre­at­ed in your own com­pa­ny accountsGET /ex­t/freights-api/v1/archive