{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1f6bf01f-a106-4deb-a284-eb781e99e155","name":"Sovtes Public API v2.9","description":"#StandWithUkraine [https://www.standwithukraine.how/](https://www.standwithukraine.how/)\n\nAPI v2 allows for rich seamless interaction between Sovtes platform and your ERP/CRM system via HTTP.\n\n## Before you start\n\nTo start working with the API you must:\n\n1. have an account in the Sovtes application ([Create account...](https://sovtes.ua/w/#form))\n    \n2. check the section in the webapp UI: _My data / API_. All the necessary details are there.\n    \n\nThe {{host}} variables:\n\n- testing environment: [https://test.sovtes.ua](https://test.sovtes.ua)\n    \n- production environment: [https://sovtes.ua](https://sovtes.uaLanguages)\n    \n\nLanguages supported:\n\n1. Українська (ua)\n    \n2. English (en)\n    \n3. Deutsch (de)\n    \n4. Français (fr)\n    \n5. Eesti (et)\n    \n6. Polski (pl)\n    \n7. Slovenščina (sl)\n    \n8. Русский (ru)\n    \n\n## Legacy API documentation\n\n- version 0.9 (in Russian): [https://sovt.es/tDP](https://sovt.es/tDP)\n    \n- version 1.0m: [https://sovt.es/mknzv](https://sovt.es/mknzv)\n    \n- version 1.5: [https://sovt.es/dF5](https://sovt.es/dF5)\n    \n\n## Web hooks\n\nIf enabled by the admins and allowed by the contract, the system has the ability to send the events to a user-defined URL for web hooks about the events within the system. To set up the hooks, all you need to do is set up the URL in the API section in the system web UI, and pick the required events you want traced in the notification settings.\n\nThe body of the requests will contain the information about the event, and the route or tender involved, yet not the details of the event. In other words, if you receive a message within a route, you will receive a notification about the fact that a new message had been added, yet you will not receive the details of the message itself. For that, you would need to use our endpoints to get the detailed information.\n\nExample of the request you would receive in your URL:\n\n``` json\n{\n  \"body\": {\n    \"moment\": \"2025-05-10 19:15:04\",\n    \"event\": 12,\n    \"message\": \"Attention! New message received in route #12345-05-25 (Ukraine -> Germany). Read the important message.\",\n    \"route\": {\n      \"periodic\": \"12345-05-25\",\n      \"apicode\": \"880-19100-052025\",\n      \"guiurl\": \"https://sovtes.ua/a/index.php?p=view&id=12345-05-25&m=shipping\",\n      \"apiurl\": \"https://sovtes.ua/a/v2/rest/public/singleRoute?route=12345-05-25\"\n    }\n  },\n  \"signature\": \"d0c80fc9279b63f93a5b03g1d8a833de719f5766b30aad718ac58a39bbfa63c7\"\n}\n\n ```\n\n- `body.moment` is in the timezone of the application (defaults to Europe/Kyiv)\n    \n- `body.event` is the id of the event (see [full description of events](https://sovt.es/data-mapping))\n    \n- `body.message` will contain the actual event text description\n    \n- `body.route` will contain the details of the linked route/tender, with the periodic number within Sovtes, your internal id, a URL to access the route/tender in the web UI, and the endpoint to get the details of the route by this REST API\n    \n- `signature` param will contain a SHA256 MAC signature of the value of the entire `body` param with the key indicated in your account in the API section as \"MAC key\". Make sure you to verify the signature on your end to ensure message integrity.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1387425","team":1011257,"collectionId":"1f6bf01f-a106-4deb-a284-eb781e99e155","publishedId":"TVem9oaa","public":true,"publicUrl":"https://apidocs.sovtes.ua","privateUrl":"https://go.postman.co/documentation/1387425-1f6bf01f-a106-4deb-a284-eb781e99e155","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-10-04T22:32:49.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/c5cd3951733280c743f6a9fa98db279b6db6e28198c36ba16931315b328a2e90","favicon":"https://sovtes.ua/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://apidocs.sovtes.ua/view/metadata/TVem9oaa"}