{"id":1565,"date":"2020-04-08T16:28:33","date_gmt":"2020-04-08T14:28:33","guid":{"rendered":"https:\/\/www.trans.eu\/api\/?p=1565"},"modified":"2023-02-23T15:27:56","modified_gmt":"2023-02-23T14:27:56","slug":"vehicle-offer-description","status":"publish","type":"post","link":"https:\/\/www.trans.eu\/api\/vehicles\/vehicle-offer-description\/","title":{"rendered":"Vehicle offer description"},"content":{"rendered":"\n<p>Descrip\u00adtion of vehi\u00adcle API, allowed meth\u00adods and requests, val\u00adue types.<\/p>\n\n\n\n<!--more-->\n\n\n\n<h2 class=\"wp-block-heading\">Description<\/h2>\n\n\n\n<p>Vehi\u00adcle exchange API gives infor\u00adma\u00adtion about the avail\u00adabil\u00adi\u00adty of your vehi\u00adcle fleet to oth\u00ader plat\u00adform users who are look\u00ading for trans\u00adport between the giv\u00aden loca\u00adtions. Vehi\u00adcle offers are also one of the sources of vehi\u00adcle avail\u00adabil\u00adi\u00adty for the smart\u00admatch algo\u00adrithm. Each vehi\u00adcle offer is always vis\u00adi\u00adble to all plat\u00adform users once it was cre\u00adat\u00aded.<\/p>\n\n\n\n<p>Using this API it is also pos\u00adsi\u00adble to get all own vehi\u00adcle offers.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Creating new vehicle offer<\/h2>\n\n\n\n<p>With the use of Trans.eu API it is pos\u00adsi\u00adble to cre\u00adate new own vehi\u00adcle offer, dis\u00adplayed in Trans.eu Plat\u00adform in Vehi\u00adcle exchange mod\u00adule.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Components of a single vehicle offer<\/h2>\n\n\n\n<p>Each vehi\u00adcle offer con\u00adsists of:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>load\u00ading place<\/li>\n\n\n\n<li>unload\u00ading place (or unload\u00ading places for more than one unload\u00ading spot)<\/li>\n\n\n\n<li>car\u00adgo (load)<\/li>\n\n\n\n<li>vehi\u00adcle para\u00adme\u00adters<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\">Validation rules<\/h2>\n\n\n\n<p>Most impor\u00adtant val\u00adi\u00adda\u00adtion rules con\u00adsid\u00ader\u00ading freight pub\u00adli\u00adca\u00adtion<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>all&nbsp;<strong>dates<\/strong>&nbsp;must be greater or equal today<\/li>\n\n\n\n<li>vehi\u00adcle<strong> body typ<\/strong>e must be set accord\u00ading to dic\u00adtio\u00adnary<\/li>\n\n\n\n<li><strong>load\u00ading<\/strong> place and <strong>unload\u00ading<\/strong> place<\/li>\n<\/ul>\n\n\n\n<p><strong>Impor\u00adtant!<\/strong><br>Weight is always rep\u00adre\u00adsent\u00aded in tonnes.<br>Height, length and width are always rep\u00adre\u00adsent\u00aded in meters.<br>Vol\u00adume is always rep\u00adre\u00adsent\u00aded in cubic meters.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Structure of adding new vehicle<\/h2>\n\n\n\n<figure class=\"wp-block-table has-small-font-size\"><table><tbody><tr><td><strong>Json<\/strong><\/td><td><strong>Is required<\/strong><\/td><td><strong>Exam\u00adple<\/strong><\/td><td><strong>Type<\/strong><\/td><td><strong>Descrip\u00adtion<\/strong><\/td><\/tr><tr><td>contact_persons<\/td><td>No<\/td><td>\u201c1011111\u20135\u201d, \u201c1011111\u20131\u201d<\/td><td>Array<\/td><td>Field is not required, default con\u00adtact per\u00adson is cre\u00adator. When you send that field in request, only typed Trans-Id\u2019s will be assigned as con\u00adtact per\u00adsons. You can send max 3 Trans-Id\u2019s.<\/td><\/tr><tr><td>vehicle_size<\/td><td>Yes<\/td><td>Bus<\/td><td>String<\/td><td><a href=\"https:\/\/www.trans.eu\/api\/general-information\/allowed-values\/\">Avail\u00adable vehi\u00adcle sizes<\/a><\/td><\/tr><tr><td>truck_body<\/td><td>Yes<\/td><td>Cur\u00adtain\u00adsid\u00ader<\/td><td>String<\/td><td><a href=\"https:\/\/www.trans.eu\/api\/general-information\/allowed-values\/\">Allowed truck bod\u00adies<\/a><\/td><\/tr><tr><td>adr_classes<\/td><td>No<\/td><td>Adr_1<\/td><td>Array<\/td><td><a href=\"https:\/\/www.trans.eu\/api\/general-information\/allowed-values\/\">Allowed ADR class\u00ades<\/a><\/td><\/tr><tr><td>equip\u00adment<\/td><td>No<\/td><td>Lift, Hds<\/td><td>Array<\/td><td><a href=\"https:\/\/www.trans.eu\/api\/general-information\/allowed-values\/\">Allowed equip\u00adment<\/a><\/td><\/tr><tr><td>available_ways_of_loading<\/td><td>No<\/td><td>Top<\/td><td>Array<\/td><td><a href=\"https:\/\/www.trans.eu\/api\/general-information\/allowed-values\/\">Allowed ways of load\u00ading<\/a><\/td><\/tr><tr><td>loading_place<\/td><td>Yes<\/td><td>Object<\/td><td>\u2014<\/td><td>Load\u00ading place<\/td><\/tr><tr><td>loading_place.address<\/td><td>Yes<\/td><td>Object<\/td><td>\u2014<\/td><td>Load\u00ading place address<\/td><\/tr><tr><td>loading_place_address.locality<\/td><td>No<\/td><td>Wro\u00adclaw<\/td><td>String<\/td><td>City name<\/td><\/tr><tr><td>loading_place_address.postal_code<\/td><td>No<\/td><td>56\u2013111<\/td><td>String<\/td><td>Postal code<\/td><\/tr><tr><td>loading_place_address.country<\/td><td>Yes<\/td><td>PL<\/td><td>String<\/td><td><a href=\"https:\/\/www.trans.eu\/api\/general-information\/countries\/\">Coun\u00adtry using ISO val\u00adues<\/a><\/td><\/tr><tr><td>loading_place.coordinates<\/td><td>No<\/td><td>Object<\/td><td>\u2014<\/td><td>Lon\u00adgi\u00adtude and lat\u00adi\u00adtude for select\u00aded point<\/td><\/tr><tr><td>loading_place.coordinates.latitude<\/td><td>No<\/td><td>53.35801<\/td><td>Float<\/td><td>Lat\u00adi\u00adtude of the point along the freight route<\/td><\/tr><tr><td>loading_place.coordinates.longitude<\/td><td>No<\/td><td>58.78801<\/td><td>Float<\/td><td>Lon\u00adgi\u00adtude of the point along the freight route<\/td><\/tr><tr><td>loading_place.range<\/td><td>No<\/td><td>50<\/td><td>Int<\/td><td>Range must be one of the fol\u00adlow\u00ading val\u00adues: 50,75,100,125,150,200,250<\/td><\/tr><tr><td>unloading_places<\/td><td>Yes<\/td><td>Object<\/td><td>\u2014<\/td><td>Unload\u00ading places (you can send max 10 loca\u00adtions)<\/td><\/tr><tr><td>unloading_places.address<\/td><td>Yes<\/td><td>Object<\/td><td>\u2014<\/td><td>Unload\u00ading place address<\/td><\/tr><tr><td>unloading_places.address.locality<\/td><td>No<\/td><td>Wro\u00adclaw<\/td><td>String<\/td><td>City name<\/td><\/tr><tr><td>unloading_places.address.postal_code<\/td><td>No<\/td><td>55\u2013261<\/td><td>String<\/td><td>Postal code<\/td><\/tr><tr><td>unloading_places.address.country<\/td><td>Yes<\/td><td>PL<\/td><td>String<\/td><td><a href=\"https:\/\/www.trans.eu\/api\/general-information\/countries\/\">Coun\u00adtry using ISO val\u00adues<\/a><\/td><\/tr><tr><td>unloading_places.coordinates<\/td><td>No<\/td><td>Object<\/td><td>\u2014<\/td><td>Lon\u00adgi\u00adtude and lat\u00adi\u00adtude for select\u00aded point<\/td><\/tr><tr><td>unloading_places.coordinates.latitude<\/td><td>No<\/td><td>53.36789<\/td><td>Float<\/td><td>Lat\u00adi\u00adtude of the point along the freight route<\/td><\/tr><tr><td>unloading_places.coordinates.longitude<\/td><td>No<\/td><td>58.78999<\/td><td>Float<\/td><td>Lon\u00adgi\u00adtude of the point along the freight route<\/td><\/tr><tr><td>unloading_places.range<\/td><td>No<\/td><td>50<\/td><td>Int<\/td><td>Range must be one of the fol\u00adlow\u00ading val\u00adues: 50,75,100,125,150,200,250<\/td><\/tr><tr><td>car\u00adgo<\/td><td>Yes<\/td><td>Object<\/td><td>\u2014<\/td><td>Car\u00adgo descrip\u00adtion<\/td><\/tr><tr><td>cargo.height<\/td><td>No<\/td><td>2.2<\/td><td>Float<\/td><td>Car\u00adgo height<\/td><\/tr><tr><td>cargo.width<\/td><td>No<\/td><td>4<\/td><td>Float<\/td><td>Car\u00adgo width<\/td><\/tr><tr><td>cargo.length<\/td><td>No<\/td><td>30<\/td><td>Float<\/td><td>Car\u00adgo length<\/td><\/tr><tr><td>cargo.volume<\/td><td>No<\/td><td>40<\/td><td>Float<\/td><td>Car\u00adgo vol\u00adume<\/td><\/tr><tr><td>cargo.capacity<\/td><td>Yes<\/td><td>24<\/td><td>Float<\/td><td>Car\u00adgo capac\u00adi\u00adty<\/td><\/tr><tr><td>available_on<\/td><td>Yes<\/td><td>Object<\/td><td>\u2014<\/td><td>Vehi\u00adcle avail\u00adabil\u00adi\u00adty<\/td><\/tr><tr><td>available_on.begin<\/td><td>Yes<\/td><td>2021\u201302-20T17:25:00+0000<\/td><td>Time\u00adstamp<\/td><td>Vehi\u00adcle avail\u00adabil\u00adi\u00adty begin<\/td><\/tr><tr><td>available_on.end<\/td><td>Yes<\/td><td>2021\u201302-21T19:25:00+0000<\/td><td>Time\u00adstamp<\/td><td>Vehi\u00adcle avail\u00adabil\u00adi\u00adty end<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Json example<\/strong><\/h2>\n\n\n\n<div class=\"hcb_wrap\"><pre class=\"prism line-numbers lang-json\" data-lang=\"JSON\"><code>{\n  \"contact_persons\": [\n    \"1011111-5\",\n    \"1011111-1\"\n  ],\n  \"vehicle_size\": \"bus\",\n  \"truck_body\": \"standard-tent\",\n  \"adr_classes\": [\n    \"adr_1\"\n  ],\n  \"equipment\": [\n    \"lift\"\n  ],\n  \"available_ways_of_loading\": [\n    \"top\"\n  ],\n  \"loading_place\": {\n    \"address\": {\n      \"locality\": \"Wroclaw\",\n      \"postal_code\": \"56-111\",\n      \"country\": \"pl\"\n    }\n  },\n  \"unloading_places\": [\n    {\n      \"address\": {\n        \"locality\": \"O\u0142awa\",\n        \"country\": \"pl\",\n        \"postal_code\": \"55-200\"\n      },\n      \"coordinates\": {\n        \"longitude\": 111,\n        \"latitude\": 0.11111\n      },\n      \"range\": 50\n    },\n    {\n      \"address\": {\n        \"country\": \"gb\"\n      }\n    }\n  ],\n  \"cargo\": {\n    \"capacity\": 24,\n    \"height\": 2.2,\n    \"width\": 4,\n    \"length\": 30,\n    \"volume\": 40\n  },\n  \"available_on\": {\n    \"begin\": \"2022-03-17T15:25:00+0000\",\n    \"end\": \"2022-03-17T19:25:00+0000\"\n  }\n}<\/code><\/pre><\/div>\n\n\n\n<h2 class=\"wp-block-heading\">Confirmation of posting vehicle<\/h2>\n\n\n\n<figure class=\"wp-block-table has-small-font-size\"><table><tbody><tr><td><strong>Json<\/strong><\/td><td><strong>Is required<\/strong><\/td><td><strong>Exam\u00adple<\/strong><\/td><td><strong>Type<\/strong><\/td><td><strong>Descrip\u00adtion<\/strong><\/td><\/tr><tr><td>id<\/td><td>No<\/td><td>01EZPX4BV51513JQCBK7Y5V7K9<\/td><td>String<\/td><td>Offer id assigned auto\u00admat\u00adi\u00adcal\u00adly dur\u00ading cre\u00adation of a new vehi\u00adcle<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\">Structure of getting single vehicle offer and list of vehicle offers created<\/h2>\n\n\n\n<figure class=\"wp-block-table has-small-font-size\"><table><tbody><tr><td><strong>Json<\/strong><\/td><td><strong>Is required<\/strong><\/td><td><strong>Exam\u00adple<\/strong><\/td><td><strong>Type<\/strong><\/td><td><strong>Descrip\u00adtion<\/strong><\/td><\/tr><tr><td>created_at<\/td><td>No<\/td><td>2021\u201303-01T12:45:11+00:00<\/td><td>Time\u00adstamp<\/td><td>Vehi\u00adcle offer cre\u00adation date<\/td><\/tr><tr><td>expiration_date<\/td><td>No<\/td><td>2021\u201303-01T19:25:00+0000<\/td><td>Time\u00adstamp<\/td><td>Vehi\u00adcle offer expi\u00adra\u00adtion date<\/td><\/tr><tr><td>id<\/td><td>No<\/td><td>01EZPX4BV51513JQCBK7Y5V7K9<\/td><td>String<\/td><td>Vehi\u00adcle offer id assigned auto\u00admat\u00adi\u00adcal\u00adly dur\u00ading cre\u00adation<\/td><\/tr><tr><td>offer_id<\/td><td>No<\/td><td>202574219<\/td><td>Int<\/td><td>Offer id from vehi\u00adcle offers list<\/td><\/tr><tr><td>vehi\u00adcle<\/td><td>No<\/td><td>Object<\/td><td>\u2014<\/td><td>Vehi\u00adcle descrip\u00adtion<\/td><\/tr><tr><td>vehicle.adr_classes<\/td><td>No<\/td><td>Adr_1<\/td><td>Array<\/td><td>ADR class\u00ades list<\/td><\/tr><tr><td>vehicle.available_on<\/td><td>No<\/td><td>Object<\/td><td>\u2014<\/td><td>Vehi\u00adcle avail\u00adabil\u00adi\u00adty<\/td><\/tr><tr><td>vehicle.available_on.begin<\/td><td>No<\/td><td>2021\u201302-20T17:25:00+0000<\/td><td>Time\u00adstamp<\/td><td>Vehi\u00adcle avail\u00adabil\u00adi\u00adty begin<\/td><\/tr><tr><td>vehicle.available_on.end<\/td><td>No<\/td><td>2021\u201302-20T19:25:00+0000<\/td><td>Time\u00adstamp<\/td><td>Vehi\u00adcle avail\u00adabil\u00adi\u00adty end<\/td><\/tr><tr><td>vehicle.available_ways_of_loading<\/td><td>No<\/td><td>Top<\/td><td>Array<\/td><td>Allowed ways of load\u00ading<\/td><\/tr><tr><td>vehicle.cargo<\/td><td>No<\/td><td>Object<\/td><td>\u2014<\/td><td>Car\u00adgo descrip\u00adtion<\/td><\/tr><tr><td>vehicle.cargo.height<\/td><td>No<\/td><td>2.2<\/td><td>Float<\/td><td>Car\u00adgo height<\/td><\/tr><tr><td>vehicle.cargo.width<\/td><td>No<\/td><td>4<\/td><td>Float<\/td><td>Car\u00adgo width<\/td><\/tr><tr><td>vehicle.cargo.length<\/td><td>No<\/td><td>30<\/td><td>Float<\/td><td>Car\u00adgo length<\/td><\/tr><tr><td>vehicle.cargo.volume<\/td><td>No<\/td><td>40<\/td><td>Float<\/td><td>Car\u00adgo vol\u00adume<\/td><\/tr><tr><td>vehicle.cargo.capacity<\/td><td>No<\/td><td>24<\/td><td>Float<\/td><td>Car\u00adgo capac\u00adi\u00adty<\/td><\/tr><tr><td>vehicle.equipment<\/td><td>No<\/td><td>Lift, Hds<\/td><td>Array<\/td><td>Equip\u00adment list<\/td><\/tr><tr><td>vehicle.size<\/td><td>No<\/td><td>Bus<\/td><td>String<\/td><td>Vehi\u00adcle size<\/td><\/tr><tr><td>vehicle.truck_body<\/td><td>No<\/td><td>Cur\u00adtain\u00adsid\u00ader<\/td><td>String<\/td><td>Truck body<\/td><\/tr><tr><td>vehicle.loading_place<\/td><td>No<\/td><td>Object<\/td><td>\u2014<\/td><td>Load\u00ading place<\/td><\/tr><tr><td>vehicle.loading_place.address<\/td><td>No<\/td><td>Object<\/td><td>\u2014<\/td><td>Load\u00ading place address<\/td><\/tr><tr><td>vehicle.loading_place_address.locality<\/td><td>No<\/td><td>Wro\u00adclaw<\/td><td>String<\/td><td>City name<\/td><\/tr><tr><td>vehicle.loading_place_address.postal_code<\/td><td>No<\/td><td>56\u2013111<\/td><td>String<\/td><td>Postal code<\/td><\/tr><tr><td>vehicle.loading_place_address.country<\/td><td>No<\/td><td>PL<\/td><td>String<\/td><td>Coun\u00adtry using ISO val\u00adues<\/td><\/tr><tr><td>vehicle.loading_place.coordinates<\/td><td>No<\/td><td>Object<\/td><td>\u2014<\/td><td>Lon\u00adgi\u00adtude and lat\u00adi\u00adtude for select\u00aded point<\/td><\/tr><tr><td>vehicle.loading_place.coordinates.latitude<\/td><td>No<\/td><td>53.35801<\/td><td>Float<\/td><td>Lat\u00adi\u00adtude of the point along the freight route<\/td><\/tr><tr><td>vehicle.loading_place.coordinates.longitude<\/td><td>No<\/td><td>58.78801<\/td><td>Float<\/td><td>Lon\u00adgi\u00adtude of the point along the freight route<\/td><\/tr><tr><td>vehicle.loading_place.range<\/td><td>No<\/td><td>50<\/td><td>Int<\/td><td>Range<\/td><\/tr><tr><td>vehicle.unloading_places<\/td><td>No<\/td><td>Object<\/td><td>\u2014<\/td><td>Unload\u00ading place<\/td><\/tr><tr><td>vehicle.unloading_places.address<\/td><td>No<\/td><td>Object<\/td><td>\u2014<\/td><td>Unload\u00ading place address<\/td><\/tr><tr><td>vehicle.unloading_places.address.locality<\/td><td>No<\/td><td>Wro\u00adclaw<\/td><td>String<\/td><td>City name<\/td><\/tr><tr><td>vehicle.unloading_places.address.postal_code<\/td><td>No<\/td><td>55\u2013261<\/td><td>String<\/td><td>Postal code<\/td><\/tr><tr><td>vehicle.unloading_places.address.country<\/td><td>No<\/td><td>PL<\/td><td>String<\/td><td>Coun\u00adtry using ISO val\u00adues<\/td><\/tr><tr><td>vehicle.unloading_places.coordinates<\/td><td>No<\/td><td>Object<\/td><td>\u2014<\/td><td>Lon\u00adgi\u00adtude and lat\u00adi\u00adtude for select\u00aded point<\/td><\/tr><tr><td>vehicle.unloading_places.coordinates.latitude<\/td><td>No<\/td><td>53.36789<\/td><td>Float<\/td><td>Lat\u00adi\u00adtude of the point along the freight route<\/td><\/tr><tr><td>vehicle.unloading_places.coordinates.longitude<\/td><td>No<\/td><td>58.78999<\/td><td>Float<\/td><td>Lon\u00adgi\u00adtude of the point along the freight route<\/td><\/tr><tr><td>vehicle.unloading_places.range<\/td><td>No<\/td><td>50<\/td><td>Int<\/td><td>Range<\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"<p class=\"dont-break-out\">Descrip\u00adtion of vehi\u00adcle API, allowed meth\u00adods and requests, val\u00adue types.<\/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":[46],"tags":[],"class_list":["post-1565","post","type-post","status-publish","format-standard","hentry","category-vehicles"],"acf":[],"aioseo_notices":[],"lang":"en","translations":{"en":1565},"pll_sync_post":[],"_links":{"self":[{"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/1565","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=1565"}],"version-history":[{"count":0,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/1565\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/media?parent=1565"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/categories?post=1565"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/tags?post=1565"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}