The requests to API are an HTTP POST or HTTP GET, the body contains a JSON string or URL query. The response is also in a JSON format.
\nAPI Base URLs
Environment Description
Testkl
Production https://api1.inout.bg/api/v1/
The API token is used to all requests in the header with keyword “Bearer” before the token - e.g. Authorization: Bearer \"API Token - on request\"
\nHow to use any web service:
\nWeb Service Url: BASE_URL/API Endpoint
Example for test environment: https://test-api.inout.bg/api/v1/get-countries
Example for production environment: https://api1.inout.bg/api/v1/get-countries
We can now offer you the ability to ask for a shipment creation directly from your company’s software or website by taking advantage of \"Shipment Creation\".
\nRequirements
\nMethod: POST
Authorization: Bearer API_TOKEN
API Call Input Fields
Body (JSON)
API Response (Output Fields)
\nExample:
\n{\n \"awb\": 7000008793166,\n \"barcode\": \"7000008793166001F4348\",\n \"returnLabelNumber\": \"\",\n \"packagesBarcodes\": [\n \"7000008793166001F4348\",\n \"7000008793166002F4348\",\n \"7000008793166003F4348\",\n \"7000008793166004F4348\",\n \"7000008793166005F4348\",\n \"7000008793166006F4348\",\n \"7000008793166007F4348\"\n ]\n}\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","createAWB"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"514bf6b0-5805-4538-955b-865d3bbb9320"},{"name":"Shipment_Creation_Web_Service_v1.5 Pallet","id":"f1564d93-2826-4fee-841b-0402551be0d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask for a shipment creation directly from your company’s software or website by taking advantage of \"Shipment Creation\".
\nRequirements
\nMethod: POST
Authorization: Bearer API_TOKEN
API Call Input Fields
Body (JSON)
API Response (Output Fields)
\nExample:
\n{\n \"awb\": \"1507023066\",\n \"barcode\": \"\"\n}\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","createAWB"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"f1564d93-2826-4fee-841b-0402551be0d6"},{"name":"Shipment_Creation_Web_Service_v1.3-NON-EU","id":"0d9826c8-93db-48fc-813f-a128dd223c02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask for a shipment creation directly from your company’s software or website by taking advantage of \"Shipment Creation\".
\nRequirements
\nMethod: POST
Authorization: Bearer API_TOKEN
API Call Input Fields
Body (JSON)
API Response (Output Fields)
\nExample:
\n{\n \"awb\": \"1507023066\",\n \"barcode\": \"\"\n}\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","createAWB"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"0d9826c8-93db-48fc-813f-a128dd223c02"},{"name":"Pickup_AWB_Creation_Web_Service-v1.0","id":"afa63781-0182-4cf0-89aa-b1c45ede5ac7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to a pick up request for a shipment directly from your company’s software or website by taking advantage of \"Shipment Creation\".
\nRequirements
\nMethod: POST
Authorization: Bearer API_TOKEN
API Call Input Fields
Body (JSON)
Success API Response (Output Fields)
\nExample:
\n{\n \"pickupAWBNumber\": \"3169951776\"\n}\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","awb","pickup"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"afa63781-0182-4cf0-89aa-b1c45ede5ac7"},{"name":"PDF_Web_Service_v1.2","id":"4d9a884e-528e-4a01-a3d6-0621b765f73c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask for a pdf file directly from your company’s software or website by taking advantage of \"PDF Web Service\".
\nRequirements:
\nMethod: GET
Authorization: Bearer API_TOKEN
API Call Input Fields
URL query parameters
Example:
https://api1.inout.bg/api/v1/print/64506083?testMode=0
API Response (Output Fields)
\nExample:
\n{\n \"type\": \"PDF\",\n \"awb_print\": base64 encoded pdf\n}\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","print","{AWBnumber}"],"host":["api1","inout","bg"],"query":[{"key":"testMode","value":"0"}],"variable":[]}},"response":[],"_postman_id":"4d9a884e-528e-4a01-a3d6-0621b765f73c"},{"name":"Waybills_History_Web_Service-v1.0","id":"95f11446-a09e-45fd-b480-a72d12540c51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to get the statuses history by AWB number from your company’s software or website by taking advantage of \"AWB History Web Service\".
\nRequirements
\nMethod: POST****Authorization: Bearer API_TOKENAPI Call Input FieldsBody (JSON)
\nExample:
\n{\n \"testMode\": 0,\n \"awbs\": [\n {\n \"awb\": \"321654987456\"\n }, \n {\n \"awb\": \"321654123456\"\n },\n {\n \"awb\": \"987654321\"\n },\n {\n \"awb\": \"654321897654\"\n }\n ]\n}\n\nAPI Response (Output Fields)
\nList with the statuses:
\n**
StatusesHistory (Data Structure)**
Example:
\n[\n {\n \"refNum\": \"5420122\",\n \"awb\": null,\n \"error\": null,\n \"errorCode\": null,\n \"statusesHistory\": [\n {\n \"ID\": 26332,\n \"STATUS\": \"Information received\",\n \"DATE\": \"2020-03-06 10:47:18\",\n \"DATE_CREATED\": \"2020-03-06 10:47:18\",\n \"COMMENT\": null\n }\n ]\n },\n {\n \"refNum\": \"21555\",\n \"awb\": \"00228876896\",\n \"error\": null,\n \"errorCode\": null,\n \"statusesHistory\": [\n {\n \"ID\": 26332,\n \"STATUS\": \"Information received\",\n \"DATE\": \"2020-03-06 10:47:18\",\n \"DATE_CREATED\": \"2020-03-06 10:47:18\",\n \"COMMENT\": null\n }\n ]\n },\n {\n \"refNum\": \"488\",\n \"awb\": null,\n \"error\": \"Not found waybill with specified reference number!\",\n \"errorCode\": 404,\n \"statusesHistory\": []\n },\n {\n \"refNum\": \"55555555555555555555\",\n \"awb\": null,\n \"error\": \"Not found waybill with specified reference number!\",\n \"errorCode\": 404,\n \"statusesHistory\": []\n }\n]\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","fulfilment","waybills-history"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"95f11446-a09e-45fd-b480-a72d12540c51"},{"name":"Shipment_Status_Web_Service_v1.1","id":"1413f560-2e74-44dd-844d-1b70dae3c8f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask for a last shipment status directly from your company’s software or website by taking advantage of \"Shipment Status Web Service\".
\nRequirements:
\nMethod: GET Authorization: Bearer API_TOKEN
API Call (Input Fields) URL query parameters
Example:
https://api1.inout.bg/api/v1/get-status/64506083?testMode=0
API Response (Output Fields)
\nExample:
\n{\n \"status\": \"Delivered\"\n}\n\nList with the statuses:
\nHTTP Errors
\n","urlObject":{"protocol":"https","path":["api","v1","get-status","{AWBNumber}"],"host":["api1","inout","bg"],"query":[{"key":"testMode","value":"0"}],"variable":[]}},"response":[],"_postman_id":"1413f560-2e74-44dd-844d-1b70dae3c8f9"},{"name":"Shipment_History_Web_Service_v1.4","id":"a0865ef6-3b84-493e-8462-a95c62fe0c62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask for a all shipment history directly from your company’s software or website by taking advantage of \"Shipment History Web Service\".
\nRequirements:
\nMethod: GET****Authorization: Bearer API_TOKENAPI Call Input FieldsURL query parameters
\nExample:
https://api1.inout.bg/api/v1/get-status/64506083?testMode=0&lang=EN
API Response (Output Fields)
\nExample:
\n{\n \"statusesHistory\": [\n {\n \"ID\": 2513944,\n \"STATUS\": \"New\",\n \"DATE\": \"2019-11-05 13:02:38\",\n \"DATE_CREATED\": \"2019-11-05 15:00:58\",\n \"COMMENT\": \"NEW\",\n \"PARTNER_VOUCHER\": null,\n \"NOTE_ID\": null,\n \"NOTE_CODE\": null\n },\n {\n \"ID\": 2515304,\n \"STATUS\": \"Warehouse Ruse\",\n \"DATE\": \"2019-11-05 16:54:14\",\n \"DATE_CREATED\": \"2019-11-05 16:54:14\",\n \"COMMENT\": null,\n \"PARTNER_VOUCHER\": null,\n \"NOTE_ID\": null,\n \"NOTE_CODE\": null\n },\n {\n \"ID\": 2516372,\n \"STATUS\": \"In transit\",\n \"DATE\": \"2019-11-05 18:01:06\",\n \"DATE_CREATED\": \"2019-11-05 18:01:06\",\n \"COMMENT\": \"ONROAD\",\n \"PARTNER_VOUCHER\": null,\n \"NOTE_ID\": null,\n \"NOTE_CODE\": null\n },\n {\n \"ID\": 2770453,\n \"STATUS\": \"In transit\",\n \"DATE\": \"2019-12-17 20:20:23\",\n \"DATE_CREATED\": \"2019-12-17 20:20:23\",\n \"COMMENT\": \"ONROAD - УГОВОРКА ЗА БЪДЕЩА ДОСТАВКА\",\n \"PARTNER_VOUCHER\": null,\n \"NOTE_ID\": 45,\n \"NOTE_CODE\": \"MF\"\n },\n {\n \"ID\": 2776573,\n \"STATUS\": \"In transit\",\n \"DATE\": \"2019-12-18 10:52:16\",\n \"DATE_CREATED\": \"2019-12-18 10:52:16\",\n \"COMMENT\": \"ONROAD - УГОВОРКА ЗА БЪДЕЩА ДОСТАВКА\",\n \"PARTNER_VOUCHER\": null,\n \"NOTE_ID\": 45,\n \"NOTE_CODE\": \"MF\"\n }\n ]\n}\n\nList with the statuses:
\nHTTP Errors
\n","urlObject":{"protocol":"https","path":["api","v1","get-status","history","{AWBNumber}"],"host":["api1","inout","bg"],"query":[{"key":"testMode","value":"0"},{"key":"lang","value":"EN"}],"variable":[]}},"response":[],"_postman_id":"a0865ef6-3b84-493e-8462-a95c62fe0c62"},{"name":"Shipment_Price_Web_Service_v1.1","id":"9db63c02-b918-4069-9ca0-6c46f19befd4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask for a shipment price directly from your company’s software or website by taking advantage of \"Shipment Price Web Service\".
\nRequirements
\nMethod: POSTAuthorization: Bearer API_TOKENAPI Call Input Fields****Body (JSON)
\nAPI Response (Output Fields)
\nExample:
\n \"price\": \"3.99\",\n \"pr_weight\": \"3.99\",\n \"pr_cod\": \"0.00\",\n \"pr_ins\": \"0.00\",\n \"pr_check\": \"0.00\",\n \"pr_ret\": \"0.00\",\n \"pr_fulfill\": \"0.00\",\n \"pr_sat_del\": \"0.00\",\n \"pr_sms\": \"0.0000\"\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","shipment-price"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"9db63c02-b918-4069-9ca0-6c46f19befd4"},{"name":"Shipment_Price_Web_Service_v1.1 Romania","id":"d8474b4f-60b0-47e7-9d90-fb5fea2ca3d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask for a shipment price directly from your company’s software or website by taking advantage of \"Shipment Price Web Service\".
\nRequirements
\nMethod: POSTAuthorization: Bearer API_TOKENAPI Call Input Fields****Body (JSON)
\nAPI Response (Output Fields)
\nExample:
\n \"price\": \"3.99\",\n \"pr_weight\": \"3.99\",\n \"pr_cod\": \"0.00\",\n \"pr_ins\": \"0.00\",\n \"pr_check\": \"0.00\",\n \"pr_ret\": \"0.00\",\n \"pr_fulfill\": \"0.00\",\n \"pr_sat_del\": \"0.00\",\n \"pr_sms\": \"0.0000\"\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","shipment-price"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"d8474b4f-60b0-47e7-9d90-fb5fea2ca3d6"}],"id":"6d53426f-ebca-48d2-aa5f-0092db75e4df","_postman_id":"6d53426f-ebca-48d2-aa5f-0092db75e4df","description":""},{"name":"Location Web Services","item":[{"name":"Cities_Suggestions_Web_Service_v1.0","id":"7c8c32a1-5134-44bd-8ded-8309c7044f1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask for cities suggestions directly from your company’s software or website by taking advantage of \"Cities Suggestions Web Service\".
Requirements:
Method: GETAuthorization: Bearer API_TOKENAPI Call Input Fields****URL query parameters
\nExamples:
\nBy zip code
https://api1.inout.bg/api/v1/get-cities/suggestions/2/700?testMode=0
By city name
https://api1.inout.bg/api/v1/get-cities/suggestions/2/рус?testMode=0
https://api1.inout.bg/api/v1/get-cities/suggestions/2/rus?testMode=0
Search by all fields (city name, postal code, county name, state + these fields on Latin)
https://api1.inout.bg/api/v1/get-cities/suggestions/2/рус?testMode=0&searchAllFields=1
Important: The web service returns only the first 50 results it finds. If what you are looking for is not found, change the search string.
\nAPI Response (Output Fields)
\nExample:
\n{\n \"suggestions\": [\n {\n \"COUNTRY_ID\": 2,\n \"COUNTY_ID\": null,\n \"ID\": 25558,\n \"POSTAL_CODE\": \"2742\",\n \"CITY_NAME_LOCAL\": \"Бучино\",\n \"CITY_NAME_EN\": \"Buchino\",\n \"COUNTY\": null,\n \"COUNTY_EN\": \"Blagoevgrad\",\n \"STATE\": null,\n \"STATE_EN\": null,\n \"CRE_FROM_API\": null\n },\n {\n \"COUNTRY_ID\": 2,\n \"COUNTY_ID\": null,\n \"ID\": 25560,\n \"POSTAL_CODE\": \"5380\",\n \"CITY_NAME_LOCAL\": \"Бучуковци\",\n \"CITY_NAME_EN\": \"Buchukovtsi\",\n \"COUNTY\": null,\n \"COUNTY_EN\": \"Gabrovo\",\n \"STATE\": null,\n \"STATE_EN\": null,\n \"CRE_FROM_API\": null\n },\n {\n \"COUNTRY_ID\": 2,\n \"COUNTY_ID\": null,\n \"ID\": 20189381,\n \"POSTAL_CODE\": \"2256\",\n \"CITY_NAME_LOCAL\": \"Бучин проход\",\n \"CITY_NAME_EN\": \"Buchin prohod\",\n \"COUNTY\": null,\n \"COUNTY_EN\": \"Sofia\",\n \"STATE\": null,\n \"STATE_EN\": null,\n \"CRE_FROM_API\": null\n }\n ]\n}\n\nHTTP Errors
\n","urlObject":{"protocol":"https","path":["api","v1","get-cities","suggestions","2","8290"],"host":["api1","inout","bg"],"query":[{"key":"testMode","value":"0"},{"key":"searchAllFields","value":"1"}],"variable":[]}},"response":[],"_postman_id":"7c8c32a1-5134-44bd-8ded-8309c7044f1c"},{"name":"Cities_Web_Service_v1.0","id":"6af9032e-b67f-4620-9a1e-8ccc85126432","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask for cities directly from your company’s software or website by taking advantage of \"Cities Web Service\".
\nRequirements
\nMethod: GET
Authorization: Bearer API_TOKEN
API Call Input Fields
URL query parameters
Example:
https://test-api.inout.bg/api/v1/get-cities/1?first=1&skip=0&paging=0 \n
API Response (Output Fields)
\nExample:
\n[\n {\n \"ID\": 24370,\n \"POSTAL_CODE\": \"1528\",\n \"CITY_NAME_LOCAL\": \"Абдовица\",\n \"CITY_NAME_EN\": null,\n \"COUNTY\": \"София\",\n \"COUNTY_ID\": null,\n \"COUNTY_EN\": null,\n \"MUNICIPALITY\": \"Столична\",\n \"STATE\": null,\n \"STATE_EN\": null,\n \"MANUAL_EDIT\": null\n },\n {\n \"ID\": 24372,\n \"POSTAL_CODE\": \"2932\",\n \"CITY_NAME_LOCAL\": \"Абланица\",\n \"CITY_NAME_EN\": \"Ablanitsa\",\n \"COUNTY\": \"Благоевград\",\n \"COUNTY_ID\": null,\n \"COUNTY_EN\": \"Blagoevgrad\",\n \"MUNICIPALITY\": \"Хаджидимово\",\n \"STATE\": null,\n \"STATE_EN\": null,\n \"MANUAL_EDIT\": null\n }\n]\n\nHTTP Errors
\n","urlObject":{"protocol":"https","path":["api","v1","get-cities","1"],"host":["api1","inout","bg"],"query":[{"key":"first","value":"1"},{"key":"skip","value":"0"},{"key":"paging","value":"0"}],"variable":[]}},"response":[],"_postman_id":"6af9032e-b67f-4620-9a1e-8ccc85126432"},{"name":"Counties_Romania_Web_Service_v1.0","id":"cc447c98-fc2d-4b57-8f97-294ac121c681","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask for counties of Romania directly from your company’s software or website by taking advantage of \"Counties Romania Web Service\".
\nRequirements:
\nMethod: GET****Authorization: Bearer API_TOKEN
\nExample:
https://api1.inout.bg/api/v1/get-counties/1
API Response (Output Fields)
\nExample*:
*
[\n {\n \"id\": 3,\n \"abr\": \"AB\",\n \"name\": \"Alba\"\n },\n {\n \"id\": 4,\n \"abr\": \"AR\",\n \"name\": \"Arad\"\n }\n]\n\nHTTP Errors
\n","urlObject":{"protocol":"https","path":["api","v1","get-counties","1"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"cc447c98-fc2d-4b57-8f97-294ac121c681"},{"name":"Countries_Web_Service_v1.0","id":"4de65d90-9514-4113-83ad-9da4be89c1c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask for countries directly from your company’s software or website by taking advantage of \"Countries Web Service\".
\nRequirements:
\nMethod: GET
Authorization: Bearer API_TOKEN
Example:https://api1.inout.bg/api/v1/get-countries
\nAPI Response (Output Fields)
\nExample:
\n[\n {\n \"ID\": 1,\n \"NAME\": \"Romania\",\n \"CYRILLIC_NAME\": \"Румъния\"\n },\n {\n \"ID\": 2,\n \"NAME\": \"Bulgaria\",\n \"CYRILLIC_NAME\": \"България\"\n },\n {\n \"ID\": 3,\n \"NAME\": \"Hungary\",\n \"CYRILLIC_NAME\": \"Унгария\"\n }\n]\n\nHTTP Errors
\n","urlObject":{"protocol":"https","path":["api","v1","get-countries"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"4de65d90-9514-4113-83ad-9da4be89c1c6"},{"name":"Courier_Offices_Web_Service_v1.2","event":[{"listen":"prerequest","script":{"id":"528d312e-8733-49bb-ad81-61e3f703e87b","exec":[""],"type":"text/javascript"}}],"id":"5e41fec5-745a-427c-9ad5-5869a9ff2a91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask for courier offices directly from your company’s software or website by taking advantage of \"Courier Offices Web Service\".
\nRequirements:
\nMethod: GET
Authorization: Bearer API_TOKEN
Example:
\nhttps://api1.inout.bg/api/v1/offices-by-courier/15
\nAPI Response (Output Fields)
\nExample:
\n[\n {\n \"ID\": 1297,\n \"CITY_ID\": 24392,\n \"COURIER_ID\": 15,\n \"COURIER_OFFICE_ID\": 1053,\n \"OFFICE_NAME\": \"Айдемир\",\n \"COURIER_OFFICE_CODE\": \"7538\",\n \"CITY_NAME\": \"Айдемир\",\n \"ADDRESS\": \"Айдемир кв. Деленките ул. София №7\",\n \"LATITUDE\": \"44.1009192550187000\",\n \"LONGITUDE\": \"27.1950400265455000\",\n \"WORK_END\": \"18:00:00\",\n \"WORK_BEGIN\": \"09:00:00\",\n \"WORK_BEGIN_SATURDAY\": \"09:00:00\",\n \"WORK_END_SATURDAY\": \"15:00:00\",\n \"GROUP_CITY_ID\": 24392,\n \"POST_CODE\": \"7538\",\n \"REGION\": \"Силистра\"\n },\n {\n \"ID\": 1298,\n \"CITY_ID\": 24396,\n \"COURIER_ID\": 15,\n \"COURIER_OFFICE_ID\": 133,\n \"OFFICE_NAME\": \"Айтос Автогара\",\n \"COURIER_OFFICE_CODE\": \"8501\",\n \"CITY_NAME\": \"Айтос\",\n \"ADDRESS\": \"Айтос ул. Хаджи Димитър №31\",\n \"LATITUDE\": \"42.7066729507548500\",\n \"LONGITUDE\": \"27.2505099280334600\",\n \"WORK_END\": \"18:00:00\",\n \"WORK_BEGIN\": \"09:00:00\",\n \"WORK_BEGIN_SATURDAY\": \"09:00:00\",\n \"WORK_END_SATURDAY\": \"15:00:00\",\n \"GROUP_CITY_ID\": 24396,\n \"POST_CODE\": \"8500\",\n \"REGION\": \"Бургас\"\n },\n]\n\nHTTP Errors
\n","urlObject":{"protocol":"https","path":["api","v1","offices-by-courier","{courierId}"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"5e41fec5-745a-427c-9ad5-5869a9ff2a91"}],"id":"c7752740-4a95-4806-b094-25428f6f83ff","_postman_id":"c7752740-4a95-4806-b094-25428f6f83ff","description":""},{"name":"Fulfilment documentation","item":[{"name":"Order_Creation_Web_Service-v1.2","id":"80425df5-1657-4670-8652-2e8fd17989e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask order creation from your company’s software or website by taking advantage of \"Order Creation Web Service\".
\nRequirements
\nMethod: POST
Authorization: Bearer API_TOKEN
Body (JSON)
API Call Input Fields
*_Important!!!
*_You can upload orders only if the products from the orders are available (there is enought stock) in euShipments warehouse
API Response (Output Fields)
\nExample:
\n{\n \"orderId\": 745770,\n \"error\": false,\n \"code\": 200\n}\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","fulfilment","create-order"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"80425df5-1657-4670-8652-2e8fd17989e0"},{"name":"Attach_PDF_Files_Web_Service-v1.0","id":"da39c835-e560-43b0-bdf1-4532d76ba0b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to attach PDF file (invoice) from your company’s software or website by taking advantage of \"Attach PDF Files Web Service\".
\nRequirements
\nMethod: POST
Authorization: Bearer API_TOKEN
API Call Input Fields
Body (JSON)
API Response (Output Fields)
\nExample:
\n{\n \"testMode\": \"false\",\n \"orderId\": \"null\",\n \"referenceNumber\": \"0000026\",\n \"files\": [\n {\n \"base64Attached\": \"base64 string\"\n }\n ]\n}\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","fulfilment","attach-pdf-files"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"da39c835-e560-43b0-bdf1-4532d76ba0b0"},{"name":"Orders_History_Web_Service-v1.0","id":"4c9d4869-381e-4ce1-94bd-677b76bd947b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to statuses history by order data from your company’s software or website by taking advantage of \"Orders History Web Service\".
\nRequirements
\nMethod: POST****Authorization: Bearer API_TOKENAPI Call Input FieldsBody (JSON)
\nExample:
\n{\n \"testMode\": 0,\n \"orders\": [\n {\n \"refNum\": \"5420122\"\n }, \n {\n \"refNum\": \"21555\"\n },\n {\n \"refNum\": \"TEST488\"\n },\n {\n \"refNum\": \"55555555555555555555\"\n }\n ]\n}\n\nAPI Response (Output Fields)
\nList with the statuses:
\n**
StatusesHistory (Data Structure)**
Example:
\n[\n {\n \"refNum\": \"5420122\",\n \"awb\": null,\n \"error\": null,\n \"errorCode\": null,\n \"statusesHistory\": [\n {\n \"ID\": 26332,\n \"STATUS\": \"Information received\",\n \"DATE\": \"2020-03-06 10:47:18\",\n \"DATE_CREATED\": \"2020-03-06 10:47:18\",\n \"COMMENT\": null\n }\n ]\n },\n {\n \"refNum\": \"21555\",\n \"awb\": \"00228876896\",\n \"error\": null,\n \"errorCode\": null,\n \"statusesHistory\": [\n {\n \"ID\": 26332,\n \"STATUS\": \"Information received\",\n \"DATE\": \"2020-03-06 10:47:18\",\n \"DATE_CREATED\": \"2020-03-06 10:47:18\",\n \"COMMENT\": null\n }\n ]\n },\n {\n \"refNum\": \"TEST488\",\n \"awb\": null,\n \"error\": \"Not found order with specified reference number!\",\n \"errorCode\": 404,\n \"statusesHistory\": []\n },\n {\n \"refNum\": \"55555555555555555555\",\n \"awb\": null,\n \"error\": \"Not found order with specified reference number!\",\n \"errorCode\": 404,\n \"statusesHistory\": []\n }\n]\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","fulfilment","orders-history"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"4c9d4869-381e-4ce1-94bd-677b76bd947b"},{"name":"Product_Creation_Web_Service-v1.1","id":"397294d1-a87b-4a48-a9d9-6d7c3418a86b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask product creation from your company’s software or website by taking advantage of \"Product Creation Web Service\".
\nRequirements
\nMethod: POST
Authorization: Bearer API_TOKEN
API Call Input Fields
Body (JSON)
Example:
\n{\n \"testMode\": true,\n \"companyId\": 332,\n \"product\": {\n \"name\": \"test product\",\n \"barcode\": \"bb-test-54202\",\n \"refNumber\": \"ref-test-54202\",\n \"barcodeType\": \"EAN-13\",\n \"description\": \"test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test decsription test\",\n \"length\": 20.5,\n \"width\": 20.5,\n \"height\": 20.5,\n \"weight\": 2.2,\n \"hsCode\": \"640399.30.00\"\n }\n}\n\nAPI Response (Output Fields)
\nExample:
\n{\n \"productId\": 85,\n \"error\": false\n}\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","fulfilment","create-product"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"397294d1-a87b-4a48-a9d9-6d7c3418a86b"},{"name":"Booking_Request_Creation_Web_Service","id":"63d1df5a-a6bd-4080-84c6-0db02332331c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to create a booking request from your company’s software or website by taking advantage of \"Booking Request Creation Web Service\".
\nRequirements
\nMethod: POSTAuthorization: Bearer API_TOKENAPI Call Input Fields****Body (JSON)
\nExample:
\n{\n \"testMode\": true,\n \"companyId\": 332,\n \"warehouseId\": 1,\n \"products\": [\n {\n \"refNumber\": \"ref-test-54202\",\n \"quantity\": 10\n },\n {\n \"refNumber\": \"ref-test-54201\",\n \"quantity\": 100\n }\n ]\n}\n\nAPI Response (Output Fields)
\nExample:
\n{\n \"requestId\": 137\n}\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","fulfilment","create-request"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"63d1df5a-a6bd-4080-84c6-0db02332331c"},{"name":"Prod Avails","id":"9d650449-02c6-489e-9524-4440331742de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask order creation from your company’s software or website by taking advantage of \"Order Creation Web Service\".
\n","_postman_id":"aff54543-9f63-42ad-b615-d84c4337474f"},{"name":"Additional Web Services","item":[{"name":"COD_Information_Web_Service_v1.0","id":"98fa55d9-e957-425d-8987-4d0cbae513f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask for cod information directly from your company’s software or website by taking advantage of \"COD Information Web Service\".
\nDescription:\nWith this service, you can receive detailed COD information. In \"referenceNumber\" property, you can fill the value you filled in the \"referenceNumber\" when creating the AWB. The value can be an order number, a product number or an invoice number.
\nAPI Endpoint\n\"check-cod-by-order/{referenceNumber}\"
\nMethod: GET\nAuthorization: Bearer API_TOKEN
\nURL query parameters:\nfield - testMode\ntype - boolean\nrequired - yes\ndescription - If you want to use the API only for tests set this field to true. Applies only to the production environment. On the test environment, all shipments save on test env.
\nExample:\nhttps://api1.inout.bg/api/v1/check-cod-by-order/CCS-03207-CZ?testMode=0
\nResponse example:\n{\n \"awbNumber\": \"40695693257\",\n \"referenceNumber\": \"CCS-03207-CZ\",\n \"COD\": \"2310.00\",\n \"payedNumber\": 10793,\n \"payedDate\": \"2019-05-20 13:40:51\"\n}\nOutput Fields:\nawbNumber - AWB Number.\nreferenceNumber - The value that you filled when creating the AWB.\nCOD - COD amount in country currency.\npayedNumber - If is set, then you will see the number of the protocol that InOut made the payment.\npayedDate - The date on which the payment was made.
\nHTTP Errors:\nCode description\n200 - Returns result from the web service.\n400 - Bad request.\n401 - Unauthenticated. API expects a header like - 'Authorization: Bearer (api_token)'.\n404 - Not found data.\n500 - Internal Server Error / This action is unauthorized.
\n","urlObject":{"protocol":"https","path":["api","v1","check-cod-by-order","123"],"host":["api1","inout","bg"],"query":[{"key":"testMode","value":"0"}],"variable":[]}},"response":[],"_postman_id":"98fa55d9-e957-425d-8987-4d0cbae513f0"},{"name":"Phone_Call_History_Web_Service_v1.0","id":"e3848856-7781-4033-8fa4-fb694f567697","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask for a phone call history directly from your company’s software or Website by taking advantage of \"Phone Call History Web Service\".
\nRequirements:
\nMethod: GET****Authorization: Bearer API_TOKEN
\nApi Call Input Fields****URL query parameters
\nAPI****Response (Output Fields)
\nExample:{\n \"actions\": [\n {\n \"ID\": 22083,\n \"ACTION\": \"Return to us\",\n \"COMMENT\": \"test\",\n \"Date\": \"2019-02-01 12:14:00\"\n },\n {\n \"ID\": 22084,\n \"ACTION\": \"Organise delivery\",\n \"COMMENT\": \"ttt\",\n \"Date\": \"2019-02-01 12:26:00\"\n },\n {\n \"ID\": 22094,\n \"ACTION\": \"Destroy it\",\n \"COMMENT\": \"test\",\n \"Date\": \"2019-02-01 15:34:00\"\n }\n ]\n}\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","check-actions","{AWBNumber}"],"host":["api1","inout","bg"],"query":[{"key":"testMode","value":"0"}],"variable":[]}},"response":[],"_postman_id":"e3848856-7781-4033-8fa4-fb694f567697"}],"id":"fa279dd1-e7f1-46f7-b459-930b1480e8e3","_postman_id":"fa279dd1-e7f1-46f7-b459-930b1480e8e3","description":""},{"name":"PreAWB","item":[{"name":"Pre_AWB_Creation_Web_Service-v1.0","id":"eb461f4c-5638-46ad-b535-e9ac97173981","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask for a shipment creation directly from your company’s software or website by taking advantage of \"Shipment Creation\".
\nRequirements
\nMethod: POST
Authorization: Bearer API_TOKEN
API Call Input Fields
Body (JSON)
API Response (Output Fields)
\nExample:
\n{\n \"awb\": \"00215858486\"\n}\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","preAWB"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"eb461f4c-5638-46ad-b535-e9ac97173981"},{"name":"Pre_AWB_Creation_INOUT_LABEL_Web_Service-v1.1","id":"c51766fb-49c6-4109-bb31-b8770475f169","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask for couriers directly from your company’s software or website by taking advantage of \"Couries Web Service\".
\nRequirements
\nMethod: GET****Authorization: Bearer API_TOKEN
\nExample:
https://api1.inout.bg/api/v1/couriers/333
API Response (Output Fields)
\nExample:
\n[\n {\n \"ID\": 738,\n \"NAME\": \"Hungary GLS New\",\n \"TO_OFFICE\": false,\n \"TO_ADDRESS\": true,\n \"COUNTRY\": \"Hungary\",\n \"CURRENCY\": \"HUF\"\n }\n]\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","couriers","{senderId}"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"07afb7f2-3347-4702-8836-cbbfe189e455"},{"name":"Companies_Web_Service_v1.0","id":"5f6055d7-be14-469a-afea-757ff1f5ad87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask for a AWB details directly from your company’s software or website by taking advantage of \"AWB Details Web Service\".
\nRequirements
\nMethod: GET****Authorization: Bearer API_TOKENAPI Call Input FieldsURL query parameters
\nExample:
\nhttps://api1.inout.bg/api/v1/get-awb/64506083?testMode=0
\nAPI Response (Output Fields)
\nExample:
\n{\n \"SENDER_ID\": 1362,\n \"REFERENCENUMBER\": \"185096-6608739-3\",\n \"WAYBILL_AVAILABLE_DATE\": \"2024-08-01 09:26:11\",\n \"RECIPIENT_NAME\": \"Faur Sergiu\",\n \"CITYNAME\": \"Ineu\",\n \"ZIPCODE\": \"315300\",\n \"STREET_NAME\": \"To office: easybox Republicii 3\",\n \"BUILDING_NUMBER\": \"0\",\n \"PHONE_NUMBER\": \"0743407779\",\n \"PARCELS\": 1,\n \"TOTAL_WEIGHT\": \"0.690\",\n \"DECLARED_VALUE\": \"0.00\",\n \"COD\": \"174.00\",\n \"PAYEDNUMBER\": 1000001682,\n \"PAYEDDATE\": \"2024-08-07 12:00:11\",\n \"CURRENCY\": \"RON\",\n \"OPEN_PACKAGE\": 0,\n \"AWB_STATUS\": \"New\",\n \"COMMENT\": null,\n \"PRICE\": \"6.00\"\n}\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","get-awb","64506083"],"host":["api1","inout","bg"],"query":[{"key":"testMode","value":"0"}],"variable":[]}},"response":[],"_postman_id":"63ddd4c4-23f3-4311-81e7-eee0cc200f54"}],"id":"98ae42aa-58b8-4e4d-8e93-e5a5460f77b7","description":"Romania all carriers - phone number without country phone prefix;
Czech Republic - country phone prefix +420 or 00420 + valid mobile number (9 digits);
Hungary - country phone prefix +36 or 036 + valid mobile number (9 digits);
Slovakia - country phone prefix +421 or 00421 + valid mobile number (9 digits);
Bulgaria - phone number without country phone prefix;
Greece - phone number without country phone prefix;
Poland - phone number without country phone prefix;
Croatia - country phone prefix +385 or 0385 + valid mobile number (9 digits).
1. You need to download the office nomenclature from https://api1.inout.bg/api/v1/offices-by-courier/{courierID}
\n2. The request to us needs to be submitted in one of the following ways:
2.1 In the \"streetName\" field, submit a keyword office+\"OFFICE_NAME\" from our nomenclature
2.2 In the \"streetName\" field, submit a keyword office+\"ADDRESS\" from our nomenclature
2.3 In the \"officeId\" field, submit \"ID\" from our nomenclature
Sample data for the points described above:
2.1.
\"recipient\": {
\"name\": \"Test User\",
\"countryIsoCode\": \"BG\",
\"cityId\": null,
\"region\": \"null\",
\"cityName\": \"Aidemir\",
\"zipCode\": \"7538\",
\"streetName\": \"office Aidemir\",
\"buildingNumber\": 0,
\"officeId\": null,
\"officeCode\": \"\",
\"addressText\": \"additional text, address test\",
\"contactPerson\": \"Test User\",
\"phoneNumber\": \"00889000000\",
\"email\": \"[22.com](https://mailto:22.com)\"
}
2.2
\n\"recipient\": {
\"name\": \"Test User\",
\"countryIsoCode\": \"BG\",
\"cityId\": null,
\"region\": \"null\",
\"cityName\": \"Aidemir\",
\"zipCode\": \"7538\",
\"streetName\": \"office Aidemir kv. Delenkite ul. Sofia №7\",
\"buildingNumber\": 0,
\"officeId\": null,
\"officeCode\": \"\",
\"addressText\": \"additional text, address test\",
\"contactPerson\": \"Test User\",
\"phoneNumber\": \"00889000000\",
\"email\": \"[22.com](https://mailto:22.com)\"
}
2.3
\n\"recipient\": {
\"name\": \"Test User\",
\"countryIsoCode\": \"BG\",
\"cityId\": null,
\"region\": \"null\",
\"cityName\": \"Aidemir\",
\"zipCode\": \"7538\",
\"streetName\": \"null\",
\"buildingNumber\": 0,
\"officeId\": 1297,
\"officeCode\": \"\",
\"addressText\": \"additional text, address test\",
\"contactPerson\": \"Test User\",
\"phoneNumber\": \"00889000000\",
\"email\": \"[22.com](https://mailto:22.com)\"
}