{"id":6535,"date":"2026-04-28T11:36:28","date_gmt":"2026-04-28T09:36:28","guid":{"rendered":"https:\/\/www.trans.eu\/api\/?p=6535"},"modified":"2026-04-30T12:39:51","modified_gmt":"2026-04-30T10:39:51","slug":"create-fixed-route","status":"publish","type":"post","link":"https:\/\/www.trans.eu\/api\/freights-section\/create-fixed-route\/","title":{"rendered":"Create a route"},"content":{"rendered":"\n<div class=\"wp-block-columns is-layout-flex wp-container-core-columns-is-layout-9d6595d7 wp-block-columns-is-layout-flex\">\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\">\n<p>Cre\u00adat\u00ading a new route.<\/p>\n\n\n\n<!--more-->\n\n\n\n<p>After suc\u00adcess\u00adful\u00adly exe\u00adcut\u00ading the method, you receive in response the route details with the unique route iden\u00adti\u00adfi\u00adca\u00adtion num\u00adber <strong>id <\/strong>assigned when cre\u00adat\u00ading the new route.<\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\">\n<pre class=\"wp-block-preformatted\"><strong>POST<\/strong><br> \/ext\/contracts-api\/v2\/routes<\/pre>\n<\/div>\n<\/div>\n\n\n\n<div style=\"height:56px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<div class=\"wp-block-columns has-background is-layout-flex wp-container-core-columns-is-layout-9d6595d7 wp-block-columns-is-layout-flex\" style=\"background-color:#eaeaea\">\n<div class=\"wp-block-column is-vertically-aligned-center is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:25%\">\n<h6 class=\"wp-block-heading has-text-align-right\" style=\"font-style:normal;font-weight:700\"> Request Authorization<\/h6>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:75%\">\n<p>Every request MUST include a valid access token obtained dur\u00ading <a href=\"https:\/\/www.trans.eu\/api\/general-information\/authorization-process\/\" target=\"_blank\" rel=\"noopener\" title>the user autho\u00adriza\u00adtion process<\/a>, pro\u00advid\u00aded using the Bear\u00ader token scheme in the Autho\u00adriza\u00adtion head\u00ader.<\/p>\n<\/div>\n<\/div>\n\n\n\n<div class=\"wp-block-columns has-background is-layout-flex wp-container-core-columns-is-layout-9d6595d7 wp-block-columns-is-layout-flex\" style=\"background-color:#eaeaea\">\n<div class=\"wp-block-column is-vertically-aligned-top is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:25%\">\n<h6 class=\"wp-block-heading has-text-align-right\" style=\"font-style:normal;font-weight:700\"> Request<\/h6>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:75%\">\n<div class=\"wp-block-columns is-layout-flex wp-container-core-columns-is-layout-9d6595d7 wp-block-columns-is-layout-flex\">\n<div class=\"wp-block-column is-vertically-aligned-center is-layout-flow wp-block-column-is-layout-flow\">\n<p><a href=\"#requestheader\" title>Request Head\u00ader<\/a><\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-vertically-aligned-center is-layout-flow wp-block-column-is-layout-flow\">\n<p><a href=\"#requeststructure\" title>Request Para\u00adme\u00adters<\/a><\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-vertically-aligned-bottom is-layout-flow wp-block-column-is-layout-flow\">\n<p><a href=\"#requestbody\" title>Request Body<\/a><\/p>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n\n\n\n<div class=\"wp-block-columns has-background is-layout-flex wp-container-core-columns-is-layout-9d6595d7 wp-block-columns-is-layout-flex\" style=\"background-color:#eaeaea\">\n<div class=\"wp-block-column is-vertically-aligned-top is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:25%\">\n<h6 class=\"wp-block-heading has-text-align-right\" style=\"font-style:normal;font-weight:700\"> Successful Response<\/h6>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-vertically-aligned-center is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:75%\">\n<div class=\"wp-block-columns is-layout-flex wp-container-core-columns-is-layout-9d6595d7 wp-block-columns-is-layout-flex\">\n<div class=\"wp-block-column is-vertically-aligned-center is-layout-flow wp-block-column-is-layout-flow\">\n<p><a href=\"#responsefields\" title>Response Fields<\/a><\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-vertically-aligned-center is-layout-flow wp-block-column-is-layout-flow\">\n<p><a href=\"#responsebody\" title=\"Response Body\">Response Body<\/a><\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\">\n<p><\/p>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n\n\n\n<div class=\"wp-block-columns has-background is-layout-flex wp-container-core-columns-is-layout-9d6595d7 wp-block-columns-is-layout-flex\" style=\"background-color:#eaeaea\">\n<div class=\"wp-block-column is-vertically-aligned-top is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:25%\">\n<h6 class=\"wp-block-heading has-text-align-right\" style=\"font-style:normal;font-weight:700\"> Error Response<\/h6>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:75%\">\n<div class=\"wp-block-columns is-layout-flex wp-container-core-columns-is-layout-9d6595d7 wp-block-columns-is-layout-flex\">\n<div class=\"wp-block-column is-vertically-aligned-center is-layout-flow wp-block-column-is-layout-flow\">\n<p><a href=\"#validationerrors\" title>Clients errors (400)<\/a><\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\">\n<p><\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-vertically-aligned-center is-layout-flow wp-block-column-is-layout-flow\">\n<p><a href=\"https:\/\/www.trans.eu\/api\/general-information\/enpoint-and-validation-errors\/\" target=\"_blank\" rel=\"noopener\" title>Gen\u00ader\u00adal API errors<\/a><\/p>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n\n\n\n<div style=\"height:56px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<div class=\"wp-block-columns is-layout-flex wp-container-core-columns-is-layout-9d6595d7 wp-block-columns-is-layout-flex\">\n<div class=\"wp-block-column is-vertically-aligned-center is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:25%\" id=\"requestbody\">\n<h6 class=\"wp-block-heading\" style=\"font-style:normal;font-weight:700\">Request Header<\/h6>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:75%\">\n<div class=\"hcb_wrap\"><pre class=\"prism line-numbers lang-plain\"><code>POST  \/ext\/contracts-api\/v2\/routes HTTP\/1.1 \nHost: api.platform.trans.eu \nContent-Type: application\/json\nAccept: application\/json\nAuthorization: Bearer {access_token) \nApi-key: {unique_app_api-key}<\/code><\/pre><\/div>\n<\/div>\n<\/div>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"requeststructure\" style=\"font-style:normal;font-weight:700\">Request Parameters<\/h6>\n\n\n\n<figure class=\"wp-block-table has-small-font-size\"><table><tbody><tr><td>Attribute<\/td><td>Type<\/td><td>Exam\u00adple<\/td><td>Manda\u00adto\u00adry<\/td><td>Descrip\u00adtion<\/td><\/tr><tr><td>dis\u00adtance<\/td><td>Object<\/td><td><\/td><td>No<\/td><td>Route dis\u00adtance<\/td><\/tr><tr><td>distance.declared<\/td><td>Object<\/td><td><\/td><td>No<\/td><td>Route dis\u00adtance declared by user dur\u00ading con\u00adfig\u00adu\u00adra\u00adtion the route<\/td><\/tr><tr><td>distance.declared.unit_code<\/td><td>String<\/td><td>\u201ckm\u201d<\/td><td>No<\/td><td>Unit code fo declared dis\u00adtance. Default is <code>km <\/code>(kilo\u00adme\u00adters)<\/td><\/tr><tr><td>distance.declared.value<\/td><td>Int<\/td><td>150<\/td><td>No<\/td><td>Val\u00adue of declared dis\u00adtance<\/td><\/tr><tr><td>is_roundtrip<\/td><td>Boolean<\/td><td>False<\/td><td>No<\/td><td>Round trip route<\/td><\/tr><tr><td>loads<\/td><td>Array of Objects<\/td><td><\/td><td>No<\/td><td>Spec\u00adi\u00adfi\u00adca\u00adtion of loads para\u00adme\u00adters required on the route<\/td><\/tr><tr><td>loads.amount<\/td><td>Int<\/td><td>1<\/td><td>No<\/td><td>Amount of load types with\u00adin giv\u00aden load<\/td><\/tr><tr><td>loads.height<\/td><td>Object<\/td><td><\/td><td>No<\/td><td>Load height<\/td><\/tr><tr><td>loads.height.unit_code<\/td><td>String<\/td><td>\u201cm\u201d<\/td><td>No<\/td><td>Unit of load height. Always is \u201cm\u201d (meters).<\/td><\/tr><tr><td>loads.height.value<\/td><td>Float<\/td><td>2.3<\/td><td>No<\/td><td>Val\u00adue of load height (range 0.01\u201310)<\/td><\/tr><tr><td>loads.length<\/td><td>Object<\/td><td><\/td><td>No<\/td><td>Load length<\/td><\/tr><tr><td>loads.length.unit_code<\/td><td>String<\/td><td>\u201cm\u201d<\/td><td>No<\/td><td>Unit of load length. Always is \u201cm\u201d (meters)<\/td><\/tr><tr><td>loads.length.value<\/td><td>Float<\/td><td>1.2<\/td><td>No<\/td><td>Val\u00adue of load length (range 0.01\u2013100)<\/td><\/tr><tr><td>loads.name<\/td><td>String<\/td><td>\u201cGlass load\u201d<\/td><td>No<\/td><td>Name of a load<\/td><\/tr><tr><td>loads.palletes<\/td><td>Object<\/td><td><\/td><td>No<\/td><td>Addi\u00adtion\u00adal rules for pal\u00adlets<\/td><\/tr><tr><td>loads.palletes.is_exchangeable<\/td><td>Boolean<\/td><td>False<\/td><td>No<\/td><td>Deter\u00admines if type of load is avail\u00adable for exchange at unload\u00ading place<\/td><\/tr><tr><td>loads.palletes.is_stackable<\/td><td>Boolean<\/td><td>False<\/td><td>No<\/td><td>Spec\u00adi\u00adfies whether the type of load allows stack\u00ading<\/td><\/tr><tr><td>loads.type_of_load<\/td><td>String<\/td><td>\u201ceuropal\u00adlete\u201d<\/td><td>No<\/td><td>Sup\u00adport\u00aded load type (<a href=\"https:\/\/www.trans.eu\/api\/general-information\/allowed-values#loadtype\" target=\"_blank\" rel=\"noreferrer noopener\">see dic\u00adtio\u00adnary<\/a>)<\/td><\/tr><tr><td>loads.volume<\/td><td>Object<\/td><td><\/td><td>No<\/td><td>Load vol\u00adume<\/td><\/tr><tr><td>loads.volume.unit_code<\/td><td>String<\/td><td>\u201cm3\u201d<\/td><td>No<\/td><td>Unit of load vol\u00adume. Always is \u201cm3\u201d<\/td><\/tr><tr><td>loads.volume.value<\/td><td>Float<\/td><td>1.92<\/td><td>No<\/td><td>Val\u00adue of load vol\u00adume (range 0.01\u201310000)<\/td><\/tr><tr><td>loads.weight<\/td><td>Object<\/td><td><\/td><td>No<\/td><td>Load weight<\/td><\/tr><tr><td>loads.weight.max<\/td><td>Object<\/td><td><\/td><td>No<\/td><td>Min load weight<\/td><\/tr><tr><td>loads.weight.max.unit_code<\/td><td>String<\/td><td>\u201ct\u201d<\/td><td>No<\/td><td>Unit of load weight. Always is \u201ct\u201d (tonnes)<\/td><\/tr><tr><td>loads.weight.max.value<\/td><td>Float<\/td><td>2<\/td><td>No<\/td><td>Val\u00adue of load weight (range 0.001 \u2013 100000)<\/td><\/tr><tr><td>loads.weight.min<\/td><td>Object<\/td><td><\/td><td>No<\/td><td>Max load weight<\/td><\/tr><tr><td>loads.weight.min.unit_code<\/td><td>String<\/td><td>\u201ct\u201d<\/td><td>No<\/td><td>Unit of load weight. Always is \u201ct\u201d (tonnes)<\/td><\/tr><tr><td>loads.weight.min.value<\/td><td>Float<\/td><td>2.4<\/td><td>No<\/td><td>Val\u00adue of load weight (range 0.001 \u2013 100000)<\/td><\/tr><tr><td>loads.width<\/td><td>Object<\/td><td><\/td><td>No<\/td><td>Load width<\/td><\/tr><tr><td>loads.width.unit_code<\/td><td>String<\/td><td>\u201cm\u201d<\/td><td>No<\/td><td>Unit of load width. Always is \u201cm\u201d (meters)<\/td><\/tr><tr><td>loads.width.value<\/td><td>Float<\/td><td>2.1<\/td><td>No<\/td><td>Val\u00adue of load width (range 0.01\u201310)<\/td><\/tr><tr><td>name<\/td><td>String<\/td><td>\u201cRoute Warsza\u00adwa-Berlin 1\u201d<\/td><td>Yes<\/td><td>Name of the route<\/td><\/tr><tr><td>publication_scenario<\/td><td>Object<\/td><td><\/td><td>No<\/td><td>Def\u00adi\u00adn\u00adi\u00adtion of pub\u00adli\u00adca\u00adtion sce\u00adnario for route<\/td><\/tr><tr><td>publication_scenario.data<\/td><td>Object<\/td><td><\/td><td>No\/Yes<\/td><td>Manda\u00adto\u00adry object for <code>in_order <\/code>sce\u00adnario type<\/td><\/tr><tr><td>publication_scenario.data.order<\/td><td>String<\/td><td>\u201cgrad\u00adu\u00adal\u00adly\u201d<\/td><td>Yes<\/td><td>Order of pub\u00adli\u00adca\u00adtion to car\u00adri\u00ader list. Avail\u00adable val\u00adues:<br><code>gradually <\/code>- after the spec\u00adi\u00adfied pub\u00adli\u00adca\u00adtion time has elapsed, grad\u00adu\u00adal\u00adly add next recip\u00adi\u00adent<br><code>next_recipient <\/code>- after the spec\u00adi\u00adfied pub\u00adli\u00adca\u00adtion time has elapsed, for\u00adward\u00ading to the next recip\u00adi\u00adent<\/td><\/tr><tr><td>publication_scenario.data.publication_time<\/td><td>Object<\/td><td><\/td><td>Yes<\/td><td>Pub\u00adli\u00adca\u00adtion peri\u00adod for one recip\u00adi\u00adent<\/td><\/tr><tr><td>publication_scenario.data.publication_time.unit_code<\/td><td>String<\/td><td>\u201cs\u201d<\/td><td>Yes<\/td><td>Unit time for time val\u00adue. Always is \u201cs\u201d (sec\u00adonds)<\/td><\/tr><tr><td>publication_scenario.data.publication_time.user_unit_code<\/td><td>String<\/td><td>\u201cmin\u201d<\/td><td>Yes<\/td><td>Unit time indi\u00adcat\u00aded by user. Avail\u00adable val\u00adues are \u201cmin\u201d (min\u00adutes) or \u201ch\u201d (hours)<\/td><\/tr><tr><td>publication_scenario.data.publication_time.value<\/td><td>Int<\/td><td>300<\/td><td>Yes<\/td><td>Peri\u00adod of pub\u00adli\u00adca\u00adtion time in sec\u00adonds. Range (300 \u2014 432000).<\/td><\/tr><tr><td>publication_scenario.type<\/td><td>String<\/td><td>\u201cin_order\u201d<\/td><td>No<\/td><td>Pub\u00adli\u00adca\u00adtion sce\u00adnario type. Avail\u00adable val\u00adues:<br><code>parallel <\/code>- pub\u00adli\u00adca\u00adtion to all in par\u00adal\u00adlel (default)<br><code>in_order <\/code>- pub\u00adli\u00adca\u00adtion in order of the car\u00adri\u00ader list<\/td><\/tr><tr><td>require\u00adments<\/td><td>Object<\/td><td><\/td><td>No<\/td><td>Vehi\u00adcle require\u00adments<\/td><\/tr><tr><td>requirements.additional_requirements<\/td><td>Array of Strings<\/td><td><\/td><td>No<\/td><td>Addi\u00adtion\u00adal vehi\u00adcle require\u00adments (<a href=\"https:\/\/www.trans.eu\/api\/general-information\/allowed-values#requirements\" target=\"_blank\" rel=\"noreferrer noopener\">see dic\u00adtio\u00adnary<\/a>)<\/td><\/tr><tr><td>requirements.capacity<\/td><td>Object<\/td><td><\/td><td>No<\/td><td>Vehi\u00adcle capac\u00adi\u00adty<\/td><\/tr><tr><td>requirements.capacity.max<\/td><td>Object<\/td><td><\/td><td>No<\/td><td>Vehi\u00adcle max capac\u00adi\u00adty<\/td><\/tr><tr><td>requirements.capacity.max.unit_code<\/td><td>String<\/td><td>\u201ct\u201d<\/td><td>No<\/td><td>Unit of max capac\u00adi\u00adty. Always is \u201ct\u201d (tonnes)<\/td><\/tr><tr><td>requirements.capacity.max.value<\/td><td>Float<\/td><td>24<\/td><td>No<\/td><td>Val\u00adue of vehi\u00adcle max capac\u00adi\u00adty<\/td><\/tr><tr><td>requirements.capacity.min<\/td><td>Object<\/td><td><\/td><td>No<\/td><td>Vehi\u00adcle min capac\u00adi\u00adty<\/td><\/tr><tr><td>requirements.capacity.min.unit_code<\/td><td>String<\/td><td>\u201ct\u201d<\/td><td>No<\/td><td>Unit of min capac\u00adi\u00adty. Always is \u201ct\u201d (tonnes)<\/td><\/tr><tr><td>requirements.capacity.min.value<\/td><td>Float<\/td><td>20<\/td><td>No<\/td><td>Val\u00adue of vehi\u00adcle min capac\u00adi\u00adty<\/td><\/tr><tr><td>requirements.exemption_from_adr<\/td><td>Boolean<\/td><td>False<\/td><td>No<\/td><td>The load can be trans\u00adport\u00aded by car\u00adri\u00ader with\u00adout ADR autho\u00adriza\u00adtion. It occurs only for&nbsp;<strong>additional_requirements&nbsp;<\/strong>=&nbsp;<code>adr<\/code>.<\/td><\/tr><tr><td>requirements.freight_type<\/td><td>String<\/td><td>\u201cFTL\u201d<\/td><td>No<\/td><td>Type of freight. Avail\u00adable val\u00adues: <code>FTL<\/code>, <code>LTL<\/code>, <code>MULTI_FTL<\/code>, <code>null<\/code><\/td><\/tr><tr><td>requirements.height<\/td><td>Object<\/td><td><\/td><td>No<\/td><td>Vehi\u00adcle height<\/td><\/tr><tr><td>requirements.height.unit_code<\/td><td>String<\/td><td>\u201cm\u201d<\/td><td>No<\/td><td>Unit of vehi\u00adcle height. Always is \u201cm\u201d (meters)<\/td><\/tr><tr><td>requirements.height.value<\/td><td>Float<\/td><td>2.1<\/td><td>No<\/td><td>Val\u00adue of vehi\u00adcle height<\/td><\/tr><tr><td>requirements.length<\/td><td>Object<\/td><td><\/td><td>No<\/td><td>Vehi\u00adcle length<\/td><\/tr><tr><td>requirements.length.unit_code<\/td><td>String<\/td><td>\u201cm\u201d<\/td><td>No<\/td><td>Unit of vehi\u00adcle length. Always is \u201cm\u201d (meters)<\/td><\/tr><tr><td>requirements.length.value<\/td><td>Float<\/td><td>3.4<\/td><td>No<\/td><td>Val\u00adue of vehi\u00adcle length<\/td><\/tr><tr><td>requirements.required_adr_classes<\/td><td>Array of Strings<\/td><td><\/td><td>No<\/td><td>ADR freight class\u00ades (<a href=\"https:\/\/www.trans.eu\/api\/general-information\/allowed-values#adrclass\" target=\"_blank\" rel=\"noreferrer noopener\">see dic\u00adtio\u00adnary<\/a>)<\/td><\/tr><tr><td>requirements.required_truck_bodies<\/td><td>Array of Strings<\/td><td><\/td><td>No<\/td><td>Expect\u00aded vehi\u00adcle body types matched to select\u00aded vehicle_size (<a href=\"https:\/\/www.trans.eu\/api\/general-information\/allowed-values#vehicletype\" target=\"_blank\" rel=\"noreferrer noopener\">see dic\u00adtio\u00adnary<\/a>). Array can con\u00adtains max 5 val\u00adues.<\/td><\/tr><tr><td>requirements.required_ways_of_loading<\/td><td>Array of Strings<\/td><td><\/td><td>No<\/td><td>The way of loading\/unloading vehi\u00adcle. Accept\u00adable val\u00adues:&nbsp;<code>back<\/code>,&nbsp;<code>side<\/code>,&nbsp;<code>top<\/code>.<\/td><\/tr><tr><td>requirements.shipping_remarks<\/td><td>String<\/td><td>\u201cdescrip\u00adtion\u201d<\/td><td>No<\/td><td>Addi\u00adtion\u00adal ship\u00adping remarks<\/td><\/tr><tr><td>requirements.vehicle_size<\/td><td>String<\/td><td>\u201cany_size\u201d<\/td><td>No<\/td><td>Expect\u00aded vehi\u00adcle size (<a href=\"https:\/\/www.trans.eu\/api\/general-information\/allowed-values#vehiclesize\" target=\"_blank\" rel=\"noreferrer noopener\">see dic\u00adtio\u00adnary<\/a>). Default val\u00adue is&nbsp;<code>any_size<\/code>. If you select&nbsp;<code>any_size&nbsp;<\/code>all 4 basic types of vehi\u00adcle size are auto\u00admat\u00adi\u00adcal\u00adly select\u00aded.<\/td><\/tr><tr><td>requirements.volume<\/td><td>Object<\/td><td><\/td><td>No<\/td><td>Vehi\u00adcle vol\u00adume<\/td><\/tr><tr><td>requirements.volume.unit_code<\/td><td>String<\/td><td>\u201cm3\u201d<\/td><td>No<\/td><td>Unit of vehi\u00adcle vol\u00adume. Always is \u201cm3\u201d (cubic meters)<\/td><\/tr><tr><td>requirements.volume.value<\/td><td>Float<\/td><td>12.1<\/td><td>No<\/td><td>Val\u00adue of vehi\u00adcle vol\u00adume<\/td><\/tr><tr><td>requirements.width<\/td><td>Object<\/td><td><\/td><td>No<\/td><td>Vehi\u00adcle width<\/td><\/tr><tr><td>requirements.width.unit_code<\/td><td>String<\/td><td>\u201cm\u201d<\/td><td>No<\/td><td>Unit of vehi\u00adcle width. Always is \u201cm\u201d (meters)<\/td><\/tr><tr><td>requirements.width.value<\/td><td>Float<\/td><td>2.3<\/td><td>No<\/td><td>Val\u00adue of vehi\u00adcle width<\/td><\/tr><tr><td>spots<\/td><td>Array of Objects<\/td><td><\/td><td>Yes<\/td><td>Col\u00adlec\u00adtion of routes\u2019 spots. One load\u00ading and one unload\u00ading will occur.<\/td><\/tr><tr><td>spots.id<\/td><td>String<\/td><td>\u201c21b4c767-8119\u20134938-8957-aeef320c4b2e\u201d<\/td><td>No<\/td><td>Spot id<\/td><\/tr><tr><td>spots.name<\/td><td>String<\/td><td>\u201cWroc\u0142aw home point\u201d<\/td><td>No<\/td><td>Name of spot<\/td><\/tr><tr><td>spots.place<\/td><td>Object<\/td><td><\/td><td>Yes<\/td><td>Infor\u00adma\u00adtion relat\u00aded to sin\u00adgle place on route<\/td><\/tr><tr><td>spots.place.address<\/td><td>Object<\/td><td><\/td><td>Yes<\/td><td>Address of the select\u00aded point<\/td><\/tr><tr><td>spots.place.address.country<\/td><td>String<\/td><td>\u201cpl\u201d<\/td><td>Yes<\/td><td>Coun\u00adtry using ISO val\u00adues (<a href=\"https:\/\/www.trans.eu\/api\/general-information\/allowed-values#country\" target=\"_blank\" rel=\"noreferrer noopener\">see dic\u00adtio\u00adnary<\/a>)<\/td><\/tr><tr><td>spots.place.address.detailed_location_id<\/td><td>Int<\/td><td>123456<\/td><td>No<\/td><td>Detailed loca\u00adtion id<\/td><\/tr><tr><td>spots.place.address.foreign_id<\/td><td>Int<\/td><td>null<\/td><td>No<\/td><td>For\u00adeign address id<\/td><\/tr><tr><td>spots.place.address.locality<\/td><td>String<\/td><td>Wroc\u0142aw<\/td><td>No<\/td><td>City name<\/td><\/tr><tr><td>spots.place.address.location_id<\/td><td>Int<\/td><td>234567<\/td><td>No<\/td><td>Loca\u00adtion id<\/td><\/tr><tr><td>spots.place.address.number<\/td><td>String<\/td><td>\u201c2\u20134\u201d<\/td><td>No<\/td><td>Prop\u00ader\u00adty num\u00adber<\/td><\/tr><tr><td>spots.place.address.postal_code<\/td><td>String<\/td><td>\u201c51\u2013546\u201d<\/td><td>No<\/td><td>Postal code<\/td><\/tr><tr><td>spots.place.address.radius<\/td><td>Float<\/td><td>null<\/td><td>No<\/td><td>Radius<\/td><\/tr><tr><td>spots.place.address.street<\/td><td>String<\/td><td>\u201cRac\u0142aw\u00adic\u00adka\u201d<\/td><td>No<\/td><td>Street name<\/td><\/tr><tr><td>spots.place.coordinates<\/td><td>Object<\/td><td><\/td><td>No<\/td><td>Lon\u00adgi\u00adtude and lat\u00adi\u00adtude for select\u00aded point<\/td><\/tr><tr><td>spots.place.coordinates.latitude<\/td><td>Float<\/td><td>53.35801<\/td><td>No<\/td><td>Lat\u00adi\u00adtude of the point along the route<\/td><\/tr><tr><td>spots.place.coordinates.longitude<\/td><td>Float<\/td><td>-2.16539<\/td><td>No<\/td><td>Lon\u00adgi\u00adtude of the point along the route<\/td><\/tr><tr><td>spots.type<\/td><td>String<\/td><td>\u201cload\u00ading\u201d<\/td><td>Yes<\/td><td>Avail\u00adable val\u00adues: <code>loading<\/code>, <code>unloading<\/code><\/td><\/tr><tr><td>unique_key<\/td><td>String<\/td><td>\u201cRoute-PL-DE\u20111\u201d<\/td><td>No<\/td><td>Route unique name<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<div class=\"wp-block-columns is-layout-flex wp-container-core-columns-is-layout-9d6595d7 wp-block-columns-is-layout-flex\">\n<div class=\"wp-block-column is-vertically-aligned-center is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:25%\" id=\"requestbody\">\n<h6 class=\"wp-block-heading\" style=\"font-style:normal;font-weight:700\">Example Request Body<\/h6>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:75%\">\n<div class=\"hcb_wrap\"><pre class=\"prism line-numbers lang-json\" data-lang=\"JSON\"><code>{\n  \"unique_key\": \"route-123C\",\n  \"name\": \"PL - FR route\",\n  \"is_roundtrip\": false,\n  \"distance\": {\n    \"declared\": {\n      \"value\": 1200,\n      \"unit_code\": \"km\"\n    }\n  },\n \"publication_scenario\": {\n   \"type\": \"in_order\",\n   \"data\": {\n     \"publication_time\": {\n       \"value\": 11000,\n       \"unit_code\": \"s\",\n       \"user_unit_code\": \"min\"\n     },\n     \"order\": \"next_recipient\"\n   }\n },\n  \"requirements\": {\n        \"capacity\": {\n            \"min\": {\n                \"value\": 12,\n                \"unit_code\": \"t\"\n            },\n            \"max\": {\n                \"value\": 23,\n                \"unit_code\": \"t\"\n            }\n        },\n        \"required_truck_bodies\": [\n            \"cooler\",\n            \"curtainsider\"\n        ],\n        \"required_ways_of_loading\": [\n            \"Side\",\n            \"Back\"\n        ],\n        \"vehicle_size\": \"bus\",\n        \"freight_type\": \"FTL\"\n  },\n\"spots\": [\n    {\n      \"type\": \"loading\",\n      \"place\": {\n          \"address\": {\n               \"locality\": \"Suwa\u0142ki\",\n               \"postal_code\": \"52-234\",\n               \"country\": \"pl\"\n          }\n      }\n    },\n    {\n      \"type\": \"unloading\",\n      \"place\": {\n          \"address\": {\n               \"locality\": \"MARSYLIA\",\n               \"postal_code\": \"13014\",\n               \"country\": \"fr\",\n               \"street\": \"Boulevard Danielle Casanova\",\n               \"number\": \"151\",\n               \"location_id\": 1436808\n          },\n          \"coordinates\": {\n                \"latitude\": 43.323447,\n                \"longitude\": 5.3740827\n          }\n      }\n    }\n]\n}<\/code><\/pre><\/div>\n<\/div>\n<\/div>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"responsefields\" style=\"font-style:normal;font-weight:700\">Response Fields<\/h6>\n\n\n\n<figure class=\"wp-block-table has-small-font-size\"><table><tbody><tr><td>Attribute<\/td><td>Type<\/td><td>Exam\u00adple<\/td><td>Descrip\u00adtion<\/td><\/tr><tr><td>bal\u00adanc\u00ading<\/td><td>Object<\/td><td><\/td><td>Rules of choice next recip\u00adi\u00adents for pub\u00adli\u00adca\u00adtion<\/td><\/tr><tr><td>balancing.allowed_types<\/td><td>Array of Strings<\/td><td><\/td><td>Avail\u00adable types of bal\u00adanc\u00ading: <code>contract_condition<\/code>, <code>freight_limit<\/code>, <code>manual<\/code>, <code>percentage_share<\/code>, <code>price_ascending<\/code><\/td><\/tr><tr><td>balancing.data<\/td><td>Object<\/td><td><\/td><td>Addi\u00adtion\u00adal infor\u00adma\u00adtion about bal\u00adanc\u00ading<\/td><\/tr><tr><td>balancing.data.freight_limit<\/td><td>Object<\/td><td><\/td><td>Con\u00adfig\u00adu\u00adra\u00adtion of trans\u00adport lim\u00adits for <code>freight_limit <\/code>type of bal\u00adanc\u00ading. <br>When pub\u00adlish\u00ading a freight, the order of car\u00adri\u00aders will be auto\u00admat\u00adi\u00adcal\u00adly deter\u00admined so that no car\u00adri\u00ader receives more or less orders than the lim\u00adit.<\/td><\/tr><tr><td>balancing.data.freight_limit.max<\/td><td>Int<\/td><td>10<\/td><td>Max lim\u00adit in %<\/td><\/tr><tr><td>balancing.data.freight_limit.min<\/td><td>Int<\/td><td>60<\/td><td>Min lim\u00adit in %<\/td><\/tr><tr><td>balancing.type<\/td><td>String<\/td><td>\u201cman\u00adu\u00adal\u201d<\/td><td>Bal\u00adanc\u00ading type select\u00aded for route<\/td><\/tr><tr><td>dis\u00adtance<\/td><td>Object<\/td><td><\/td><td>Route dis\u00adtance<\/td><\/tr><tr><td>distance.declared<\/td><td>Object<\/td><td><\/td><td>Route dis\u00adtance declared by user dur\u00ading con\u00adfig\u00adu\u00adra\u00adtion of the route<\/td><\/tr><tr><td>distance.declared.unit_code<\/td><td>String<\/td><td>\u201ckm\u201d<\/td><td>Unit code fo declared dis\u00adtance. Default is <code>km <\/code>(kilo\u00adme\u00adters)<\/td><\/tr><tr><td>distance.declared.value<\/td><td>Int<\/td><td>150<\/td><td>Val\u00adue of declared dis\u00adtance<\/td><\/tr><tr><td>distance.calculated<\/td><td>Object<\/td><td><\/td><td>Route dis\u00adtance auto\u00admat\u00adi\u00adcal\u00adly cal\u00adcu\u00adlat\u00aded dur\u00ading con\u00adfig\u00adu\u00adra\u00adtion of the route. Always is <code>null <\/code>in the request.<\/td><\/tr><tr><td>distance.calculated.unit_code<\/td><td>String<\/td><td>\u201ckm\u201d<\/td><td>Unit code fo cal\u00adcu\u00adlat\u00aded dis\u00adtance. Default is <code>km <\/code>(kilo\u00adme\u00adters)<\/td><\/tr><tr><td>distance.calculated.value<\/td><td>Int<\/td><td>161<\/td><td>Val\u00adue of cal\u00adcu\u00adlat\u00aded dis\u00adtance<\/td><\/tr><tr><td>distance_match<\/td><td>Object<\/td><td><\/td><td>Kilo\u00adme\u00adter range for route match\u00ading. Always is  <code>null <\/code>in the request.<\/td><\/tr><tr><td>distance_match.max<\/td><td>Object<\/td><td><\/td><td>Max range<\/td><\/tr><tr><td>distance_match.max.unit_code<\/td><td>String<\/td><td>\u201ckm\u201d<\/td><td>Unit code for max range. Default is km.<\/td><\/tr><tr><td>distance_match.max.value<\/td><td>Int<\/td><td>140<\/td><td>Val\u00adue of max range.<\/td><\/tr><tr><td>distance_match.min<\/td><td>Object<\/td><td><\/td><td>Min range<\/td><\/tr><tr><td>distance_match.min.unit_code<\/td><td>String<\/td><td>\u201ckm\u201d<\/td><td>Unit code for min range. Default is km.<\/td><\/tr><tr><td>distance_match.min.value<\/td><td>Int<\/td><td>170<\/td><td>Val\u00adue of min range.<\/td><\/tr><tr><td>id<\/td><td>String<\/td><td>\u201cb998d30b-502d-4a50-a423-aca69aa7a756\u201d<\/td><td>Route id<\/td><\/tr><tr><td>is_roundtrip<\/td><td>Boolean<\/td><td>False<\/td><td>Round trip route<\/td><\/tr><tr><td>loads<\/td><td>Array of Objects<\/td><td><\/td><td>Spec\u00adi\u00adfi\u00adca\u00adtion of loads para\u00adme\u00adters required on the route<\/td><\/tr><tr><td>loads.amount<\/td><td>Int<\/td><td>1<\/td><td>Amount of load types with\u00adin giv\u00aden load<\/td><\/tr><tr><td>loads.height<\/td><td>Object<\/td><td><\/td><td>Load height<\/td><\/tr><tr><td>loads.height.unit_code<\/td><td>String<\/td><td>\u201cm\u201d<\/td><td>Unit of load height. Always is \u201cm\u201d (meters).<\/td><\/tr><tr><td>loads.height.value<\/td><td>Float<\/td><td>2.3<\/td><td>Val\u00adue of load height (range 0.01\u201310)<\/td><\/tr><tr><td>loads.length<\/td><td>Object<\/td><td><\/td><td>Load length<\/td><\/tr><tr><td>loads.length.unit_code<\/td><td>String<\/td><td>\u201cm\u201d<\/td><td>Unit of load length. Always is \u201cm\u201d (meters)<\/td><\/tr><tr><td>loads.length.value<\/td><td>Float<\/td><td>1.2<\/td><td>Val\u00adue of load length (range 0.01\u2013100)<\/td><\/tr><tr><td>loads.name<\/td><td>String<\/td><td>\u201cGlass load\u201d<\/td><td>Name of a load<\/td><\/tr><tr><td>loads.palletes<\/td><td>Object<\/td><td><\/td><td>Addi\u00adtion\u00adal rules for pal\u00adlets<\/td><\/tr><tr><td>loads.palletes.is_exchangeable<\/td><td>Boolean<\/td><td>False<\/td><td>Deter\u00admines if type of load is avail\u00adable for exchange at unload\u00ading place<\/td><\/tr><tr><td>loads.palletes.is_stackable<\/td><td>Boolean<\/td><td>False<\/td><td>Spec\u00adi\u00adfies whether the type of load allows stack\u00ading<\/td><\/tr><tr><td>loads.type_of_load<\/td><td>String<\/td><td>\u201ceuropal\u00adlete\u201d<\/td><td>Sup\u00adport\u00aded load type (<a href=\"https:\/\/www.trans.eu\/api\/general-information\/allowed-values#loadtype\" target=\"_blank\" rel=\"noreferrer noopener\">see dic\u00adtio\u00adnary<\/a>)<\/td><\/tr><tr><td>loads.volume<\/td><td>Object<\/td><td><\/td><td>Load vol\u00adume<\/td><\/tr><tr><td>loads.volume.unit_code<\/td><td>String<\/td><td>\u201cm3\u201d<\/td><td>Unit of load vol\u00adume. Always is \u201cm3\u201d<\/td><\/tr><tr><td>loads.volume.value<\/td><td>Float<\/td><td>1.92<\/td><td>Val\u00adue of load vol\u00adume (range 0.01\u201310000)<\/td><\/tr><tr><td>loads.weight<\/td><td>Object<\/td><td><\/td><td>Load weight<\/td><\/tr><tr><td>loads.weight.max<\/td><td>Object<\/td><td><\/td><td>Min load weight<\/td><\/tr><tr><td>loads.weight.max.unit_code<\/td><td>String<\/td><td>\u201ct\u201d<\/td><td>Unit of load weight. Always is \u201ct\u201d (tonnes)<\/td><\/tr><tr><td>loads.weight.max.value<\/td><td>Float<\/td><td>2<\/td><td>Val\u00adue of load weight (range 0.001 \u2013 100000)<\/td><\/tr><tr><td>loads.weight.min<\/td><td>Object<\/td><td><\/td><td>Max load weight<\/td><\/tr><tr><td>loads.weight.min.unit_code<\/td><td>String<\/td><td>\u201ct\u201d<\/td><td>Unit of load weight. Always is \u201ct\u201d (tonnes)<\/td><\/tr><tr><td>loads.weight.min.value<\/td><td>Float<\/td><td>2.4<\/td><td>Val\u00adue of load weight (range 0.001 \u2013 100000)<\/td><\/tr><tr><td>loads.width<\/td><td>Object<\/td><td><\/td><td>Load width<\/td><\/tr><tr><td>loads.width.unit_code<\/td><td>String<\/td><td>\u201cm\u201d<\/td><td>Unit of load width. Always is \u201cm\u201d (meters)<\/td><\/tr><tr><td>loads.width.value<\/td><td>Float<\/td><td>2.1<\/td><td>Val\u00adue of load width (range 0.01\u201310)<\/td><\/tr><tr><td>name<\/td><td>String<\/td><td>\u201cRoute Warsza\u00adwa-Berlin 1\u201d<\/td><td>Route name<\/td><\/tr><tr><td>posi\u00adtion<\/td><td>Int<\/td><td>1<\/td><td>Route posi\u00adtion in the list of routes<\/td><\/tr><tr><td>publication_scenario<\/td><td>Object<\/td><td><\/td><td>Def\u00adi\u00adn\u00adi\u00adtion of pub\u00adli\u00adca\u00adtion sce\u00adnario for route<\/td><\/tr><tr><td>publication_scenario.data<\/td><td>Object<\/td><td><\/td><td>Object avail\u00adable only for <code>in_order <\/code>sce\u00adnario type<\/td><\/tr><tr><td>publication_scenario.data.order<\/td><td>String<\/td><td>\u201cgrad\u00adu\u00adal\u00adly\u201d<\/td><td>Order of pub\u00adli\u00adca\u00adtion to car\u00adri\u00ader list. Avail\u00adable val\u00adues:<br><code>gradually <\/code>- after the spec\u00adi\u00adfied pub\u00adli\u00adca\u00adtion time has elapsed, grad\u00adu\u00adal\u00adly add next recip\u00adi\u00adent<br><code>next_recipient <\/code>- after the spec\u00adi\u00adfied pub\u00adli\u00adca\u00adtion time has elapsed, for\u00adward\u00ading to the next recip\u00adi\u00adent<\/td><\/tr><tr><td>publication_scenario.data.publication_time<\/td><td>Object<\/td><td><\/td><td>Pub\u00adli\u00adca\u00adtion peri\u00adod for one recip\u00adi\u00adent<\/td><\/tr><tr><td>publication_scenario.data.publication_time.unit_code<\/td><td>String<\/td><td>\u201cs\u201d<\/td><td>Unit time for time val\u00adue. Always is \u201cs\u201d (sec\u00adonds)<\/td><\/tr><tr><td>publication_scenario.data.publication_time.user_unit_code<\/td><td>String<\/td><td>\u201cmin\u201d<\/td><td>Unit time indi\u00adcat\u00aded by user. Avail\u00adable val\u00adues are \u201cmin\u201d (min\u00adutes) or \u201ch\u201d (hours)<\/td><\/tr><tr><td>publication_scenario.data.publication_time.value<\/td><td>Int<\/td><td>300<\/td><td>Peri\u00adod of pub\u00adli\u00adca\u00adtion time in sec\u00adonds.<\/td><\/tr><tr><td>publication_scenario.type<\/td><td>String<\/td><td>\u201cin_order\u201d<\/td><td>Pub\u00adli\u00adca\u00adtion sce\u00adnario type. Avail\u00adable val\u00adues:<br><code>parallel <\/code>- pub\u00adli\u00adca\u00adtion to all in par\u00adal\u00adlel<br><code>in_order <\/code>- pub\u00adli\u00adca\u00adtion in order of the car\u00adri\u00ader list<\/td><\/tr><tr><td>require\u00adments<\/td><td>Object<\/td><td><\/td><td>Vehi\u00adcle require\u00adments<\/td><\/tr><tr><td>requirements.additional_requirements<\/td><td>Array of Strings<\/td><td><\/td><td>Addi\u00adtion\u00adal vehi\u00adcle require\u00adments (<a href=\"https:\/\/www.trans.eu\/api\/general-information\/allowed-values#requirements\" target=\"_blank\" rel=\"noreferrer noopener\">see dic\u00adtio\u00adnary<\/a>)<\/td><\/tr><tr><td>requirements.capacity<\/td><td>Object<\/td><td><\/td><td>Vehi\u00adcle capac\u00adi\u00adty<\/td><\/tr><tr><td>requirements.capacity.max<\/td><td>Object<\/td><td><\/td><td>Vehi\u00adcle max capac\u00adi\u00adty<\/td><\/tr><tr><td>requirements.capacity.max.unit_code<\/td><td>String<\/td><td>\u201ct\u201d<\/td><td>Unit of max capac\u00adi\u00adty. Always is \u201ct\u201d (tonnes)<\/td><\/tr><tr><td>requirements.capacity.max.value<\/td><td>Float<\/td><td>24<\/td><td>Val\u00adue of vehi\u00adcle max capac\u00adi\u00adty<\/td><\/tr><tr><td>requirements.capacity.min<\/td><td>Object<\/td><td><\/td><td>Vehi\u00adcle min capac\u00adi\u00adty<\/td><\/tr><tr><td>requirements.capacity.min.unit_code<\/td><td>String<\/td><td>\u201ct\u201d<\/td><td>Unit of min capac\u00adi\u00adty. Always is \u201ct\u201d (tonnes)<\/td><\/tr><tr><td>requirements.capacity.min.value<\/td><td>Float<\/td><td>20<\/td><td>Val\u00adue of vehi\u00adcle min capac\u00adi\u00adty<\/td><\/tr><tr><td>requirements.exemption_from_adr<\/td><td>Boolean<\/td><td>False<\/td><td>The load can be trans\u00adport\u00aded by car\u00adri\u00ader with\u00adout ADR autho\u00adriza\u00adtion. It occurs only for&nbsp;<strong>additional_requirements&nbsp;<\/strong>=&nbsp;<code>adr<\/code>.<\/td><\/tr><tr><td>requirements.freight_type<\/td><td>String<\/td><td>\u201cFTL\u201d<\/td><td>Type of freight. Avail\u00adable val\u00adues: <code>FTL<\/code>, <code>LTL<\/code>, <code>MULTI_FTL<\/code>, <code>null<\/code><\/td><\/tr><tr><td>requirements.height<\/td><td>Object<\/td><td><\/td><td>Vehi\u00adcle height<\/td><\/tr><tr><td>requirements.height.unit_code<\/td><td>String<\/td><td>\u201cm\u201d<\/td><td>Unit of vehi\u00adcle height. Always is \u201cm\u201d (meters)<\/td><\/tr><tr><td>requirements.height.value<\/td><td>Float<\/td><td>2.1<\/td><td>Val\u00adue of vehi\u00adcle height<\/td><\/tr><tr><td>requirements.length<\/td><td>Object<\/td><td><\/td><td>Vehi\u00adcle length<\/td><\/tr><tr><td>requirements.length.unit_code<\/td><td>String<\/td><td>\u201cm\u201d<\/td><td>Unit of vehi\u00adcle length. Always is \u201cm\u201d (meters)<\/td><\/tr><tr><td>requirements.length.value<\/td><td>Float<\/td><td>3.4<\/td><td>Val\u00adue of vehi\u00adcle length<\/td><\/tr><tr><td>requirements.required_adr_classes<\/td><td>Array of Strings<\/td><td><\/td><td>ADR freight class\u00ades (<a href=\"https:\/\/www.trans.eu\/api\/general-information\/allowed-values#adrclass\" target=\"_blank\" rel=\"noreferrer noopener\">see dic\u00adtio\u00adnary<\/a>)<\/td><\/tr><tr><td>requirements.required_truck_bodies<\/td><td>Array of Strings<\/td><td><\/td><td>Expect\u00aded vehi\u00adcle body types matched to select\u00aded vehicle_size (<a href=\"https:\/\/www.trans.eu\/api\/general-information\/allowed-values#vehicletype\" target=\"_blank\" rel=\"noreferrer noopener\">see dic\u00adtio\u00adnary<\/a>). Array can con\u00adtains max 5 val\u00adues.<\/td><\/tr><tr><td>requirements.required_ways_of_loading<\/td><td>Array of Strings<\/td><td><\/td><td>The way of loading\/unloading vehi\u00adcle. Accept\u00adable val\u00adues:&nbsp;<code>back<\/code>,&nbsp;<code>side<\/code>,&nbsp;<code>top<\/code>.<\/td><\/tr><tr><td>requirements.shipping_remarks<\/td><td>String<\/td><td>\u201cdescrip\u00adtion\u201d<\/td><td>Addi\u00adtion\u00adal ship\u00adping remarks<\/td><\/tr><tr><td>requirements.vehicle_size<\/td><td>String<\/td><td>\u201cany_size\u201d<\/td><td>Expect\u00aded vehi\u00adcle size (<a href=\"https:\/\/www.trans.eu\/api\/general-information\/allowed-values#vehiclesize\" target=\"_blank\" rel=\"noreferrer noopener\">see dic\u00adtio\u00adnary<\/a>). Default val\u00adue is&nbsp;<code>any_size<\/code>. If you select&nbsp;<code>any_size&nbsp;<\/code>all 4 basic types of vehi\u00adcle size are auto\u00admat\u00adi\u00adcal\u00adly select\u00aded.<\/td><\/tr><tr><td>requirements.volume<\/td><td>Object<\/td><td><\/td><td>Vehi\u00adcle vol\u00adume<\/td><\/tr><tr><td>requirements.volume.unit_code<\/td><td>String<\/td><td>\u201cm3\u201d<\/td><td>Unit of vehi\u00adcle vol\u00adume. Always is \u201cm3\u201d (cubic meters)<\/td><\/tr><tr><td>requirements.volume.value<\/td><td>Float<\/td><td>12.1<\/td><td>Val\u00adue of vehi\u00adcle vol\u00adume<\/td><\/tr><tr><td>requirements.width<\/td><td>Object<\/td><td><\/td><td>Vehi\u00adcle width<\/td><\/tr><tr><td>requirements.width.unit_code<\/td><td>String<\/td><td>\u201cm\u201d<\/td><td>Unit of vehi\u00adcle width. Always is \u201cm\u201d (meters)<\/td><\/tr><tr><td>requirements.width.value<\/td><td>Float<\/td><td>2.3<\/td><td>Val\u00adue of vehi\u00adcle width<\/td><\/tr><tr><td>shipment_summary<\/td><td>Object<\/td><td><\/td><td><\/td><\/tr><tr><td>shipment_summary.amount<\/td><td>Int<\/td><td><\/td><td><\/td><\/tr><tr><td>shipment_summary.distance<\/td><td>Object<\/td><td><\/td><td><\/td><\/tr><tr><td>shipment_summary.distance.unit_code<\/td><td>String<\/td><td>\u201ckm\u201d<\/td><td><\/td><\/tr><tr><td>shipment_summary.distance.value<\/td><td>Int<\/td><td><\/td><td><\/td><\/tr><tr><td>shipment_summary.price<\/td><td>Array of Object<\/td><td><\/td><td><\/td><\/tr><tr><td>shipment_summary.price.amount<\/td><td>Int<\/td><td><\/td><td><\/td><\/tr><tr><td>shipment_summary.price.currency<\/td><td>String<\/td><td><\/td><td><\/td><\/tr><tr><td>shipment_summary.weight<\/td><td>Object<\/td><td><\/td><td><\/td><\/tr><tr><td>shipment_summary.weight.unit_code<\/td><td>String<\/td><td>\u201ct\u201d<\/td><td><\/td><\/tr><tr><td>shipment_summary.weight.value<\/td><td>Float<\/td><td><\/td><td><\/td><\/tr><tr><td>spots<\/td><td>Array of Objects<\/td><td><\/td><td>Col\u00adlec\u00adtion of routes\u2019 spots. One load\u00ading and one unload\u00ading will occur.<\/td><\/tr><tr><td>spots.id<\/td><td>String<\/td><td>\u201c21b4c767-8119\u20134938-8957-aeef320c4b2e\u201d<\/td><td>Spot id<\/td><\/tr><tr><td>spots.name<\/td><td>String<\/td><td>\u201cWroc\u0142aw home point\u201d<\/td><td>Name of spot<\/td><\/tr><tr><td>spots.place<\/td><td>Object<\/td><td><\/td><td>Infor\u00adma\u00adtion relat\u00aded to sin\u00adgle place on route<\/td><\/tr><tr><td>spots.place.address<\/td><td>Object<\/td><td><\/td><td>Address of the select\u00aded point<\/td><\/tr><tr><td>spots.place.address.country<\/td><td>String<\/td><td>\u201cpl\u201d<\/td><td>Coun\u00adtry using ISO val\u00adues (<a href=\"https:\/\/www.trans.eu\/api\/general-information\/allowed-values#country\" target=\"_blank\" rel=\"noreferrer noopener\">see dic\u00adtio\u00adnary<\/a>)<\/td><\/tr><tr><td>spots.place.address.detailed_location_id<\/td><td>Int<\/td><td>123456<\/td><td>Detailed loca\u00adtion id<\/td><\/tr><tr><td>spots.place.address.foreign_id<\/td><td>Int<\/td><td>null<\/td><td>For\u00adeign address id<\/td><\/tr><tr><td>spots.place.address.locality<\/td><td>String<\/td><td>Wroc\u0142aw<\/td><td>City name<\/td><\/tr><tr><td>spots.place.address.location_id<\/td><td>Int<\/td><td>234567<\/td><td>Loca\u00adtion id<\/td><\/tr><tr><td>spots.place.address.number<\/td><td>String<\/td><td>\u201c2\u20134\u201d<\/td><td>Prop\u00ader\u00adty num\u00adber<\/td><\/tr><tr><td>spots.place.address.postal_code<\/td><td>String<\/td><td>\u201c51\u2013546\u201d<\/td><td>Postal code<\/td><\/tr><tr><td>spots.place.address.radius<\/td><td>Float<\/td><td>null<\/td><td>Radius<\/td><\/tr><tr><td>spots.place.address.street<\/td><td>String<\/td><td>\u201cRac\u0142aw\u00adic\u00adka\u201d<\/td><td>Street name<\/td><\/tr><tr><td>spots.place.coordinates<\/td><td>Object<\/td><td><\/td><td>Lon\u00adgi\u00adtude and lat\u00adi\u00adtude for select\u00aded point<\/td><\/tr><tr><td>spots.place.coordinates.latitude<\/td><td>Float<\/td><td>53.35801<\/td><td>Lat\u00adi\u00adtude of the point along the route<\/td><\/tr><tr><td>spots.place.coordinates.longitude<\/td><td>Float<\/td><td>-2.16539<\/td><td>Lon\u00adgi\u00adtude of the point along the route<\/td><\/tr><tr><td>spots.type<\/td><td>String<\/td><td>\u201cload\u00ading\u201d<\/td><td>Avail\u00adable val\u00adues: <code>loading<\/code>, <code>unloading<\/code><\/td><\/tr><tr><td>sta\u00adtus<\/td><td>String<\/td><td>\u201cactive\u201d<\/td><td>Route sta\u00adtus. Always is <code>active<\/code> in the request.<\/td><\/tr><tr><td>suggested_calculated_route_id<\/td><td>String<\/td><td>\u201c46575331\u20137f0a-4f31-acaf-abc8eb08e72d\u201d<\/td><td><\/td><\/tr><tr><td>unique_key<\/td><td>String<\/td><td>\u201cRoute-PL-DE\u20111\u201d<\/td><td>Route unique name<\/td><\/tr><tr><td>_stats<\/td><td>Object<\/td><td><\/td><td>Route sta\u00adtis\u00adtics<\/td><\/tr><tr><td>_stats.contracts<\/td><td>Object<\/td><td><\/td><td>Route con\u00adtract sta\u00adtis\u00adtics<\/td><\/tr><tr><td>_stats.contracts.accepted<\/td><td>Int<\/td><td>1<\/td><td>Num\u00adber of accept\u00aded con\u00adtracts<\/td><\/tr><tr><td>_stats.contracts.active<\/td><td>Int<\/td><td>1<\/td><td>Num\u00adber of active con\u00adtracts<\/td><\/tr><tr><td>_stats.contracts.finished<\/td><td>Int<\/td><td>1<\/td><td>Num\u00adber of fin\u00adished con\u00adtracts<\/td><\/tr><tr><td>_stats.contracts.finished_previously_accepted<\/td><td>Int<\/td><td>0<\/td><td>Num\u00adber of fin\u00adished con\u00adtracts pre\u00advi\u00adous\u00adly accept\u00aded<\/td><\/tr><tr><td>_stats.contracts.fixed<\/td><td>Int<\/td><td>0<\/td><td>Num\u00adber of con\u00adtracts with fixed price<\/td><\/tr><tr><td>_stats.contracts.flexible<\/td><td>Int<\/td><td>0<\/td><td>Num\u00adber of con\u00adtracts with flex\u00adi\u00adble price<\/td><\/tr><tr><td>_stats.contracts.refused<\/td><td>Int<\/td><td>1<\/td><td>Num\u00adber of refused con\u00adtracts<\/td><\/tr><tr><td>_stats.contracts.registered<\/td><td>Int<\/td><td>0<\/td><td>Num\u00adber of reg\u00adis\u00adtered con\u00adtracts<\/td><\/tr><tr><td>_stats.contracts.waiting_for_acceptance<\/td><td>Int<\/td><td>2<\/td><td>Num\u00adber of con\u00adtracts wait\u00ading for accep\u00adtance<\/td><\/tr><tr><td>_stats.contracts.waiting_for_carrier_offer<\/td><td>Int<\/td><td>1<\/td><td>Num\u00adber of con\u00adtracts wait\u00ading for car\u00adri\u00ader offer<\/td><\/tr><tr><td>_stats.contracts.waiting_for_initial_carrier_offer<\/td><td>Int<\/td><td>0<\/td><td>Num\u00adber of con\u00adtracts wait\u00ading for first car\u00adri\u00ader offer<\/td><\/tr><tr><td>_stats.contracts.waiting_for_shipper_offer<\/td><td>Int<\/td><td>1<\/td><td>Num\u00adber of con\u00adtracts wait\u00ading for ship\u00adper offer<\/td><\/tr><tr><td>_stats.transports<\/td><td>Object<\/td><td><\/td><td>Route trans\u00adports sta\u00adtis\u00adtics<\/td><\/tr><tr><td>_stats.transports.awaiting<\/td><td>Object<\/td><td><\/td><td>Route trans\u00adports await\u00ading for real\u00adiza\u00adtion<\/td><\/tr><tr><td>_stats.transports.awaiting.count<\/td><td>Int<\/td><td><\/td><td>Num\u00adber of await\u00ading trans\u00adports<\/td><\/tr><tr><td>_stats.transports.awaiting.median_price<\/td><td>Float<\/td><td><\/td><td>Medi\u00adan price for  trans\u00adports await\u00ading for real\u00adiza\u00adtion<\/td><\/tr><tr><td>_stats.transports.cheapest_carrier_offer<\/td><td><\/td><td><\/td><td><\/td><\/tr><tr><td>_stats.transports.realized<\/td><td>Object<\/td><td><\/td><td>Route trans\u00adports real\u00adized<\/td><\/tr><tr><td>_stats.transports.realized.average_price<\/td><td>Float<\/td><td><\/td><td>Aver\u00adage price for real\u00adized trans\u00adports<\/td><\/tr><tr><td>_stats.transports.realized.count<\/td><td>Int<\/td><td><\/td><td>Num\u00adber of real\u00adized trans\u00adports<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<div class=\"wp-block-columns is-layout-flex wp-container-core-columns-is-layout-9d6595d7 wp-block-columns-is-layout-flex\">\n<div class=\"wp-block-column is-vertically-aligned-center is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:25%\" id=\"responsebody\">\n<h6 class=\"wp-block-heading\" style=\"font-style:normal;font-weight:700\">Response Body<\/h6>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:75%\">\n<div class=\"hcb_wrap\"><pre class=\"prism line-numbers lang-json\" data-lang=\"JSON\"><code>{\n    \"id\": \"4cdd0500-d930-4c9c-b290-70636f9f4b1e\",\n    \"unique_key\": \"route-123C\",\n    \"name\": \"PL - FR route\",\n    \"publication_scenario\": {\n        \"type\": \"in_order\",\n        \"data\": {\n            \"publication_time\": {\n                \"value\": 11000,\n                \"unit_code\": \"s\",\n                \"user_unit_code\": \"min\"\n            },\n            \"order\": \"next_recipient\"\n        }\n    },\n    \"spots\": [\n        {\n            \"id\": \"ee71a76b-dff3-4ec7-bf41-74769f75c418\",\n            \"name\": null,\n            \"type\": \"loading\",\n            \"place\": {\n                \"address\": {\n                    \"locality\": \"Suwa\u0142ki\",\n                    \"postal_code\": \"52-234\",\n                    \"country\": \"pl\",\n                    \"street\": null,\n                    \"number\": null,\n                    \"location_id\": null,\n                    \"detailed_location_id\": null,\n                    \"foreign_id\": null,\n                    \"radius\": null\n                },\n                \"coordinates\": {\n                    \"latitude\": null,\n                    \"longitude\": null\n                }\n            }\n        },\n        {\n            \"id\": \"a3febb33-a682-4ce5-a290-08af9af9b00d\",\n            \"name\": null,\n            \"type\": \"unloading\",\n            \"place\": {\n                \"address\": {\n                    \"locality\": \"MARSYLIA\",\n                    \"postal_code\": \"13014\",\n                    \"country\": \"fr\",\n                    \"street\": \"Boulevard Danielle Casanova\",\n                    \"number\": \"151\",\n                    \"location_id\": 1436808,\n                    \"detailed_location_id\": null,\n                    \"foreign_id\": null,\n                    \"radius\": null\n                },\n                \"coordinates\": {\n                    \"latitude\": 43.323447,\n                    \"longitude\": 5.3740827\n                }\n            }\n        }\n    ],\n    \"distance\": {\n        \"declared\": {\n            \"value\": 1200,\n            \"unit_code\": \"km\"\n        },\n        \"calculated\": null\n    },\n    \"suggested_calculated_route_id\": null,\n    \"distance_match\": {\n        \"min\": null,\n        \"max\": null\n    },\n    \"is_roundtrip\": false,\n    \"requirements\": {\n        \"required_truck_bodies\": [\n            \"cooler\",\n            \"curtainsider\"\n        ],\n        \"required_adr_classes\": [],\n        \"required_ways_of_loading\": [\n            \"side\",\n            \"back\"\n        ],\n        \"additional_requirements\": [],\n        \"shipping_remarks\": null,\n        \"freight_type\": \"FTL\",\n        \"vehicle_size\": \"bus\",\n        \"width\": null,\n        \"height\": null,\n        \"length\": null,\n        \"volume\": null,\n        \"capacity\": {\n            \"min\": {\n                \"value\": 12,\n                \"unit_code\": \"t\"\n            },\n            \"max\": {\n                \"value\": 23,\n                \"unit_code\": \"t\"\n            }\n        },\n        \"exemption_from_adr\": false\n    },\n    \"loads\": [\n        {\n            \"name\": null,\n            \"type_of_load\": null,\n            \"amount\": null,\n            \"width\": null,\n            \"height\": null,\n            \"length\": null,\n            \"volume\": null,\n            \"weight\": {\n                \"min\": null,\n                \"max\": null\n            },\n            \"pallets\": {\n                \"is_stackable\": false,\n                \"is_exchangeable\": false\n            }\n        }\n    ],\n    \"balancing\": {\n        \"type\": \"manual\",\n        \"allowed_types\": [\n            \"manual\",\n            \"contract_condition\",\n            \"freight_limit\",\n            \"percentage_share\",\n            \"price_ascending\"\n        ],\n        \"data\": {\n            \"freight_limit\": {\n                \"min\": null,\n                \"max\": null\n            }\n        }\n    },\n    \"status\": \"active\",\n    \"shipments_summary\": {\n        \"amount\": 0,\n        \"weight\": {\n            \"value\": 0,\n            \"unit_code\": \"t\"\n        },\n        \"distance\": {\n            \"value\": 0,\n            \"unit_code\": \"km\"\n        },\n        \"price\": [\n            {\n                \"amount\": null,\n                \"currency\": null\n            }\n        ]\n    },\n    \"position\": 245,\n    \"_stats\": {\n        \"contracts\": {\n            \"fixed\": 0,\n            \"flexible\": 0\n        },\n        \"transports\": {\n            \"realized\": {\n                \"average_price\": null,\n                \"count\": 0\n            },\n            \"awaiting\": {\n                \"median_price\": null,\n                \"count\": null\n            },\n            \"cheapest_carrier_offer\": null\n        }\n    }\n}<\/code><\/pre><\/div>\n<\/div>\n<\/div>\n\n\n\n<div style=\"height:50px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"validationerrors\" style=\"font-style:normal;font-weight:700\">Clients errors (code 400)<\/h4>\n\n\n\n<p>HTTP 4xx sta\u00adtus codes indi\u00adcate client errors, mean\u00ading that the request could not be processed due to an issue on the client side. Below is a list of request-spe\u00adcif\u00adic errors.<\/p>\n\n\n\n<div class=\"wp-block-columns is-layout-flex wp-container-core-columns-is-layout-9d6595d7 wp-block-columns-is-layout-flex\">\n<div class=\"wp-block-column is-vertically-aligned-center is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:25%\" id=\"responsebody\">\n<h6 class=\"wp-block-heading\" style=\"font-style:normal;font-weight:700\">Example error 1<\/h6>\n\n\n\n<p>No required \u2018name\u2019 field<\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:75%\">\n<div class=\"hcb_wrap\"><pre class=\"prism line-numbers lang-json\" data-lang=\"JSON\"><code>{\n    \"message\": [\n        \"name must be a string\"\n    ],\n    \"error\": \"Bad Request\",\n    \"statusCode\": 400,\n    \"service_code\": 5404\n}<\/code><\/pre><\/div>\n<\/div>\n<\/div>\n\n\n\n<div class=\"wp-block-columns is-layout-flex wp-container-core-columns-is-layout-9d6595d7 wp-block-columns-is-layout-flex\">\n<div class=\"wp-block-column is-vertically-aligned-center is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:25%\" id=\"responsebody\">\n<h6 class=\"wp-block-heading\" style=\"font-style:normal;font-weight:700\">Example error 2<\/h6>\n\n\n\n<p>No required \u2018order\u2019 field in pub\u00adli\u00adca\u00adtion sce\u00adnario case<\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:75%\">\n<div class=\"hcb_wrap\"><pre class=\"prism line-numbers lang-json\" data-lang=\"JSON\"><code>{\n    \"type\": \"http:\/\/www.w3.org\/Protocols\/rfc2616\/rfc2616-sec10.html\",\n    \"title\": \"Unprocessable Entity\",\n    \"status\": 422,\n    \"detail\": \"Failed Validation\",\n    \"validation_messages\": {\n        \"publication_scenario\": {\n            \"data\": {\n                \"order\": {\n                    \"isEnum\": \"order must be one of the following values: next_recipient, gradually\"\n                }\n            }\n        }\n    }\n}<\/code><\/pre><\/div>\n<\/div>\n<\/div>\n\n\n\n<div class=\"wp-block-columns is-layout-flex wp-container-core-columns-is-layout-9d6595d7 wp-block-columns-is-layout-flex\">\n<div class=\"wp-block-column is-vertically-aligned-center is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:25%\" id=\"responsebody\">\n<h6 class=\"wp-block-heading\" style=\"font-style:normal;font-weight:700\">Example error 3<\/h6>\n\n\n\n<p>No required \u2018spots.type\u2019 field<\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:75%\">\n<div class=\"hcb_wrap\"><pre class=\"prism line-numbers lang-json\" data-lang=\"JSON\"><code>{\n    \"message\": [\n        \"spots.0.type must be a string\"\n    ],\n    \"error\": \"Bad Request\",\n    \"statusCode\": 400,\n    \"service_code\": 5404\n}<\/code><\/pre><\/div>\n<\/div>\n<\/div>\n\n\n\n<p><\/p>\n","protected":false},"excerpt":{"rendered":"<p class=\"dont-break-out\">Cre\u00adat\u00ading a new route. Cre\u00adat\u00ading a new route.<\/p>\n","protected":false},"author":16,"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":[141,157],"tags":[],"class_list":["post-6535","post","type-post","status-publish","format-standard","hentry","category-freights-section","category-route-n"],"acf":[],"aioseo_notices":[],"lang":"en","translations":{"en":6535},"pll_sync_post":[],"_links":{"self":[{"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/6535","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\/16"}],"replies":[{"embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/comments?post=6535"}],"version-history":[{"count":7,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/6535\/revisions"}],"predecessor-version":[{"id":6612,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/6535\/revisions\/6612"}],"wp:attachment":[{"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/media?parent=6535"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/categories?post=6535"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/tags?post=6535"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}