{"id":5172,"date":"2025-07-11T11:18:23","date_gmt":"2025-07-11T09:18:23","guid":{"rendered":"https:\/\/www.trans.eu\/api\/?p=5172"},"modified":"2025-07-11T11:25:58","modified_gmt":"2025-07-11T09:25:58","slug":"description-of-data-flow-between-api-methods","status":"publish","type":"post","link":"https:\/\/www.trans.eu\/api\/use-cases\/description-of-data-flow-between-api-methods\/","title":{"rendered":"Description of data flow between API methods"},"content":{"rendered":"\n<h2 class=\"wp-block-heading\"><br>1. Streamlining and Visualizing the Flow of Inter-Method Dependencies <\/h2>\n\n\n\n<p>To max\u00adi\u00admize inte\u00adgra\u00adtion with the Trans.eu API and stream\u00adline the process of build\u00ading your solu\u00adtions, we present detailed descrip\u00adtions and visu\u00adal\u00adiza\u00adtions of key data flows and depen\u00adden\u00adcies between indi\u00advid\u00adual API meth\u00adods. Under\u00adstand\u00ading how object iden\u00adti\u00adfiers (IDs) and sta\u00adtus\u00ades flow through the sys\u00adtem is essen\u00adtial for effec\u00adtive freight and trans\u00adport order man\u00adage\u00adment.<\/p>\n\n\n\n<p>The pur\u00adpose of this sec\u00adtion:<br>\u2022Visu\u00adal\u00adize the full life\u00adcy\u00adcle of key objects (e.g., freight, trans\u00adport orders).<br>\u2022Explain which iden\u00adti\u00adfiers (IDs) are gen\u00ader\u00adat\u00aded by each method and which are required as input for sub\u00adse\u00adquent oper\u00ada\u00adtions.<br>\u2022Present the log\u00adi\u00adcal con\u00adnec\u00adtions between var\u00adi\u00adous API mod\u00adules (e.g., Freight, Trans\u00adport Orders, Dock Sched\u00aduler, Mon\u00adi\u00adtor\u00ading).<\/p>\n\n\n\n<p><strong>1.1. Process Flow Dia\u00adgrams<\/strong><\/p>\n\n\n\n<p>We rec\u00adom\u00admend using the fol\u00adlow\u00ading dia\u00adgrams, which illus\u00adtrate the flow of data in key busi\u00adness sce\u00adnar\u00adios. Each dia\u00adgram focus\u00ades on a spe\u00adcif\u00adic process, show\u00ading the sequence of API calls and the rela\u00adtion\u00adships between objects.<br>\u2022Freight Life\u00adcy\u00adcle Dia\u00adgram: Shows the path from freight post\u00ading to its ful\u00adfill\u00adment or archiv\u00ading.<br>\u2022Trans\u00adporta\u00adtion Order Life\u00adcy\u00adcle Dia\u00adgram: Illus\u00adtrates the process of cre\u00adat\u00ading and man\u00adag\u00ading a trans\u00adport order, includ\u00ading con\u00adnec\u00adtions to freight and mon\u00adi\u00adtor\u00ading tasks.<br>\u2022Noti\u00adfi\u00adca\u00adtion Life\u00adcy\u00adcle Dia\u00adgram (Dock Sched\u00aduler): Shows the process of cre\u00adat\u00ading and man\u00adag\u00ading noti\u00adfi\u00adca\u00adtions at the docks.<\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"588\" height=\"867\" src=\"https:\/\/www.trans.eu\/api\/wp-content\/uploads\/image-1.png\" alt class=\"wp-image-5176\" srcset=\"https:\/\/www.trans.eu\/api\/wp-content\/uploads\/image-1.png 588w, https:\/\/www.trans.eu\/api\/wp-content\/uploads\/image-1-203x300.png 203w\" sizes=\"auto, (max-width: 588px) 100vw, 588px\"><\/figure>\n\n\n\n<p><\/p>\n\n\n\n<p><strong>1.2. ID Depen\u00adden\u00adcies Matrix<\/strong><\/p>\n\n\n\n<p>The table below shows key API meth\u00adods, the iden\u00adti\u00adfiers they return, and the meth\u00adods that require these iden\u00adti\u00adfiers to func\u00adtion cor\u00adrect\u00adly. This allows you to quick\u00adly under\u00adstand the data flow.<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><tbody><tr><td>API mod\u00adule<\/td><td>Method\/Endpoint<\/td><td>Returned ID (Exam\u00adple)<\/td><td>Meth\u00adods requir\u00ading this ID<\/td><td>Com\u00adments<\/td><\/tr><tr><td>Freights<\/td><td>POST \/ex\u00adt\/freights-api\/v1\/freight-exchange<\/td><td>freight-id: 8906773<\/td><td>- GET \/ext\/freights-api\/v1\/freights\/{freight-id}<br>- GET \/ext\/freights-api\/v1\/freights\/{freightId}\/offers<br>- POST \/ext\/freights-api\/v1\/freights\/{freight-id}\/archive<br>- POST \/ext\/freights-api\/v1\/cancelPublication\/{freight-id} \u2014 PUT \/ext\/freights-api\/v1\/freights\/:freightId\/refresh_publication<br>- POST \/ext\/freights-api\/v1\/freights\/{FeightID}\/internal-note<\/td><td><br>freight-id is gen\u00ader\u00adat\u00aded after suc\u00adcess\u00adful freight post\u00ading, regard\u00adless of the post\u00ading method (e.g. freight-employ\u00adees, freight-com\u00adpa\u00adnies, freight-auto, pri\u00advate-exchange, freight-cor\u00adpo\u00adrate).<\/td><\/tr><tr><td>Freights<\/td><td>GET \/ext\/freights-api\/v1\/freights\/{freightId}\/offers<\/td><td>offer-id: 4a2dbtsd-bd6b-4c24-6t2c-256af10055911617<\/td><td>- POST \/ext\/freights-api\/v1\/freights\/offers\/{offer-id}\/accept<br>- GET \/ext\/freights-api\/v1\/freights\/offers\/{offers-id}<br>- PATCH \/ext\/freights-api\/v1\/freights\/offers\/{offer-id}\/negotiate     <br>- POST \/ext\/freights-api\/v1\/freights\/offers\/{offer-id}\/reject<\/td><td>offer-id is a unique offer iden\u00adti\u00adfi\u00ader returned by the API after receiv\u00ading offers from car\u00adri\u00aders.<\/td><\/tr><tr><td>Trans\u00adport orders<\/td><td>POST \/ex\u00adt\/orders-api\/v1\/orders-cre\u00adat\u00aded <br>POST \/ex\u00adt\/orders-api\/v1\/order\u00ads\/await\u00ading-entry-exe\u00adcu\u00adtion-data<\/td><td>order-id: da012de9-faca-4b14-b380-9b94aadf\u00adf6\u00adfa24\u2026<\/td><td>- GET \/ext\/orders-api\/v1\/orders-created\/{order-id} \u2014 POST \/ext\/orders-api\/v1\/orders-created\/{order-Id}\/arrived<br>- POST \/ext\/orders-api\/v1\/orders-created\/{orderId}\/unloaded<br>- PATCH \/ext\/orders-api\/v1\/orders-created\/{order-Id}\/confirm<br>- POST \/ext\/orders-api\/v1\/orders\/{OrderID}\/required-execution-data\/provide<br>- POST \/ext\/orders-api\/v1\/orders-created\/{order-id}\/archive<br>- PATCH \/ext\/orders-api\/v1\/orders\/{orderId}<br>- POST \/orders-api\/v1\/orders\/{orderId}\/attachments<\/td><td><br>order-id is gen\u00ader\u00adat\u00aded after cre\u00adat\u00ading a new trans\u00adport order or after accept\u00ading freight (e.g. with the send_order_proposal_automatically option). It is in UUID for\u00admat.<\/td><\/tr><tr><td>Trans\u00adports in real\u00adiza\u00adtion<\/td><td>GET \/ex\u00adt\/\u00adtrans\u00adports-api\/v1\/\u00adtrans\u00adports<\/td><td>transport_task_id: e6b7494b-4922\u20134fdb-af28-97618b8fb85739<\/td><td>- GET \/ext\/transports-api\/v1\/transports\/{transport_task_id}- GET \/ext\/transports-api\/v1\/transports\/{transport_task_id}\/monitoring<\/td><td><br>Trans\u00adports in progress are part of an accept\u00aded trans\u00adport order.<\/td><\/tr><tr><td>Dock Sched\u00aduler<\/td><td>POST \/ex\u00adt\/\u00addock-sched\u00aduler-api\/v1\/an\u00adnounce\u00adment<\/td><td>announce\u00adment-id: 3860244<\/td><td>- PUT \/ext\/dock-scheduler-api\/v1\/announcement\/{{announcementID}}\/stage <br>- PATCH \/ext\/dock-scheduler-api\/v1\/announcement\/{annoucementID}\/slot <br>- DELETE \/ext\/dock-scheduler-api\/v1\/announcement\/{announcementID}<br>- GET \/ext\/dock-scheduler-api\/v1\/announcement\/{announcementID} <br>- GET \/ext\/dock-scheduler-api\/v1\/announcement\/{announcement-id}\/history <br>- PUT \/ext\/dock-scheduler-api\/v1\/announcement\/{annoucementID}<\/td><td>announce\u00adment-id is the announce\u00adment iden\u00adti\u00adfi\u00ader in the Dock Sched\u00aduler.<\/td><\/tr><tr><td>Vehi\u00adcle Exchange<\/td><td>POST \/ex\u00adt\/ve\u00adhi\u00adcles-api\/v1\/ve\u00adhi\u00adcles<\/td><td>offerId: 01E4WTST4JK6HT6SZD8PDY7BDS<\/td><td>- DELETE \/ext\/vehicles-api\/v1\/vehicles\/:offerId <br>- GET \/ext\/vehicles-api\/v1\/vehicles\/{id} \u2014 PUT \/ext\/vehicles-api\/v1\/vehicles\/:offerId<\/td><td>The offerId for a vehi\u00adcle offer is gen\u00ader\u00adat\u00aded after it is cre\u00adat\u00aded.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><strong>1.3. How to use ID depen\u00adden\u00adcies:<\/strong><\/p>\n\n\n\n<p>1. Cre\u00adat\u00ading an object: After suc\u00adcess\u00adful\u00adly call\u00ading a method that cre\u00adates a new object (e.g. freight, trans\u00adport order, noti\u00adfi\u00adca\u00adtion), the sys\u00adtem will return the unique iden\u00adti\u00adfi\u00ader (ID) of this object in the JSON response<\/p>\n\n\n\n<p>2.Fetching and updat\u00ading: This returned ID is then used in the URLs (end\u00adpoints) of sub\u00adse\u00adquent meth\u00adods (e.g. GET, PUT, PATCH, DELETE) to ref\u00ader\u00adence the spe\u00adcif\u00adic object, retrieve its details, update its sta\u00adtus, or mod\u00adi\u00adfy its prop\u00ader\u00adties<\/p>\n\n\n\n<p>3.Status Mon\u00adi\u00adtor\u00ading: Many meth\u00adods sup\u00adport callback_url, which allows you to asyn\u00adchro\u00adnous\u00adly receive noti\u00adfi\u00adca\u00adtions of object sta\u00adtus changes, elim\u00adi\u00adnat\u00ading the need for con\u00adstant API polling.To use this fea\u00adture, you must pro\u00advide the callback_url field in the object cre\u00adation request.<\/p>\n","protected":false},"excerpt":{"rendered":"<p class=\"dont-break-out\">1. Stream\u00adlin\u00ading and Visu\u00adal\u00adiz\u00ading the Flow of Inter-Method Depen\u00adden\u00adcies To max\u00adi\u00admize inte\u00adgra\u00adtion with the Trans.eu API and stream\u00adline the process \u2026<\/p>\n","protected":false},"author":12,"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-5172","post","type-post","status-publish","format-standard","hentry","category-integration-scenarios","category-use-cases"],"acf":[],"aioseo_notices":[],"lang":"en","translations":{"en":5172},"pll_sync_post":[],"_links":{"self":[{"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/5172","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\/12"}],"replies":[{"embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/comments?post=5172"}],"version-history":[{"count":4,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/5172\/revisions"}],"predecessor-version":[{"id":5179,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/5172\/revisions\/5179"}],"wp:attachment":[{"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/media?parent=5172"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/categories?post=5172"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/tags?post=5172"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}