{"id":1834,"date":"2020-05-25T11:32:31","date_gmt":"2020-05-25T09:32:31","guid":{"rendered":"https:\/\/www.trans.eu\/api\/?p=1834"},"modified":"2026-01-08T14:37:11","modified_gmt":"2026-01-08T13:37:11","slug":"send-transport-order-to-carrier","status":"publish","type":"post","link":"https:\/\/www.trans.eu\/api\/use-cases\/send-transport-order-to-carrier\/","title":{"rendered":"Send transport order to carrier"},"content":{"rendered":"\n<p>Descrip\u00adtion of adding new trans\u00adport order to select\u00aded car\u00adri\u00ader for assign\u00adment of dri\u00adver and vehi\u00adcle.<\/p>\n\n\n\n<!--more-->\n\n\n\n<h2 class=\"wp-block-heading\">Scenario<\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li>car\u00adri\u00ader is select\u00aded and present on Trans.eu Plat\u00adform<\/li>\n\n\n\n<li>car\u00adri\u00ader\u2019s Tran\u00adsId is stored in exter\u00adnal TMS and can be sent via API<\/li>\n\n\n\n<li>con\u00addi\u00adtions of coop\u00ader\u00ada\u00adtion have been agreed upon<\/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 freight for\u00adwarder and car\u00adri\u00aders have exist\u00ading and valid Trans.eu account<\/li>\n\n\n\n<li>car\u00adri\u00ader has to assign vehi\u00adcle and dri\u00adver<\/li>\n\n\n\n<li>com\u00adplet\u00aded order with vehi\u00adcle and dri\u00adver is down\u00adloaded from Trans.eu API<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Diagram<\/strong><\/h2>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter\"><img loading=\"lazy\" decoding=\"async\" width=\"461\" height=\"261\" src=\"https:\/\/www.trans.eu\/api\/wp-content\/uploads\/Transport-order-from-shipper-perspective.png\" alt class=\"wp-image-2050\" srcset=\"https:\/\/www.trans.eu\/api\/wp-content\/uploads\/Transport-order-from-shipper-perspective.png 461w, https:\/\/www.trans.eu\/api\/wp-content\/uploads\/Transport-order-from-shipper-perspective-300x170.png 300w\" sizes=\"auto, (max-width: 461px) 100vw, 461px\"><\/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 transport order<\/h2>\n\n\n\n<p>Each trans\u00adport must con\u00adsist of:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>car\u00adri\u00ader\u2019s infor\u00adma\u00adtion<\/li>\n\n\n\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<h2 class=\"wp-block-heading\"><strong>Endpoint:<\/strong><\/h2>\n\n\n\n<div class=\"hcb_wrap\"><pre class=\"prism line-numbers lang-json\" data-lang=\"JSON\"><code>POST https:\/\/api.platform.trans.eu\/ext\/orders-api\/v1\/orders-created<\/code><\/pre><\/div>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Request example:&nbsp;<\/strong><\/h2>\n\n\n\n<p>Exam\u00adple of trans\u00adport order post\u00ading request:<\/p>\n\n\n\n<div class=\"hcb_wrap\"><pre class=\"prism line-numbers lang-json\" data-lang=\"JSON\"><code>{\n  \"freight\": {\n    \"requirements\": {\n      \"is_ftl\": true,\n      \"required_truck_bodies\": [\n        \"curtainsider\",\n        \"box\"\n      ],\n      \"vehicle_size_id\": \"bus\"\n    },\n    \"carrier\": {\n      \"company_id\": 111111\n    },\n    \"capacity\": 20,\n    \"loads\": [],\n    \"spots\": [\n      {\n        \"name\": null,\n        \"spot_order\": 1,\n        \"place\": {\n          \"address\": {\n            \"locality\": \"Krak\u00f3w\",\n            \"postal_code\": \"31-001\",\n            \"country\": \"PL\"\n          }\n        },\n        \"operations\": [\n          {\n            \"operation_order\": 1,\n            \"loads\": [],\n            \"type\": \"loading\",\n            \"timespans\": {\n              \"begin\": \"2021-08-22T11:00:00+0200\",\n              \"end\": \"2021-08-22T12:00:00+0200\"\n            }\n          }\n        ]\n      },\n      {\n        \"spot_order\": 2,\n        \"place\": {\n          \"address\": {\n            \"locality\": \"D\u0105browa \u015arodkowa\",\n            \"postal_code\": \"59-330\",\n            \"country\": \"PL\"\n          }\n        },\n        \"operations\": [\n          {\n            \"type\": \"unloading\",\n            \"loads\": [],\n            \"operation_order\": 1,\n            \"timespans\": {\n              \"begin\": \"2021-08-23T11:00:00+0200\",\n              \"end\": \"2021-08-23T11:00:00+0200\"\n            }\n          }\n        ]\n      }\n    ]\n  },\n  \"payment\": {\n    \"days\": 30,\n    \"price\": {\n      \"type\": \"km\",\n      \"value\": 1500,\n      \"currency\": \"pln\"\n    }\n  },\n  \"monitoring\": {\n    \"required\": true\n  }\n}<\/code><\/pre><\/div>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Response:<\/strong><\/h2>\n\n\n\n<p>Con\u00adfir\u00adma\u00adtion of cre\u00adat\u00ading new trans\u00adport order<\/p>\n\n\n\n<div class=\"hcb_wrap\"><pre class=\"prism line-numbers lang-json\" data-lang=\"JSON\"><code>{\n  \"additional_terms\": null,\n  \"created_at\": \"2021-08-03T10:46:47.095Z\",\n  \"freight\": {\n    \"carrier\": {\n      \"assignee\": null,\n      \"legal_name\": \"Firma Testowa Przewo\u017anik\",\n      \"vat_id\": \"1111111111\"\n    },\n    \"id\": \"\",\n    \"reference_number\": null,\n    \"requirements\": {\n      \"is_ftl\": true,\n      \"other_requirements\": [],\n      \"required_adr_classes\": [],\n      \"required_truck_bodies\": [\n        \"curtainsider\",\n        \"box\"\n      ],\n      \"required_ways_of_loading\": [],\n      \"shipping_remarks\": null,\n      \"temperature\": null,\n      \"vehicle_size_id\": \"bus\"\n    },\n    \"shipper\": {\n      \"assignee\": {\n        \"account_id\": 749989,\n        \"email\": \"api@trans.eu\",\n        \"family_name\": \"Kowalski\",\n        \"fax\": null,\n        \"given_name\": \"Adam\",\n        \"telephone\": \"0048 1111111\",\n        \"trans_id\": \"2222222-1\"\n      },\n      \"legal_name\": \"Firma Testowa Spedycja\",\n      \"vat_id\": \"222222222\"\n    },\n    \"spots\": [\n      {\n        \"description\": null,\n        \"name\": null,\n        \"operations\": [\n          {\n            \"loads\": [],\n            \"operation_order\": 1,\n            \"time_window\": null,\n            \"time_window_reason\": null,\n            \"timespans\": {\n              \"begin\": \"2021-08-22T09:00:00.000Z\",\n              \"end\": \"2021-08-22T10:00:00.000Z\"\n            },\n            \"type\": \"loading\"\n          }\n        ],\n        \"place\": {\n          \"address\": {\n            \"country\": \"pl\",\n            \"description\": null,\n            \"locality\": \"Krak\u00f3w\",\n            \"number\": null,\n            \"postal_code\": \"31-001\",\n            \"street\": null\n          },\n          \"coordinates\": null\n        },\n        \"spot_order\": 1\n      },\n      {\n        \"description\": null,\n        \"name\": null,\n        \"operations\": [\n          {\n            \"loads\": [],\n            \"operation_order\": 1,\n            \"time_window\": null,\n            \"time_window_reason\": null,\n            \"timespans\": {\n              \"begin\": \"2021-08-23T09:00:00.000Z\",\n              \"end\": \"2021-08-23T09:00:00.000Z\"\n            },\n            \"type\": \"unloading\"\n          }\n        ],\n        \"place\": {\n          \"address\": {\n            \"country\": \"pl\",\n            \"description\": null,\n            \"locality\": \"D\u0105browa \u015arodkowa\",\n            \"number\": null,\n            \"postal_code\": \"59-330\",\n            \"street\": null\n          },\n          \"coordinates\": null\n        },\n        \"spot_order\": 2\n      }\n    ]\n  },\n  \"id\": \"a988c5a6-6111-49e8-ae5b-225727bdbfbb\",\n  \"invoice\": null,\n  \"monitoring\": {\n    \"required\": true\n  },\n  \"number\": \"2021\/08\/03\/2\",\n  \"payment\": {\n    \"days\": 30,\n    \"price\": {\n      \"currency\": \"pln\",\n      \"type\": \"km\",\n      \"value\": 1500\n    }\n  },\n  \"related\": [],\n  \"status\": {\n    \"value\": \"proposal-waiting\"\n  }\n}<\/code><\/pre><\/div>\n\n\n\n<p><strong>Receiv\u00ading updat\u00aded trans\u00adport order:<\/strong><\/p>\n\n\n\n<div class=\"hcb_wrap\"><pre class=\"prism line-numbers lang-json\" data-lang=\"JSON\"><code>GET https:\/\/api.platform.trans.eu\/ext\/orders-api\/orders-created\/a988c5a6-6111-49e8-ae5b-225727bdbfbb<\/code><\/pre><\/div>\n\n\n\n<p>Response exam\u00adple:<\/p>\n\n\n\n<div class=\"hcb_wrap\"><pre class=\"prism line-numbers lang-json\" data-lang=\"JSON\"><code>{\n  \"additional_terms\": null,\n  \"archived_at\": null,\n  \"attachments\": [],\n  \"can_archive\": false,\n  \"cancellation\": null,\n  \"cooperation\": {\n    \"status\": \"ACTIVE\"\n  },\n  \"created_at\": \"2021-07-01T08:54:07.008Z\",\n  \"driver\": {\n    \"account_id\": 771476,\n    \"contact_phone\": {\n      \"number\": \"11111111111\",\n      \"prefix\": \"0048\"\n    },\n    \"email\": \"trans@trans.eu\",\n    \"employee_id\": 999446,\n    \"family_name\": \"Driver\",\n    \"full_name\": \"Jan Driver\",\n    \"given_name\": \"Jan\",\n    \"identity_document_number\": null,\n    \"phone\": null\n  },\n  \"freight\": {\n    \"carrier\": {\n      \"assignee\": null,\n      \"legal_name\": \"Test Company\",\n      \"vat_id\": \"11111111111\"\n    },\n    \"id\": \"\",\n    \"reference_number\": null,\n    \"requirements\": {\n      \"is_ftl\": true,\n      \"other_requirements\": [\n        \"lift\",\n        \"hds\"\n      ],\n      \"required_adr_classes\": [\n        \"adr_1\"\n      ],\n      \"required_truck_bodies\": [\n        \"cooler\",\n        \"isotherm\"\n      ],\n      \"required_ways_of_loading\": [\n        \"top\"\n      ],\n      \"shipping_remarks\": \"Shipping remarks\",\n      \"temperature\": {\n        \"max\": 100,\n        \"min\": 10\n      },\n      \"vehicle_size_id\": \"bus\"\n    },\n    \"shipper\": {\n      \"assignee\": {\n        \"account_id\": 749989,\n        \"email\": \"test@trans.eu\",\n        \"family_name\": \"Kowalski\",\n        \"fax\": null,\n        \"given_name\": \"Krzysztof\",\n        \"telephone\": \"0048 111111111\",\n        \"trans_id\": \"1007374-1\"\n      },\n      \"legal_name\": \"Test spedition company\",\n      \"vat_id\": \"222222222222\"\n    },\n    \"spots\": [\n      {\n        \"description\": \"Example description\",\n        \"name\": \"Magazine 1\",\n        \"operations\": [\n          {\n            \"loads\": [],\n            \"operation_order\": 1,\n            \"time_window\": null,\n            \"time_window_reason\": null,\n            \"timespans\": {\n              \"begin\": \"2021-06-22T09:00:00.000Z\",\n              \"end\": \"2021-06-22T10:00:00.000Z\"\n            },\n            \"type\": \"loading\"\n          }\n        ],\n        \"place\": {\n          \"address\": {\n            \"country\": \"pl\",\n            \"description\": null,\n            \"locality\": \"Krak\u00f3w\",\n            \"number\": \"5\",\n            \"postal_code\": \"31-001\",\n            \"street\": \"Wawel\"\n          },\n          \"coordinates\": {\n            \"latitude\": 50.06143,\n            \"longitude\": 19.93658\n          }\n        },\n        \"spot_order\": 1\n      },\n      {\n        \"description\": null,\n        \"name\": null,\n        \"operations\": [\n          {\n            \"loads\": [],\n            \"operation_order\": 1,\n            \"time_window\": null,\n            \"time_window_reason\": null,\n            \"timespans\": {\n              \"begin\": \"2021-06-23T09:00:00.000Z\",\n              \"end\": \"2021-06-23T09:00:00.000Z\"\n            },\n            \"type\": \"unloading\"\n          }\n        ],\n        \"place\": {\n          \"address\": {\n            \"country\": \"pl\",\n            \"description\": null,\n            \"locality\": \"D\u0105browa \u015arodkowa\",\n            \"number\": \"34\",\n            \"postal_code\": \"59-330\",\n            \"street\": \"\u015arednia\"\n          },\n          \"coordinates\": {\n            \"latitude\": 51.41828,\n            \"longitude\": 16.33485\n          }\n        },\n        \"spot_order\": 2\n      }\n    ]\n  },\n  \"id\": \"da012de9-faca-4b14-b380-9b94aadff6fa\",\n  \"invoice\": null,\n  \"is_archived_permanently\": false,\n  \"legacy_freight_id\": null,\n  \"monitoring\": {\n    \"providers\": [\n      \"trans_task\",\n      \"external_telematics\"\n    ],\n    \"required\": true\n  },\n  \"number\": \"2021\/07\/01\/1\",\n  \"payment\": {\n    \"days\": 30,\n    \"price\": {\n      \"currency\": \"pln\",\n      \"type\": \"km\",\n      \"value\": 1500\n    }\n  },\n  \"related\": [],\n  \"source\": {\n    \"author_account_id\": 749989,\n    \"source_date\": \"2021-07-01T08:54:07.008Z\",\n    \"source_id\": null,\n    \"type\": \"api\"\n  },\n  \"status\": {\n    \"comment\": null,\n    \"value\": \"waiting-for-confirmation\"\n  },\n  \"vehicle\": {\n    \"semi_trailer\": {\n      \"dispatcher_id\": 54083,\n      \"id\": 501737,\n      \"kind\": \"4_semi_trailer\",\n      \"registration_plate_number\": \"PL1111111\",\n      \"type\": \"5_tent\"\n    },\n    \"truck\": {\n      \"dispatcher_id\": 41483,\n      \"id\": 236503,\n      \"kind\": \"5_truck\",\n      \"registration_plate_number\": \"DW1111111\",\n      \"revision\": 1,\n      \"type\": null\n    }\n  }\n}<\/code><\/pre><\/div>\n","protected":false},"excerpt":{"rendered":"<p class=\"dont-break-out\">Descrip\u00adtion of adding new trans\u00adport order to select\u00aded car\u00adri\u00ader for assign\u00adment of dri\u00adver and vehi\u00adcle.<\/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":[56],"tags":[],"class_list":["post-1834","post","type-post","status-publish","format-standard","hentry","category-use-cases"],"acf":[],"aioseo_notices":[],"lang":"en","translations":{"en":1834},"pll_sync_post":[],"_links":{"self":[{"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/1834","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=1834"}],"version-history":[{"count":1,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/1834\/revisions"}],"predecessor-version":[{"id":5538,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/1834\/revisions\/5538"}],"wp:attachment":[{"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/media?parent=1834"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/categories?post=1834"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/tags?post=1834"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}