Integration scenario for carrier

Descrip­tion of receiv­ing new freight pro­pos­als with price nego­ti­a­tion and accep­tance.


  • car­ri­er uses to receive new coop­er­a­tion pro­pos­als
  • car­ri­er active­ly uses Plat­form for freight man­age­ment
  • both freight for­warder and car­ri­ers have exist­ing and valid account
  • car­ri­er down­loads all freight coop­er­a­tion pro­pos­als from to exter­nal TMS
  • nego­ti­a­tion process is moved to exter­nal TMS
  • freight accep­tance is moved to exter­nal TMS
  • for accept­ed freight there is a trans­port order received


Authorize access

Before it is pos­si­ble to send any request, user needs to autho­rize access.

  • client app was reg­is­tered using reg­is­tra­tion form
  • exter­nal app was grant­ed api keys (client_id and client_secret)
  • autho­riza­tion process has been imple­ment­ed in exter­nal app

Receive new freights

Each freight will con­sist of:

  • array of car­ri­ers’ ids
  • load­ing loca­tion and time
  • unload­ing loca­tion and time
  • required truck body type
  • sum­ma­ry of freight’s loads weight
  • ftl/ltl para­me­ter

Exam­ple pay­load can be found here.

Negotiate freight conditions

If freight pric­ing con­di­tions did not meet car­ri­ers expec­ta­tion, they  might be allowed to nego­ti­ate the price.

Each price nego­ti­a­tion offer con­sists of:

  • price val­ue
  • price cur­ren­cy
  • iden­ti­fi­ca­tion of offer cre­ator
  • ver­sion of offer
  • date and time of offer cre­ation

Freight nego­ti­a­tion details can be found here.

Receive transport order

Accept­ed freight cre­ates trans­port order, which con­sists of:

  • freight details (freight id, loca­tions, loads, require­ments, etc)
  • car­ri­er details (address and VAT num­ber)
  • freight for­warder details (address and VAT num­ber)
  • dri­ver details
  • vehi­cle details

For more details about trans­port orders please click here.