{"id":6548,"date":"2026-04-28T12:07:06","date_gmt":"2026-04-28T10:07:06","guid":{"rendered":"https:\/\/www.trans.eu\/api\/?p=6548"},"modified":"2026-06-15T11:30:02","modified_gmt":"2026-06-15T09:30:02","slug":"balancing-the-contracted-route","status":"publish","type":"post","link":"https:\/\/www.trans.eu\/api\/freights-section\/balancing-the-contracted-route\/","title":{"rendered":"Balancing contracts in the route"},"content":{"rendered":"\n
\n
\n

Set\u00adting bal\u00adanc\u00ading type for route.
<\/p>\n\n\n\n\n\n\n\n

The route-id<\/code> iden\u00adti\u00adfi\u00adca\u00adtion num\u00adber in request can be obtained when cre\u00adat\u00ading the route or by down\u00adload\u00ading the routes list.<\/p>\n<\/div>\n\n\n\n

\n
POST<\/strong>
\/ext\/contracts-api\/v2\/routes\/{route-id}\/balance<\/pre>\n<\/div>\n<\/div>\n\n\n\n
<\/div>\n\n\n\n
\n
\n
 Request Authorization<\/h6>\n<\/div>\n\n\n\n
\n
Every request MUST include a valid access token obtained dur\u00ading 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
\n
\n
 Request<\/h6>\n<\/div>\n\n\n\n
\n
\n
\n
Request Head\u00ader<\/a><\/p>\n<\/div>\n\n\n\n
\n
Request Para\u00adme\u00adters<\/a><\/p>\n<\/div>\n\n\n\n
\n
Request Body<\/a><\/p>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n\n\n\n
\n
\n
 Successful Response<\/h6>\n<\/div>\n\n\n\n
\n
\n
\n
Response Fields<\/a><\/p>\n<\/div>\n\n\n\n
\n
Response Body<\/a><\/p>\n<\/div>\n\n\n\n
\n
<\/p>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n\n\n\n
\n
\n
 Error Response<\/h6>\n<\/div>\n\n\n\n
\n
\n
\n
Clients errors (400)<\/a><\/p>\n<\/div>\n\n\n\n
\n
<\/p>\n<\/div>\n\n\n\n
\n
Gen\u00ader\u00adal API errors<\/a><\/p>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n\n\n\n
<\/div>\n\n\n\n
\n
\n
Request Header<\/h6>\n<\/div>\n\n\n\n
\n
POST  \/ext\/contracts-api\/v2\/routes\/{route-id}\/balance 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
Request Parameters<\/h6>\n\n\n\n
Attribute<\/td>Type<\/td>Exam\u00adple<\/td>Manda\u00adto\u00adry<\/td>Descrip\u00adtion<\/td><\/tr>
balancing_type<\/td>String<\/td>\u201cMANUAL\u201d<\/td>Yes<\/td>Bal\u00adanc\u00ading type select\u00aded for route. Avail\u00adable val\u00adues: MANUAL, CONTRACT_CONDITION, PERCENTAGE_SHARE, PRICE_ASCENDING, FREIGHT_LIMIT<\/td><\/tr>
con\u00adtracts<\/td>Array of Objects<\/td><\/td>Yes for PERCENTAGE_SHARE<\/td>Per\u00adcent\u00adage of orders among car\u00adri\u00aders<\/td><\/tr>
contracts.contract_id<\/td>String<\/td>\u201c0dfc855d-ae8d-4d08-a8d4-a3375f8b78f9\u201d<\/td>No<\/td>Car\u00adri\u00ader con\u00adtract id<\/td><\/tr>
contracts.percentage_share<\/td>Float<\/td>81<\/td>No<\/td>Per\u00adcent\u00adage share for car\u00adri\u00ader con\u00adtract. 
All per\u00adcent\u00adages must add up to 100.<\/td><\/tr>
freight_limit<\/td>Object<\/td><\/td>Yes for FREIGHT_LIMIT<\/td>Trans\u00adport lim\u00adits for FREIGHT_LIMIT <\/code>type of bal\u00adanc\u00ading. <\/td><\/tr>
freight_limit.max<\/td>Int<\/td>30<\/td>Yes<\/td>Max lim\u00adit in %<\/td><\/tr>
freight_limit.min<\/td>Int<\/td>70<\/td>yes<\/td>Min lim\u00adit in %<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n
\n
Example Request Body<\/h6>\n<\/div>\n\n\n\n
\n
\/\/ Example No. 1\n{\n  \"balancing_type\": \"PERCENTAGE_SHARE\",\n  \"contracts\": [\n    {\n      \"contract_id\": \"0dfc855d-ae8d-4d08-a8d4-a3375f8b78f9\",\n      \"percentage_share\": 80\n    },\n    {\n      \"contract_id\": \"d68d9762-9a03-4209-8a8c-2acc15b8c83d\",\n      \"percentage_share\": 20\n    }\n  ],\n}\n\n\n\/\/ Example No. 2\n{\n  \"balancing_type\": \"FREIGHT_LIMIT\",\n  \"freight_limit\": {\n    \"min\": 30,\n    \"max\": 70\n  }\n}<\/code><\/pre><\/div>\n<\/div>\n<\/div>\n\n\n\n
Response Fields<\/h6>\n\n\n\n
Attribute<\/td>Type<\/td>Exam\u00adple<\/td>Descrip\u00adtion<\/td><\/tr>
balancing_type<\/td>String<\/td>\u201cMANUAL\u201d<\/td>Bal\u00adanc\u00ading type choosen in request<\/td><\/tr>
contracted_route_id<\/td>String<\/td>\u201c3a378345-1939\u201348c1-bc71-639e0add8048\u201d<\/td>Route Id choosen in request<\/td><\/tr>
freight_limit<\/td>Object<\/td><\/td>Trans\u00adport lim\u00adits for FREIGHT_LIMIT <\/code>type of bal\u00adanc\u00ading. <\/td><\/tr>
freight_limit.max<\/td>Int<\/td>30<\/td>Max lim\u00adit in %<\/td><\/tr>
freight_limit.min<\/td>Int<\/td>70<\/td>Min lim\u00adit in %<\/td><\/tr>
load_id<\/td>String<\/td>\u201c3090941d-a16f-475f-9f8b-26d\u00adb0c\u00adc\u00adc4a5d\u201d<\/td>Load id<\/td><\/tr>
name<\/td>String<\/td>\u201cRoute no 1\u201d<\/td>Con\u00adtract\u00aded route name<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n
\n
Response Body<\/h6>\n<\/div>\n\n\n\n
\n
{\n    \"contracted_route_id\": \"3a378345-1939-48c1-bc71-639e0add8048\",\n    \"load_id\": \"3090941d-a16f-475f-9f8b-26db0ccc4a5d\",\n    \"balancing_type\": \"FREIGHT_LIMIT\",\n    \"name\": \"trasa2 API\",\n    \"freight_limit\": {\n        \"min\": 30,\n        \"max\": 70\n    }\n}<\/code><\/pre><\/div>\n<\/div>\n<\/div>\n\n\n\n
<\/div>\n\n\n\n
Clients errors (code 400)<\/h4>\n\n\n\n
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
\n
\n
Example error 1<\/h6>\n\n\n\n
Not valid route id<\/p>\n<\/div>\n\n\n\n
\n
{\n    \"type\": \"http:\/\/www.w3.org\/Protocols\/rfc2616\/rfc2616-sec10.html\",\n    \"title\": \"Bad Request\",\n    \"status\": 400,\n    \"detail\": \"Route with ID: 2f13c8bd-2160-4ea6-a7e5-6929b5eb2692 not found!\",\n    \"service_code\": 5404\n}<\/code><\/pre><\/div>\n<\/div>\n<\/div>\n\n\n\n
\n
\n
Example error 2<\/h6>\n\n\n\n
No required \u2018balancing_type\u2019 field<\/p>\n<\/div>\n\n\n\n
\n
{\n    \"message\": [\n        \"balancing_type must be one of the following values: MANUAL, CONTRACT_CONDITION, PERCENTAGE_SHARE, PRICE_ASCENDING, FREIGHT_LIMIT\"\n    ],\n    \"error\": \"Bad Request\",\n    \"statusCode\": 400,\n    \"service_code\": 5404\n}<\/code><\/pre><\/div>\n<\/div>\n<\/div>\n\n\n\n
\n
\n
Example error 3<\/h6>\n\n\n\n
Not allowed bal\u00adanc\u00ading type<\/p>\n<\/div>\n\n\n\n
\n
{\n    \"type\": \"http:\/\/www.w3.org\/Protocols\/rfc2616\/rfc2616-sec10.html\",\n    \"title\": \"BalancingTypeException\",\n    \"status\": 420,\n    \"detail\": \"Chosen balancing type is not allowed for this contracted-route.\"\n}<\/code><\/pre><\/div>\n<\/div>\n<\/div>\n\n\n\n
\n
\n
Example error 4<\/h6>\n\n\n\n
Wrong con\u00adtract ids for the route<\/p>\n<\/div>\n\n\n\n
\n
{\n    \"type\": \"http:\/\/www.w3.org\/Protocols\/rfc2616\/rfc2616-sec10.html\",\n    \"title\": \"Conflict\",\n    \"status\": 409,\n    \"detail\": \"Contracts are not compatible\"\n}<\/code><\/pre><\/div>\n<\/div>\n<\/div>\n\n\n\n
\n
\n
Example error 5<\/h6>\n\n\n\n
For PERCENTAGE_SHARE bal\u00adanc\u00ading type sum\u00adma\u00adry share must be 100<\/p>\n<\/div>\n\n\n\n
\n
{\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        \"contracts\": {\n            \"contractsPercentageShare\": \"Contracts summary percentage share must be equal 100 and contains only unique contract ids\"\n        }\n    }\n}<\/code><\/pre><\/div>\n<\/div>\n<\/div>\n\n\n\n
<\/p>\n","protected":false},"excerpt":{"rendered":"
Set\u00adting bal\u00adanc\u00ading type for route. Set\u00adting bal\u00adanc\u00ading type for 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-6548","post","type-post","status-publish","format-standard","hentry","category-freights-section","category-route-n"],"acf":[],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t