{"id":6584,"date":"2026-04-29T14:45:43","date_gmt":"2026-04-29T12:45:43","guid":{"rendered":"https:\/\/www.trans.eu\/api\/?p=6584"},"modified":"2026-04-30T12:47:54","modified_gmt":"2026-04-30T10:47:54","slug":"create-flexible-contract","status":"publish","type":"post","link":"https:\/\/www.trans.eu\/api\/freights-section\/create-flexible-contract\/","title":{"rendered":"Create flexible contract"},"content":{"rendered":"\n
\n
\n

Cre\u00adat\u00ading a new flex\u00adi\u00adble con\u00adtract in select\u00aded route.<\/p>\n\n\n\n\n\n\n\n

After suc\u00adcess\u00adful\u00adly exe\u00adcut\u00ading the method, you receive in response the con\u00adtract details with the unique con\u00adtract iden\u00adti\u00adfi\u00adca\u00adtion num\u00adber id <\/strong>assigned when cre\u00adat\u00ading the new con\u00adtract.<\/p>\n<\/div>\n\n\n\n

\n
POST<\/strong>
 \/ext\/contracts-api\/v2\/contracts\/flexible

<\/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\/contracts\/flexible 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 for create flexible contract<\/h6>\n\n\n\n
Attribute<\/td>Type<\/td>Exam\u00adple<\/td>Manda\u00adto\u00adry<\/td>Descrip\u00adtion<\/td><\/tr>
car\u00adri\u00ader<\/td>Object<\/td><\/td>Yes<\/td>Car\u00adri\u00ader invit\u00aded to the get con\u00adtract<\/td><\/tr>
carrier.company<\/td>Object<\/td><\/td>Yes<\/td>Car\u00adri\u00ader com\u00adpa\u00adny details<\/td><\/tr>
carrier.company.id<\/td>Int<\/td>456745<\/td>Yes<\/td>Car\u00adri\u00ader com\u00adpa\u00adny Id<\/td><\/tr>
carrier.contact_persons<\/td>Array of Objects<\/td><\/td>No<\/td>Car\u00adri\u00ader per\u00adsons invit\u00aded to get con\u00adtract<\/td><\/tr>
carrier.contact_persons.employee<\/td>Object<\/td><\/td>No<\/td>Con\u00adtact per\u00adson details<\/td><\/tr>
carrier.contact_persons.employee.account_id<\/td>Int<\/td>123321<\/td>No<\/td>Con\u00adtact per\u00adson inter\u00adnal Id<\/td><\/tr>
con\u00adfig<\/td>Object<\/td><\/td>Yes<\/td>Con\u00adtract con\u00adfig\u00adu\u00adra\u00adtion<\/td><\/tr>
config.send_to_carrier<\/td>Boolean<\/td>True<\/td>Yes<\/td>Cre\u00adat\u00aded con\u00adtract will be auto\u00admat\u00adi\u00adcal\u00adly send to car\u00adri\u00ader.
True <\/code>val\u00adue is required.<\/td><\/tr>
pric\u00ading<\/td>Object<\/td><\/td>No<\/td>Pric\u00ading for con\u00adtract<\/td><\/tr>
pricing.negotiable<\/td>Boolean<\/td>True<\/td>No<\/td><\/td><\/tr>
pricing.price<\/td>Object<\/td><\/td>No<\/td>Price options for nego\u00adti\u00ada\u00adtions<\/td><\/tr>
pricing.price.currency<\/td>String<\/td>\u201ceur\u201d<\/td>No<\/td>Price cur\u00adren\u00adcy for futher nego\u00adta\u00adtions<\/td><\/tr>
route<\/td>Object<\/td><\/td>Yes<\/td>Route for new con\u00adtract<\/td><\/tr>
route.id<\/td>String<\/td>\u201c3fa85f64-5717\u20134562-b3fc-2c963f66afa6\u201d<\/td>Yes<\/td>Route Id<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n
\n
Example Request Body for create flexible contract<\/h6>\n<\/div>\n\n\n\n
\n
{\n  \"route\": {\n    \"id\": \"3a378345-1939-48c1-bc71-639e0add8048\"\n  },\n  \"pricing\": {\n    \"price\": {\n      \"currency\": \"pln\"\n    },\n    \"negotiable\": false\n  },\n  \"carrier\": {\n    \"company\": {\n      \"id\": 1013865\n    },\n    \"contact_persons\": [\n     {\n      \"employee\": {\n        \"account_id\": 771476\n      }\n     }\n    ]\n  },\n  \"config\": {\n    \"send_to_carrier\": true\n  }\n}<\/code><\/pre><\/div>\n<\/div>\n<\/div>\n\n\n\n
Response Fields for created flexible contract<\/h6>\n\n\n\n
The response con\u00adtains exact\u00adly the same list of fields as the Get con\u00adtract details<\/a> response and the fol\u00adlow\u00ading fields are filled auto\u00admat\u00adi\u00adcal\u00adly based on the request type:<\/p>\n\n\n\n
Attribute<\/td>Type<\/td>Exam\u00adple<\/td>Descrip\u00adtion<\/td><\/tr>
pricing.type<\/td>String<\/td>\u201cno_rate\u201d<\/td>Pric\u00ading type. In the response always has val\u00adue \u201cno_rate\u201d<\/td><\/tr>
sta\u00adtus<\/td>String<\/td>\u201cwaiting_for_acceptance\u201d<\/td>Con\u00adtract sta\u00adtus.  In the response always has val\u00adue \u201cwaiting_for_acceptance\u201d<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n
\n
Response Body for create flexible contract<\/h6>\n<\/div>\n\n\n\n
\n
{\n    \"id\": \"0bd41dab-f606-4b38-ab7a-24e868a729a8\",\n    \"base_contract_id\": \"0bd41dab-f606-4b38-ab7a-24e868a729a8\",\n    \"type\": \"flexible\",\n    \"position\": null,\n    \"percentage_share\": 0,\n    \"route\": {\n        \"id\": \"3a378345-1939-48c1-bc71-639e0add8048\",\n        \"unique_key\": \"456788\",\n        \"name\": \"trasa2 API\",\n        \"publication_scenario\": {\n            \"type\": \"in_order\",\n            \"data\": {\n                \"publication_time\": {\n                    \"value\": 300,\n                    \"unit_code\": \"s\",\n                    \"user_unit_code\": \"min\"\n                },\n                \"order\": \"next_recipient\"\n            }\n        },\n        \"spots\": [\n            {\n                \"id\": \"287b8962-bb35-4012-938c-3eed57d52596\",\n                \"name\": \"Pocz\u0105tek PL 50-002 2021-08-11 13:51:15\",\n                \"type\": \"loading\",\n                \"place\": {\n                    \"address\": {\n                        \"locality\": \"Wroc\u0142aw\",\n                        \"postal_code\": \"50-002\",\n                        \"country\": \"pl\",\n                        \"street\": \"Nowa\",\n                        \"number\": \"2\",\n                        \"location_id\": 2513724,\n                        \"detailed_location_id\": null,\n                        \"foreign_id\": null,\n                        \"radius\": null\n                    },\n                    \"coordinates\": {\n                        \"latitude\": 51.1,\n                        \"longitude\": 17.03333\n                    }\n                }\n            },\n            {\n                \"id\": \"078e89c1-dcca-417f-9973-569cb87279c2\",\n                \"name\": \"Pocz\u0105tek trasy\",\n                \"type\": \"unloading\",\n                \"place\": {\n                    \"address\": {\n                        \"locality\": \"Wroc\u0142aw\",\n                        \"postal_code\": \"53-146\",\n                        \"country\": \"pl\",\n                        \"street\": \"Rac\u0142awicka\",\n                        \"number\": \"2-4\",\n                        \"location_id\": 1185465,\n                        \"detailed_location_id\": 58279582,\n                        \"foreign_id\": null,\n                        \"radius\": null\n                    },\n                    \"coordinates\": {\n                        \"latitude\": 51.0825872,\n                        \"longitude\": 17.0038841\n                    }\n                }\n            }\n        ],\n        \"distance\": {\n            \"declared\": null,\n            \"calculated\": {\n                \"value\": 4,\n                \"unit_code\": \"km\"\n            }\n        },\n        \"suggested_calculated_route_id\": \"fa4c5378-0ccc-4737-90d2-efec0a1dd1a8\",\n        \"distance_match\": {\n            \"min\": null,\n            \"max\": null\n        },\n        \"is_roundtrip\": false,\n        \"requirements\": {\n            \"required_truck_bodies\": [],\n            \"required_adr_classes\": [],\n            \"required_ways_of_loading\": [],\n            \"additional_requirements\": [],\n            \"shipping_remarks\": null,\n            \"freight_type\": null,\n            \"vehicle_size\": null,\n            \"width\": null,\n            \"height\": null,\n            \"length\": null,\n            \"volume\": null,\n            \"capacity\": {\n                \"min\": null,\n                \"max\": null\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\": \"freight_limit\",\n            \"allowed_types\": [\n                \"manual\",\n                \"freight_limit\",\n                \"percentage_share\"\n            ],\n            \"data\": {\n                \"freight_limit\": {\n                    \"min\": null,\n                    \"max\": null\n                }\n            }\n        },\n        \"status\": \"active\",\n        \"shipments_summary\": {\n            \"amount\": 1,\n            \"weight\": {\n                \"value\": 22,\n                \"unit_code\": \"t\"\n            },\n            \"distance\": {\n                \"value\": 342,\n                \"unit_code\": \"km\"\n            },\n            \"price\": [\n                {\n                    \"amount\": 56,\n                    \"currency\": \"1_eur\"\n                }\n            ]\n        },\n        \"position\": 231,\n        \"_stats\": {\n            \"contracts\": {\n                \"fixed\": 1,\n                \"flexible\": 1\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    },\n    \"period\": {\n        \"from\": null,\n        \"to\": null\n    },\n    \"pricing\": {\n        \"type\": \"no_rate\",\n        \"price\": {\n            \"currency\": \"eur\"\n        }\n    },\n    \"status\": \"waiting_for_acceptance\",\n    \"carrier\": {\n        \"company\": {\n            \"id\": 1013865,\n            \"name\": \"Carrier IIT 2\"\n        },\n        \"contact_persons\": [\n            {\n                \"id\": \"011a9d31-7b53-4365-999d-e27d64df7046\",\n                \"employee\": {\n                    \"id\": 999446,\n                    \"account_id\": 771476,\n                    \"given_name\": \"Jan\",\n                    \"family_name\": \"Nowak\",\n                    \"trans_id\": \"1013865-3\",\n                    \"email\": \"jnowak@mail.eu\",\n                    \"telephone\": \"(0048) 12345678\"\n                },\n                \"channels\": [\n                    \"email\",\n                    \"push\",\n                    \"web-push\",\n                    \"messenger\"\n                ],\n                \"reported_by\": {\n                    \"company\": {\n                        \"id\": 1007374\n                    }\n                }\n            }\n        ],\n        \"cooperation_status\": \"active\"\n    },\n    \"shipper\": {\n        \"company\": {\n            \"id\": 1007374,\n            \"name\": \"Forwarder IIT\"\n        },\n        \"contact_persons\": [\n            {\n                \"id\": \"2a7936e1-3f6a-4654-9c72-93857bf6941d\",\n                \"employee\": {\n                    \"id\": 993848,\n                    \"account_id\": 765361,\n                    \"given_name\": \"Krzysztof\",\n                    \"family_name\": \"Kowalski\",\n                    \"trans_id\": \"1007374-5\",\n                    \"email\": \"kkowalski@mail.eu\",\n                    \"telephone\": null\n                },\n                \"channels\": [\n                    \"email\",\n                    \"push\",\n                    \"web-push\",\n                    \"messenger\"\n                ],\n                \"reported_by\": {\n                    \"company\": {\n                        \"id\": 1007374\n                    }\n                }\n            }\n        ],\n        \"cooperation_status\": \"active\"\n    },\n    \"deactivations\": [],\n    \"_stats\": {\n        \"transports\": {\n            \"realized\": null,\n            \"average_per_month\": null,\n            \"awaiting\": null\n        },\n        \"offers\": {\n            \"accepted\": null,\n            \"total\": null,\n            \"acceptance_rate\": null\n        },\n        \"base_contract\": {\n            \"registered\": 0,\n            \"waiting_for_acceptance\": 1,\n            \"waiting_for_initial_carrier_offer\": 0,\n            \"waiting_for_shipper_offer\": 0,\n            \"waiting_for_carrier_offer\": 0,\n            \"refused\": 0,\n            \"accepted\": 0,\n            \"active\": 0,\n            \"finished\": 0\n        }\n    },\n    \"_meta\": {\n        \"has_been_sent_to_carrier\": true\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
Invalid 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\": \"Contracted route with ID: 3fa85f64-5717-4562-b3fc-2c963f66afa6 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
Send_to_carrier field must be set True<\/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        \"config\": {\n            \"send_to_carrier\": {\n                \"equals\": \"send_to_carrier must be equal to true\"\n            }\n        }\n    },\n    \"service_code\": 5404\n}<\/code><\/pre><\/div>\n<\/div>\n<\/div>\n\n\n\n
<\/p>\n","protected":false},"excerpt":{"rendered":"
Cre\u00adat\u00ading a new flex\u00adi\u00adble con\u00adtract in select\u00aded route. Cre\u00adat\u00ading a new flex\u00adi\u00adble con\u00adtract in select\u00aded 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-6584","post","type-post","status-publish","format-standard","hentry","category-freights-section","category-route-n"],"acf":[],"aioseo_notices":[],"lang":"en","translations":{"en":6584},"pll_sync_post":[],"_links":{"self":[{"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/6584","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=6584"}],"version-history":[{"count":4,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/6584\/revisions"}],"predecessor-version":[{"id":6621,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/6584\/revisions\/6621"}],"wp:attachment":[{"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/media?parent=6584"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/categories?post=6584"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/tags?post=6584"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}