{"id":1824,"date":"2020-05-25T11:26:26","date_gmt":"2020-05-25T09:26:26","guid":{"rendered":"https:\/\/www.trans.eu\/api\/?p=1824"},"modified":"2025-12-29T11:06:42","modified_gmt":"2025-12-29T10:06:42","slug":"interation-scenario-for-shipper","status":"publish","type":"post","link":"https:\/\/www.trans.eu\/api\/use-cases\/interation-scenario-for-shipper\/","title":{"rendered":"Integration scenario for shipper"},"content":{"rendered":"\n<p>A step-by-step guide and best prac\u00adtices for inte\u00adgrat\u00ading a ship\u00adper solu\u00adtion.<\/p>\n\n\n\n<!--more-->\n\n\n\n<p>Please be aware that some of them may con\u00adtain only par\u00adtial requests.<\/p>\n\n\n\n<p>Due to fact, that com\u00adplete requests and respons\u00ades are very long in many cas\u00ades they were trimmed down to what\u2019s real\u00adly impor\u00adtant in giv\u00aden use case.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Scenario<\/h2>\n\n\n\n<p>Com\u00adplete solu\u00adtion for inte\u00adgrat\u00ading all avail\u00adable Trans.eu API for the high\u00adest pos\u00adsi\u00adble automa\u00adtion lev\u00adel, con\u00adsid\u00ader\u00ading:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>car\u00adri\u00ader is yet to be deter\u00admined<\/li>\n\n\n\n<li>car\u00adri\u00ader is using Trans.eu Plat\u00adform only, with no addi\u00adtion\u00adal freight man\u00adage\u00adment soft\u00adware involved<\/li>\n\n\n\n<li>both ship\u00adper and car\u00adri\u00aders have exist\u00ading and valid Trans.eu account<\/li>\n\n\n\n<li>all ship\u00adper\u2019s freight man\u00adage\u00adment will be done using api<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Scenario diagram<\/strong><\/h2>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"462\" src=\"https:\/\/www.trans.eu\/api\/wp-content\/uploads\/publikacje-rodzaje-z-endpointami-1024x462.png\" alt class=\"wp-image-3477\" srcset=\"https:\/\/www.trans.eu\/api\/wp-content\/uploads\/publikacje-rodzaje-z-endpointami-1024x462.png 1024w, https:\/\/www.trans.eu\/api\/wp-content\/uploads\/publikacje-rodzaje-z-endpointami-300x135.png 300w, https:\/\/www.trans.eu\/api\/wp-content\/uploads\/publikacje-rodzaje-z-endpointami-768x346.png 768w, https:\/\/www.trans.eu\/api\/wp-content\/uploads\/publikacje-rodzaje-z-endpointami-1536x693.png 1536w, https:\/\/www.trans.eu\/api\/wp-content\/uploads\/publikacje-rodzaje-z-endpointami-2048x924.png 2048w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\"><\/figure>\n<\/div>\n\n\n<h2 class=\"wp-block-heading\">Authorize access<\/h2>\n\n\n\n<p>Before it is pos\u00adsi\u00adble to send any request, user needs to <a href=\"https:\/\/www.trans.eu\/api\/general-information\/authorization-process\/\" title>autho\u00adrize access<\/a>.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>client app was reg\u00adis\u00adtered using reg\u00adis\u00adtra\u00adtion form<\/li>\n\n\n\n<li>exter\u00adnal app was grant\u00aded api keys (client_id and client_secret)<\/li>\n\n\n\n<li>autho\u00adriza\u00adtion process has been imple\u00adment\u00aded in exter\u00adnal app<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\">Create new freight<\/h2>\n\n\n\n<p>Once the autho\u00adriza\u00adtion has been grant\u00aded, it is now pos\u00adsi\u00adble to cre\u00adate new freight. This ele\u00adment is being used when:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>trust\u00aded car\u00adri\u00aders oper\u00adate on Trans.eu Plat\u00adform and been assigned to appro\u00adpri\u00adate groups<\/li>\n\n\n\n<li>new car\u00adri\u00aders can be assigned using Smart\u00admatch algo\u00adrithm<\/li>\n\n\n\n<li>own fleet is insuf\u00adfi\u00adcient<\/li>\n\n\n\n<li>addi\u00adtion\u00adal, spot freight has been assigned<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Each freight must consist of:<\/strong><\/h3>\n\n\n\n<ul class=\"wp-block-list\">\n<li>load\u00ading loca\u00adtion and time<\/li>\n\n\n\n<li>unload\u00ading loca\u00adtion and time<\/li>\n\n\n\n<li>required truck body type<\/li>\n\n\n\n<li>sum\u00adma\u00adry of freight\u2019s loads weight<\/li>\n\n\n\n<li>ftl\/ltl para\u00adme\u00adter<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>The use of all the possibilities of freight consists of:<\/strong><\/h3>\n\n\n\n<ul class=\"wp-block-list\">\n<li>pro\u00advid\u00ading pre\u00adcise infor\u00adma\u00adtion about spots on freight route, includ\u00ading address, coor\u00addi\u00adnates and sched\u00adule<\/li>\n\n\n\n<li>assign\u00ading detailed infor\u00adma\u00adtion regard\u00ading loads<\/li>\n\n\n\n<li>cre\u00adat\u00ading detailed oper\u00ada\u00adtions of load\u00ading and unload\u00ading each load in spec\u00adi\u00adfied spots<\/li>\n<\/ul>\n\n\n\n<p>In this use case only pub\u00adli\u00adca\u00adtion using automa\u00adtion rules is con\u00adsid\u00adered.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Other freight parameters:<\/strong><\/h3>\n\n\n\n<ul class=\"wp-block-list\">\n<li>external_source \u2014 allows to send inter\u00adnal freight iden\u00adti\u00adfi\u00ader to Trans.eu Plat\u00adform<\/li>\n\n\n\n<li>load\u00ading meters \u2014 sum\u00adma\u00adry of load\u00ading meters for loads assigned to freight (described below)<\/li>\n\n\n\n<li>oth\u00ader require\u00adments, such as manda\u00adto\u00adry GPS device, adr class\u00ades, load\u00ading type, pack\u00adag\u00ading type, etc.<\/li>\n\n\n\n<li>loads<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Validation rules:<\/strong><\/h3>\n\n\n\n<ul class=\"wp-block-list\">\n<li>there has to be at least one load\u00ading spot and one unload\u00ading spot<\/li>\n\n\n\n<li>sum\u00adma\u00adry of loads weight must equal freight capac\u00adi\u00adty<\/li>\n\n\n\n<li>sum\u00adma\u00adry of load oper\u00ada\u00adtion weight must equal zero<\/li>\n\n\n\n<li>sum\u00adma\u00adry of loads length and width must equal appro\u00adpri\u00adate amount of load\u00ading meters<\/li>\n<\/ul>\n\n\n\n<p>Addi\u00adtion\u00adal pos\u00adsi\u00adbil\u00adi\u00adties avail\u00adable dur\u00ading freight cre\u00adation:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>if there are no coor\u00addi\u00adnates set for spots loca\u00adtion, API will assign coor\u00addi\u00adnates for rec\u00adog\u00adnized loca\u00adtions<\/li>\n<\/ul>\n\n\n\n<p>Exam\u00adple pay\u00adload and freight cre\u00adation descrip\u00adtion can be found <a href=\"https:\/\/www.trans.eu\/api\/freights\/create-new-freight\/\">here<\/a>.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Negotiate freight conditions<\/h2>\n\n\n\n<p>If freight pric\u00ading con\u00addi\u00adtions did not meet car\u00adri\u00aders expec\u00adta\u00adtion, they&nbsp; might be allowed to nego\u00adti\u00adate the price.<\/p>\n\n\n\n<p>Each price nego\u00adti\u00ada\u00adtion offer con\u00adsists of:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>price val\u00adue<\/li>\n\n\n\n<li>price cur\u00adren\u00adcy<\/li>\n\n\n\n<li>iden\u00adti\u00adfi\u00adca\u00adtion of offer cre\u00adator<\/li>\n\n\n\n<li>ver\u00adsion of offer<\/li>\n\n\n\n<li>date and time of offer cre\u00adation<\/li>\n<\/ul>\n\n\n\n<p>Freight nego\u00adti\u00ada\u00adtion details can be found <a href=\"https:\/\/www.trans.eu\/api\/freights\/negotiation-process\/\">here<\/a>.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Cancel freight publication<\/h2>\n\n\n\n<p>How to can\u00adcel freight pub\u00adli\u00adca\u00adtion is described <a href=\"https:\/\/www.trans.eu\/api\/freights\/cancel-freight-publication\/\">here<\/a>.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Archive freight<\/h2>\n\n\n\n<p>For freight where pub\u00adli\u00adca\u00adtion was can\u00adcelled or nev\u00ader invoked it is pos\u00adsi\u00adble to archive the freight. Archived freight are removed from list of active freights, but are still avail\u00adable using get freight by id or by get\u00adting the list of archived freights.<\/p>\n\n\n\n<p>How to get archived freights list is described <a href=\"https:\/\/www.trans.eu\/api\/freights\/get-archived-freights-list\/\">here<\/a>.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Receive transport order<\/h2>\n\n\n\n<p>Accept\u00aded freight cre\u00adates trans\u00adport order, which con\u00adsists of:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>freight details (freight id, loca\u00adtions, loads, require\u00adments, etc)<\/li>\n\n\n\n<li>car\u00adri\u00ader details (address and vat num\u00adber)<\/li>\n\n\n\n<li>freight for\u00adwarder details (address and vat num\u00adber)<\/li>\n\n\n\n<li>dri\u00adver details<\/li>\n\n\n\n<li>vehi\u00adcle details<\/li>\n<\/ul>\n\n\n\n<p>Details about receiv\u00ading list of trans\u00adport orders can be found <a href=\"https:\/\/www.trans.eu\/api\/orders\/list-of-created-orders\/\">here<\/a>.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Get monitoring task<\/h2>\n\n\n\n<p>Accept\u00aded freight, depend\u00ading on prop\u00ader\u00adties, might also imme\u00addi\u00adate\u00adly cre\u00adate new mon\u00adi\u00adtor\u00ading task.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>loca\u00adtions<\/li>\n\n\n\n<li>vehi\u00adcle id<\/li>\n\n\n\n<li>coor\u00addi\u00adnates<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p class=\"dont-break-out\">A step-by-step guide and best prac\u00adtices for inte\u00adgrat\u00ading a ship\u00adper solu\u00adtion.<\/p>\n","protected":false},"author":4,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"wp_typography_post_enhancements_disabled":false,"footnotes":""},"categories":[58,56],"tags":[],"class_list":["post-1824","post","type-post","status-publish","format-standard","hentry","category-integration-scenarios","category-use-cases"],"acf":[],"aioseo_notices":[],"lang":"en","translations":{"en":1824},"pll_sync_post":[],"_links":{"self":[{"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/1824","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/comments?post=1824"}],"version-history":[{"count":1,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/1824\/revisions"}],"predecessor-version":[{"id":5542,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/1824\/revisions\/5542"}],"wp:attachment":[{"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/media?parent=1824"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/categories?post=1824"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/tags?post=1824"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}