Welcome to the euShipments public API documentation.
\nThe requests to the API are HTTP GET or HTTP POST. For POST requests the body contains a JSON string; the response is always in JSON format.
\nAPI Base URLs
\nAuthorization
\nEvery request must include your API token in the Authorization header, with the keyword \"Bearer\" before the token:
\nAuthorization: Bearer <API_TOKEN>
The API token is provided on request by euShipments.
\nHow to use any web service
\nWeb Service URL: BASE_URL + API endpoint
\nExample for the test environment: https://test-api.inout.bg/api/v1/get-countries
\nExample for the production environment: https://api1.inout.bg/api/v1/get-countries
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"26992907","collectionId":"833ab547-d8ea-4a71-815f-bc3eb99182c8","publishedId":"2s93Y2S2Q8","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-04-19T13:31:14.000Z"},"item":[{"name":"AWB Creation","item":[{"name":"Shipment_Creation_Web_Service_v1.5","id":"514bf6b0-5805-4538-955b-865d3bbb9320","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\nAuthorization: Bearer API_TOKEN
\nExample URLs
\nAPI Call Input Fields\nBody (JSON)
\nrecipient
\nAddressing: send EITHER recipient.cityId OR recipient.countryIsoCode + recipient.cityName + (recipient.zipCode OR recipient.region).
\nawb
\nawb.document
\nawb.packages
\nOptional. If awb.packages (and awb.pallets) are omitted, the system creates one package per parcel with default dimensions 10 x 10 x 20 cm, and totalWeight is spread evenly across the parcels.
\nproducts (top-level array)
\nOptional. Declares the shipment content as structured items.
\nNote: for senders shipping with Econt or Speedy whose account is configured with a cash receipt, the sum of price x qty over all products must be equal to awb.bankRepayment (when the COD amount is greater than 0), otherwise the request is rejected with a validation error.
\nsender
\nOptional. Overrides the sender contact data printed on the label / sent to the courier.
\ninvoice
\ncourierRequest
\ncustomsData (legacy, non-EU destinations)
\nFor shipments to non-EU destinations a full structured customs declaration (customs_declaration block with products and exportData) can also be sent - see Shipment_Creation_Web_Service_v1.5-NON-EU for the complete field list.
\nreturnLabel
\nAPI Response (Output Fields)
\nOn success the service returns HTTP 200 with:
\nExample (3 parcels):
\n{\n \"awb\": 7000008793166,\n \"barcode\": \"7000008793166001F4348\",\n \"returnLabelNumber\": \"\",\n \"packagesBarcodes\": [\n \"7000008793166002F4348\",\n \"7000008793166003F4348\"\n ]\n}\n\nExample (single parcel):
\n{\n \"awb\": 7000008793166,\n \"barcode\": \"7000008793166001F4348\",\n \"returnLabelNumber\": \"\",\n \"packagesBarcodes\": []\n}\n\nOn error the response body has the shape:
\n{\n \"error\": \"error text\"\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\". This page describes the creation of PALLET shipments - the endpoint and validation are the same as Shipment_Creation_Web_Service_v1.5, with the pallet-specific fields highlighted below.
\nRequirements
\nMethod: POST\nAuthorization: Bearer API_TOKEN
\nExample URLs
\nPallet specifics
\nAPI Call Input Fields\nBody (JSON)
\nrecipient
\nAddressing: send EITHER recipient.cityId OR recipient.countryIsoCode + recipient.cityName + (recipient.zipCode OR recipient.region).
\nawb
\nawb.document
\nawb.packages
\nRecommended for pallet shipments - describe each pallet with its real dimensions. If awb.packages and awb.pallets are omitted, the system creates one package per parcel with default dimensions 10 x 10 x 20 cm, and totalWeight is spread evenly across the parcels.
\nproducts (top-level array)
\nOptional. Declares the shipment content as structured items.
\nNote: for senders shipping with Econt or Speedy whose account is configured with a cash receipt, the sum of price x qty over all products must be equal to awb.bankRepayment (when the COD amount is greater than 0), otherwise the request is rejected with a validation error.
\nsender
\nOptional. Overrides the sender contact data printed on the label / sent to the courier.
\ninvoice
\ncourierRequest
\ncustomsData (legacy, non-EU destinations)
\nFor shipments to non-EU destinations a full structured customs declaration (customs_declaration block with products and exportData) can also be sent - see Shipment_Creation_Web_Service_v1.5-NON-EU for the complete field list.
\nreturnLabel
\nAPI Response (Output Fields)
\nOn success the service returns HTTP 200 with:
\nExample:
\n{\n \"awb\": \"1507023066\",\n \"barcode\": \"1507023066001\",\n \"returnLabelNumber\": \"\",\n \"packagesBarcodes\": []\n}\n\nOn error the response body has the shape:
\n{\n \"error\": \"error text\"\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.5-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\". This page describes the creation of shipments to NON-EU destinations - the endpoint and validation are the same as Shipment_Creation_Web_Service_v1.5, plus the customs blocks described below.
\nRequirements
\nMethod: POST\nAuthorization: Bearer API_TOKEN
\nExample URLs
\nAPI Call Input Fields\nBody (JSON)
\nrecipient
\nAddressing: send EITHER recipient.cityId OR recipient.countryIsoCode + recipient.cityName + (recipient.zipCode OR recipient.region).
\nawb
\nawb.document
\nawb.packages
\nOptional. If awb.packages (and awb.pallets) are omitted, the system creates one package per parcel with default dimensions 10 x 10 x 20 cm, and totalWeight is spread evenly across the parcels.
\nproducts (top-level array)
\nOptional. Declares the shipment content as structured items.
\nNote: for senders shipping with Econt or Speedy whose account is configured with a cash receipt, the sum of price x qty over all products must be equal to awb.bankRepayment (when the COD amount is greater than 0), otherwise the request is rejected with a validation error.
\nsender
\nOptional. Overrides the sender contact data printed on the label / sent to the courier.
\ninvoice
\ncourierRequest
\ncustoms_declaration (structured customs declaration - recommended for non-EU destinations)
\nOptional block. When sent, all of its required sub-fields must be present. The declaration is stored together with the shipment and used for the export documents.
\ncustoms_declaration.products (array, at least 1 item)
\ncustoms_declaration.exportData
\nIf the customs_declaration data fails validation after the shipment is created, the API responds with HTTP 422 and an error message, so always check the response.
\ncustomsData (legacy customs block - still accepted)
\nreturnLabel
\nAPI Response (Output Fields)
\nOn success the service returns HTTP 200 with:
\nExample:
\n{\n \"awb\": \"1507023066\",\n \"barcode\": \"1507023066001\",\n \"returnLabelNumber\": \"\",\n \"packagesBarcodes\": []\n}\n\nOn error the response body has the shape:
\n{\n \"error\": \"error text\"\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 create a pickup request for a shipment directly from your company's software or website by taking advantage of \"Pickup AWB Creation\".
\nRequirements
\nMethod: POST\nAuthorization: Bearer API_TOKEN
\nExample URLs
\nAPI Call Input Fields\nBody (JSON)
\nsender
\nAddressing: send EITHER sender.cityId OR sender.countryIsoCode + sender.cityName + (sender.zipCode OR sender.region).
\nawb
\nawb.packages
\nOptional array.
\nAPI Response (Output Fields)
\nOn success the service returns HTTP 200 with:
\nExample:
\n{\n \"pickupAWBNumber\": \"3169951776\",\n \"id\": 12345678,\n \"lockerCode\": null\n}\n\nImportant: most runtime errors (courier rejection, duplicate reference number, partner API not responding, etc.) are returned with HTTP 200 and a body of the shape below. Always check the response body for an \"error\" key, even when the HTTP status is 200.
\n{\n \"error\": \"error text\"\n}\n\nValidation failures return HTTP 422.
\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 shipping label directly from your company's software or website by taking advantage of \"PDF Web Service\".
\nRequirements:
\nMethod: GET\nAuthorization: Bearer API_TOKEN
\nAPI Call Input Fields\nURL query parameters
\nNotes:
\nExample URLs:
\nTest: https://test-api.inout.bg/api/v1/print/64506083?testMode=1\nProduction: https://api1.inout.bg/api/v1/print/64506083?testMode=0
\nAPI Response (Output Fields)
\nExample (PDF):
\n{\n \"type\": \"PDF\",\n \"awb_print\": \"JVBERi0xLjQKJ... (base64 encoded PDF)\"\n}\n\nExample (ZPL, printFileType=3):
\n{\n \"type\": \"ZPL\",\n \"awb_print\": \"^XA^CI28... (raw ZPL string)\"\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 for a list of AWB numbers directly from your company's software or website by taking advantage of \"Waybills History Web Service\".
\nRequirements
\nMethod: POST\nAuthorization: Bearer API_TOKEN
\nAPI Call Input Fields\nBody (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\nExample URLs:
\nTest: https://test-api.inout.bg/api/v1/fulfilment/waybills-history\nProduction: https://api1.inout.bg/api/v1/fulfilment/waybills-history
\nAPI Response (Output Fields)
\nThe service returns an array with one entry per requested AWB, in the same order as the request.
\nStatusesHistory (Data Structure)
\nShipment statuses (current as of July 2026, generated from the live system):
\nExample:
\n[\n {\n \"refNum\": \"5420122\",\n \"awb\": \"00228876896\",\n \"newReturnNumber\": null,\n \"courierId\": 746,\n \"courierName\": \"InPost PL\",\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\": null,\n \"awb\": \"55555555555555555555\",\n \"error\": \"Not found waybill with the specified waybill number!\",\n \"errorCode\": 404,\n \"statusesHistory\": []\n }\n]\n\nNote: an AWB that does not exist in our DB or was not created with your API token is NOT an HTTP error - the request still returns HTTP 200 and the entry for that AWB contains the \"error\" and \"errorCode\" fields as shown above.
\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 the last shipment status directly from your company's software or website by taking advantage of \"Shipment Status Web Service\".
\nRequirements:
\nMethod: GET\nAuthorization: Bearer API_TOKEN
\nAPI Call Input Fields\nURL query parameters
\nExample URLs:
\nTest: https://test-api.inout.bg/api/v1/get-status/64506083?testMode=1\nProduction: https://api1.inout.bg/api/v1/get-status/64506083?testMode=0
\nAPI Response (Output Fields)
\nExample:
\n{\n \"status\": \"Delivered\"\n}\n\nSpecial value: if the AWB has been deleted/cancelled in our system, the service still responds with HTTP 200 and returns:
\n{\n \"status\": \"canceled/deleted\"\n}\n\nShipment statuses (current as of July 2026, generated from the live system):
\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 the full shipment history directly from your company's software or website by taking advantage of \"Shipment History Web Service\".
\nRequirements:
\nMethod: GET\nAuthorization: Bearer API_TOKEN
\nAPI Call Input Fields\nURL query parameters
\nExample URLs:
\nTest: https://test-api.inout.bg/api/v1/get-status/history/64506083?testMode=1&lang=EN\nProduction: https://api1.inout.bg/api/v1/get-status/history/64506083?testMode=0&lang=EN
\nAPI 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\nNotes:
\nShipment statuses (current as of July 2026, generated from the live system):
\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: POST\nAuthorization: Bearer API_TOKEN
\nAPI Call Input Fields\nBody (JSON)
\nExample:
\n{\n \"courierId\": 15,\n \"companyId\": 333,\n \"weight\": 1,\n \"codAmount\": 100,\n \"openPackage\": 0,\n \"insuranceAmount\": 0,\n \"returnDocs\": 2,\n \"saturdayDelivery\": 0,\n \"toOffice\": 1,\n \"currency\": \"BGN\"\n}\n\nExample URLs:
\nTest: https://test-api.inout.bg/api/v1/shipment-price\nProduction: https://api1.inout.bg/api/v1/shipment-price
\nAPI Response (Output Fields)
\nAll prices are returned in EUR, without VAT included.
\nExample:
\n{\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}\n\nImportant: if the price cannot be calculated due to an internal error, the service responds with HTTP 200 and ALL price fields equal to 0.00. Treat an all-zero response as \"no price available\" - do not use it as a real quote.
\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":"[DEPRECATED] 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":"This request is deprecated and kept only for backward compatibility.
\nThe city/county parameters shown here are accepted by the API but ignored by the price calculation - they never affected pricing (dead legacy code path). Use Shipment_Price_Web_Service_v1.1 instead - it covers Romania as well, plus the currently supported optional parameters (serviceId, fulfillqty, length/width/height, saturdayDelivery, currency).
We can now offer you the ability to delete an AWB directly from your company's software or website by taking advantage of \"AWB Deletion Web Service\".
\nDescription:\nWith this service, you can delete a shipment that you no longer need. When the courier supports remote cancellation, the AWB is also cancelled at the courier's side. The AWB is always removed from our system — a possible error from the courier's side does not block the deletion in our system (the courier error is logged on our side).
\nRequirements
\nMethod: DELETE\nAuthorization: Bearer API_TOKEN\nAPI Call Input Fields\nURL path parameters
\nExample:
\nTest - https://test-api.inout.bg/api/v1/delete/40695693257
\nProduction - https://api1.inout.bg/api/v1/delete/40695693257
\nAPI Response (Output Fields)
\nExample:
\n{\n \"success\": true,\n \"awb\": \"40695693257\",\n \"error\": null\n}\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","delete","40695693257"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"30fe80aa-3530-f194-67fc-05acfd03e6d2"},{"name":"Merged_Print_Web_Service-v1.0","id":"51abbef3-cce2-93ee-ac3c-c7cb18f6faf7","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to print several AWB labels as one merged PDF file directly from your company's software or website by taking advantage of \"Merged Print Web Service\".
\nDescription:\nWith this service, you can send a list of AWB numbers and receive one merged PDF file (Base64 encoded) with the labels of all of them, in the same order as in your request. AWB numbers that cannot be printed (not found, not yours, or with an invalid label file) do not fail the whole request - they are returned in the \"errorPrinting\" field and the rest of the labels are merged normally.
\nRequirements
\nMethod: POST\nAuthorization: Bearer API_TOKEN\nAPI Call Input Fields\nBody (JSON)
\nExample:
\nTest - https://test-api.inout.bg/api/v1/merged/print
\nProduction - https://api1.inout.bg/api/v1/merged/print
\n{\n \"numbers\": [\n \"40695693257\",\n \"40695693258\",\n \"40695693259\"\n ]\n}\n\nAPI Response (Output Fields)
\nExample:
\n{\n \"success\": true,\n \"message\": \"Success to print merged awb pdf file!\",\n \"errorPrinting\": {\n \"40695693259\": \"No found waybill\"\n },\n \"base64_pdf\": \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoK...\"\n}\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","merged","print"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"51abbef3-cce2-93ee-ac3c-c7cb18f6faf7"}],"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 offer you the ability to ask for city suggestions directly from your company's software or website by taking advantage of the \"Cities Suggestions Web Service\".
\nRequirements:
\nMethod: GET
\nAuthorization: Bearer API_TOKEN
\nAPI Call Input Fields
\nURL query parameters
\nExamples:
\nBy zip code\nhttps://api1.inout.bg/api/v1/get-cities/suggestions/2/700?testMode=0
\nBy city name\nhttps://api1.inout.bg/api/v1/get-cities/suggestions/2/рус?testMode=0\nhttps://api1.inout.bg/api/v1/get-cities/suggestions/2/rus?testMode=0
\nSearch by all fields (city name, postal code, county name, state + these fields in Latin characters)\nhttps://api1.inout.bg/api/v1/get-cities/suggestions/2/рус?testMode=0&searchAllFields=1
\nTest environment\nhttps://test-api.inout.bg/api/v1/get-cities/suggestions/2/рус?testMode=1
\nImportant: The web service returns only the first 50 results it finds. If what you are looking for is not in the result, refine the search string.
\nAPI Response (Output Fields)
\nExample:
\n{\n \"suggestions\": [\n {\n \"COUNTRY_ID\": 2,\n \"COUNTY_ID\": null,\n \"ID\": 32696,\n \"POSTAL_CODE\": \"7000\",\n \"CITY_NAME_LOCAL\": \"Русе\",\n \"CITY_NAME_EN\": \"Ruse\",\n \"COUNTY\": \"Русе\",\n \"COUNTY_EN\": \"Ruse\",\n \"STATE\": null,\n \"STATE_EN\": null,\n \"CRE_FROM_API\": null,\n \"RAPIDO_SITEID\": 512,\n \"LOCALITYID\": null\n },\n {\n \"COUNTRY_ID\": 2,\n \"COUNTY_ID\": null,\n \"ID\": 25731,\n \"POSTAL_CODE\": \"7040\",\n \"CITY_NAME_LOCAL\": \"Русокастро\",\n \"CITY_NAME_EN\": \"Rusokastro\",\n \"COUNTY\": \"Бургас\",\n \"COUNTY_EN\": \"Burgas\",\n \"STATE\": null,\n \"STATE_EN\": null,\n \"CRE_FROM_API\": null,\n \"RAPIDO_SITEID\": null,\n \"LOCALITYID\": null\n }\n ]\n}\n\nHTTP Errors
\nNote: Requests may be rate-limited at infrastructure level. Please use reasonable request rates and contact euShipments if you plan bulk usage.
\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 offer you the ability to ask for cities directly from your company's software or website by taking advantage of the \"Cities Web Service\".
\nRequirements
\nMethod: GET
\nAuthorization: Bearer API_TOKEN
\nAPI Call Input Fields
\nURL query parameters
\nExamples:
\nTest environment\nhttps://test-api.inout.bg/api/v1/get-cities/1?first=1&skip=0&paging=0
\nProduction environment\nhttps://api1.inout.bg/api/v1/get-cities/1?first=1&skip=0&paging=0
\nAPI 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 \"RAPIDO_SITEID\": 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 \"RAPIDO_SITEID\": 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 offer you the ability to ask for the counties of Romania directly from your company's software or website by taking advantage of the \"Counties Romania Web Service\".
\nRequirements:
\nMethod: GET
\nAuthorization: Bearer API_TOKEN
\nExamples:
\nTest environment\nhttps://test-api.inout.bg/api/v1/get-counties/1
\nProduction environment\nhttps://api1.inout.bg/api/v1/get-counties/1
\nAPI Response (Output Fields)
\nExample:
\n[\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 offer you the ability to ask for countries directly from your company's software or website by taking advantage of the \"Countries Web Service\".
\nRequirements:
\nMethod: GET
\nAuthorization: Bearer API_TOKEN
\nImportant: The returned list is specific to your account — it contains the countries covered by the couriers activated for your client account. If the list is empty, the service returns HTTP 404 with {\"error\":\"You do not have access to countries!\"} — in that case, please contact euShipments to activate couriers for your account.
\nExamples:
\nTest environment\nhttps://test-api.inout.bg/api/v1/get-countries
\nProduction environment\nhttps://api1.inout.bg/api/v1/get-countries
\nAPI Response (Output Fields)
\nExample:
\n[\n {\n \"ID\": 1,\n \"NAME\": \"Romania\",\n \"CYRILLIC_NAME\": \"Румъния\",\n \"ISO_CODE\": \"RO\"\n },\n {\n \"ID\": 2,\n \"NAME\": \"Bulgaria\",\n \"CYRILLIC_NAME\": \"България\",\n \"ISO_CODE\": \"BG\"\n },\n {\n \"ID\": 3,\n \"NAME\": \"Hungary\",\n \"CYRILLIC_NAME\": \"Унгария\",\n \"ISO_CODE\": \"HU\"\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 offer you the ability to ask for courier offices directly from your company's software or website by taking advantage of the \"Courier Offices Web Service\".
\nRequirements:
\nMethod: GET
\nAuthorization: Bearer API_TOKEN
\nAPI Call Input Fields
\nURL query parameters
\nWithout query parameters the service returns ALL offices of the courier in one response. For couriers with large office networks we recommend the paginated mode.
\nExamples:
\nAll offices (test environment)\nhttps://test-api.inout.bg/api/v1/offices-by-courier/15
\nAll offices (production environment)\nhttps://api1.inout.bg/api/v1/offices-by-courier/15
\nPaginated\nhttps://api1.inout.bg/api/v1/offices-by-courier/15?per_page=100&page=1
\nSingle office by ID\nhttps://api1.inout.bg/api/v1/offices-by-courier/15?id=1297
\nAPI Response (Output Fields)
\nExample (non-paginated / single office):
\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_BEGIN\": \"09:00:00\",\n \"WORK_END\": \"18: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 \"IS_STATION\": false,\n \"COD_SUPPORT\": true\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_BEGIN\": \"09:00:00\",\n \"WORK_END\": \"18: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 \"IS_STATION\": false,\n \"COD_SUPPORT\": true\n }\n]\n\nExample (paginated, per_page + page):
\n{\n \"offices\": [\n {\n \"ID\": 1297,\n \"CITY_ID\": 24392,\n \"COURIER_ID\": 15,\n \"...\": \"... same office fields as above ...\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 100,\n \"total\": 3456,\n \"last_page\": 35,\n \"from\": 1,\n \"to\": 100,\n \"has_more_pages\": true\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\nAuthorization: Bearer API_TOKEN\nBody (JSON)
\nExample URLs:
\nImportant!!!\nYou can upload orders only if the products from the orders are available (there is enough stock) in euShipments warehouse.
\nAPI Call Input Fields
\nAPI 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\nAuthorization: Bearer API_TOKEN\nBody (JSON)
\nExample URLs:
\nImportant!!!\nFiles can be attached only before the AWB is generated for the order. Once the order already has an AWB, the order is no longer found by this service and the request returns HTTP 422 (see below). Pre-AWB orders are also rejected with the error \"For specified order, you can not add documents!\".
\nAPI Call Input Fields
\nExample (request body):
\n{\n \"testMode\": false,\n \"orderId\": null,\n \"referenceNumber\": \"0000026\",\n \"files\": [\n {\n \"base64Attached\": \"base64 string\"\n }\n ]\n}\n\nAPI Response (Output Fields)
\nThe response is always a JSON array with one object per processed file:
\nExample (success):
\n[\n {\n \"error\": false,\n \"orderId\": 745770,\n \"referenceNumber\": \"0000026\",\n \"pdfId\": 1024,\n \"pdfCode\": \"5420122-333-1\",\n \"code\": 200\n }\n]\n\nExample (order not found — returned with HTTP status 422):
\n[\n {\n \"error\": \"Not found order with the specified number!\",\n \"orderId\": 123,\n \"referenceNumber\": \"0000026\",\n \"pdfId\": null,\n \"pdfCode\": null,\n \"code\": 422\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 receive statuses history by order data from your company's software or website by taking advantage of \"Orders History Web Service\".
\nRequirements
\nMethod: POST\nAuthorization: Bearer API_TOKEN\nBody (JSON)
\nExample URLs:
\nAPI Call Input Fields
\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)
\nThe response is a JSON array with one object per requested order:
\nShipment statuses (current as of July 2026, generated from the live system):
\nStatusesHistory (Data Structure)
\nExample:
\n[\n {\n \"refNum\": \"5420122\",\n \"awb\": null,\n \"newReturnNumber\": 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 \"PARTNER_VOUCHER\": null\n }\n ],\n \"items\": [\n {\n \"refNumber\": \"ref-test-54202\",\n \"sn\": null,\n \"qty\": 2\n }\n ]\n },\n {\n \"refNum\": \"21555\",\n \"awb\": \"00228876896\",\n \"newReturnNumber\": \"00228976899\",\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 \"PARTNER_VOUCHER\": null\n }\n ],\n \"items\": [\n {\n \"refNumber\": \"ref-test-54201\",\n \"sn\": \"SN0001234\",\n \"qty\": 1\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 \"items\": []\n },\n {\n \"refNum\": \"55555555555555555555\",\n \"awb\": null,\n \"error\": \"Not found order with specified reference number!\",\n \"errorCode\": 404,\n \"statusesHistory\": [],\n \"items\": []\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\nAuthorization: Bearer API_TOKEN\nBody (JSON)
\nExample URLs:
\nAPI Call Input Fields
\nImportant!\nThe barcode is checked across our entire system, not only among your own products. If the barcode you send is already used by another product (any company), the request is rejected with a 422 error (see below) and no product is created. The reference number (refNumber), on the other hand, is checked only within your own company: sending a refNumber that already exists for your company is also rejected with a 422 error, so resending the same create-product request never creates a duplicate product for the same company.\nIn the rare case a barcode passes the initial uniqueness check but still collides at database level (e.g. a race condition), the product is created anyway, just without a barcode attached.
\nExample:
\n{\n \"testMode\": true,\n \"companyId\": 332,\n \"product\": {\n \"name\": \"test product\",\n \"barcode\": \"bb-test-54202\",\n \"refNumber\": \"ref-test-54202\",\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-v1.0","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: POST\nAuthorization: Bearer API_TOKEN\nBody (JSON)
\nExample URLs:
\nAPI Call Input Fields
\nImportant!\nIf the same refNumber appears more than once in the products array, the duplicate lines are merged into a single line and their quantities are summed.
\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\nRelated service:\nOnce you have a requestId, you can poll its status with the companion \"Get Request Status\" service: GET /api/v1/fulfilment/get-request-status/{id} (a dedicated documentation page for this service is being added).
\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":"Product_Availability_Web_Service-v1.0","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 check your products' available quantities from your company's software or website by taking advantage of \"Product Availability Web Service\".
\nRequirements
\nMethod: GET\nAuthorization: Bearer API_TOKEN
\nExample URLs:
\nAPI Call Input Fields
\nThis service takes no input parameters. The results are automatically filtered to the companies linked to your API token.
\nAPI Response (Output Fields)
\nThe response is a JSON array with one row per product per warehouse.
\nExample:
\n[\n {\n \"AVAIL_DATE\": \"2026-07-08 06:00:00\",\n \"STORE_NAME\": \"Warehouse Ruse\",\n \"ART_NAME\": \"test product\",\n \"ART_LNG_DESC\": \"test product long description\",\n \"ART_SH_DESC\": \"test product\",\n \"CUST_NAME\": \"Test Company Ltd.\",\n \"REFERENCE_NUMBER\": \"ref-test-54202\",\n \"COURIER_ITEM_CODE\": \"12345\",\n \"AVAIL_QTY\": 87\n }\n]\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","fulfilment","get-prod-avails"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d650449-02c6-489e-9524-4440331742de"},{"name":"Order_Deletion_Web_Service-v1.0","id":"fdc6b6c0-ef37-1e71-78a8-25dab5f5f91b","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to delete a fulfilment order directly from your company's software or website by taking advantage of \"Order Deletion Web Service\".
\nDescription:\nWith this service, you can delete an order that has not been processed yet. An order can be deleted only while it is in one of the statuses Information received, Awaiting pickup or New, and only if it is not older than 14 days. Only orders belonging to your companies can be deleted.
\nRequirements
\nMethod: DELETE\nAuthorization: Bearer API_TOKEN\nAPI Call Input Fields\nURL path parameters
\nExample:
\nTest - https://test-api.inout.bg/api/v1/orders-delete/CCS-03207-CZ
\nProduction - https://api1.inout.bg/api/v1/orders-delete/CCS-03207-CZ
\nAlternative (by internal order id):
\nTest - https://test-api.inout.bg/api/v1/orders/137
\nProduction - https://api1.inout.bg/api/v1/orders/137
\nAPI Response (Output Fields)
\nExample (/orders-delete/{refNumber}):
\n{\n \"error\": false,\n \"message\": \"The order was deleted successfully.\",\n \"code\": 200\n}\n\nExample (/orders/{id}):
\n{\n \"error\": false,\n \"message\": \"The order was deleted successfully.\",\n \"result\": {\n \"ID\": 137,\n \"OP_OUR_STATUS_ID\": 20,\n \"OP_CUSTOMER_ID\": 332,\n \"ORDER_ID\": \"1005\",\n \"OP_WAYBILL_BG\": \"CCS-03207-CZ\",\n \"OP_DATE\": \"2026-07-01 10:15:00\"\n },\n \"code\": 200\n}\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","orders-delete","CCS-03207-CZ"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"fdc6b6c0-ef37-1e71-78a8-25dab5f5f91b"},{"name":"Product_List_Web_Service-v1.0","id":"fad334fa-9d84-65fc-02a7-822041b3477e","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to receive a list of all your products in our fulfilment system directly from your company's software or website by taking advantage of \"Product List Web Service\".
\nDescription:\nWith this service, you can receive all products registered in our fulfilment system for one of your companies. The products are the ones created via the \"Product Creation Web Service\" or in the client cabinet.
\nRequirements
\nMethod: GET\nAuthorization: Bearer API_TOKEN\nAPI Call Input Fields\nURL query parameters
\nExample:
\nTest - https://test-api.inout.bg/api/v1/fulfilment/get-products?companyId=332
\nProduction - https://api1.inout.bg/api/v1/fulfilment/get-products?companyId=332
\nAPI Response (Output Fields)
\nThe response is a JSON array of products. Each product contains:
\nExample:
\n[\n {\n \"ID\": 85,\n \"NAME\": \"test product\",\n \"DESCRIPTION\": \"test description\",\n \"LENGTH_ITEM\": \"20.50\",\n \"WIDTH\": \"20.50\",\n \"HEIGHT\": \"20.50\",\n \"WEIGHT\": \"2.20\",\n \"REFERENCE_NUMBER\": \"ref-test-54202\"\n },\n {\n \"ID\": 86,\n \"NAME\": \"test product 2\",\n \"DESCRIPTION\": null,\n \"LENGTH_ITEM\": \"10.00\",\n \"WIDTH\": \"15.00\",\n \"HEIGHT\": \"5.00\",\n \"WEIGHT\": \"0.50\",\n \"REFERENCE_NUMBER\": \"ref-test-54201\"\n }\n]\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","fulfilment","get-products"],"host":["api1","inout","bg"],"query":[{"key":"companyId","value":"332"}],"variable":[]}},"response":[],"_postman_id":"fad334fa-9d84-65fc-02a7-822041b3477e"},{"name":"Request_Status_Web_Service-v1.0","id":"d83611df-0c55-42f2-4ded-da7f44d3387d","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to check the status of a booking request directly from your company's software or website by taking advantage of \"Request Status Web Service\".
\nDescription:\nWith this service, you can check whether a booking request, created via the \"Booking Request Creation Web Service\", has already been accepted (confirmed) at our warehouse. In the \"id\" parameter, fill the \"requestId\" value you received when creating the booking request.
\nRequirements
\nMethod: GET\nAuthorization: Bearer API_TOKEN\nAPI Call Input Fields\nURL path parameters
\nExample:
\nTest - https://test-api.inout.bg/api/v1/fulfilment/get-request-status/137
\nProduction - https://api1.inout.bg/api/v1/fulfilment/get-request-status/137
\nAPI Response (Output Fields)
\nExample (confirmed Request):
\n{\n \"accepted\": true,\n \"date\": \"2026-07-01 10:15:33\"\n}\n\nExample (not confirmed yet):
\n{\n \"accepted\": false\n}\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","fulfilment","get-request-status","137"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"d83611df-0c55-42f2-4ded-da7f44d3387d"},{"name":"Booking_Request_Status_Web_Service-v1.0","id":"937bfe5d-fa25-f6d3-8fb5-c19bf224cc62","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to receive detailed information about a booking request directly from your company's software or website by taking advantage of \"Booking Request Status Web Service\".
\nDescription:\nWith this service, you can receive the full lifecycle of a booking request (created, received at the warehouse, closed/confirmed, deleted) together with a product-by-product breakdown of the booked and accepted quantities. In the \"bookingId\" parameter, fill the \"requestId\" value you received when creating the booking request via the \"Booking Request Creation Web Service\".
\nRequirements
\nMethod: POST\nAuthorization: Bearer API_TOKEN\nAPI Call Input Fields\nBody (JSON)
\nExample:
\nTest - https://test-api.inout.bg/api/v1/fulfilment/booking-request-status
\nProduction - https://api1.inout.bg/api/v1/fulfilment/booking-request-status
\n{\n \"companyId\": 332,\n \"bookingId\": 137\n}\n\nAPI Response (Output Fields)
\nExample:
\n{\n \"bookingId\": 137,\n \"statuses\": {\n \"created\": \"2026-06-25 09:41:12\",\n \"received\": \"2026-06-27 14:02:55\",\n \"closed\": \"2026-06-28 10:15:33\",\n \"deleted\": null\n },\n \"products\": [\n {\n \"name\": \"test product\",\n \"referenceNumber\": \"ref-test-54202\",\n \"booked\": 10,\n \"accepted\": 10,\n \"comment\": null\n },\n {\n \"name\": \"test product 2\",\n \"referenceNumber\": \"ref-test-54201\",\n \"booked\": 100,\n \"accepted\": 98,\n \"comment\": \"2 damaged items\"\n }\n ]\n}\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","fulfilment","booking-request-status"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"937bfe5d-fa25-f6d3-8fb5-c19bf224cc62"},{"name":"Transfer_Creation_Web_Service-v1.0","id":"f8261a6b-c858-264d-42ed-b6ea6dd7d569","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to create a warehouse transfer protocol from your company's software or website by taking advantage of \"Transfer Creation Web Service\".
\nRequirements
\nMethod: POST\nAuthorization: Bearer API_TOKEN\nBody (JSON)
\nExample URLs:
\nAPI Call Input Fields
\nImportant!\nThe protocol date is never taken from the request — the server always sets it to today's date.\nEvery row is validated (product belongs to the company, item-level stock, per-batch stock) before anything is written — if any single row fails, nothing is persisted (all-or-nothing).\nThe starting status of the protocol depends on your token's access type: cabinet/client tokens start it at STATUS_CABINET_WAITING (skipping the UI draft step, since the API sends a complete protocol); partner and admin tokens start it with no status set, following the normal manual flow.\nSending the same externalRef again does not create a second protocol — the existing one (including a since-deleted one) is returned with a 409, so retries are always safe.
\nExample:
\n{\n \"testMode\": true,\n \"companyId\": 1075,\n \"sourceWarehouseId\": 4,\n \"destinationWarehouseId\": 7,\n \"protocolType\": 1,\n \"needCheck\": false,\n \"comments\": \"Transfer to Sofia\",\n \"receiver\": \"Store unit 2\",\n \"waybill\": null,\n \"instructions\": null,\n \"externalRef\": \"ERP-TRX-000123\",\n \"items\": [\n { \"refNumber\": \"4480541734500\", \"quantity\": 1 },\n { \"barcode\": \"449061657\", \"quantity\": 1, \"batchNo\": \"TRTEST01\", \"batchDate\": \"2028-10-31\" },\n { \"refNumber\": \"449067544700\", \"barcode\": \"4490675447\", \"quantity\": 1, \"batchNo\": \"TR3TEST01\", \"batchDate\": \"2028-05-31\" }\n ]\n}\n\nAPI Response (Output Fields)
\nExample:
\n{\n \"protocolId\": 98765,\n \"isConfirmed\": null,\n \"protocolType\": 1,\n \"itemsCreated\": 2,\n \"items\": [\n { \"refNumber\": \"4480541734500\", \"quantity\": 1, \"batchId\": null },\n { \"barcode\": \"449061657\", \"quantity\": 1, \"batchId\": 3979 }\n ],\n \"error\": false\n}\n\nDuplicate request (idempotency) — HTTP 409:\nReturned when the same externalRef already exists for this companyId (including a soft-deleted protocol, in which case isDeleted is true). No new protocol is created — the existing one is returned instead.
\n{\n \"error\": \"DUPLICATE_EXTERNAL_REF\",\n \"protocolId\": 98765,\n \"isConfirmed\": null,\n \"protocolType\": 1,\n \"externalRef\": \"ERP-TRX-000123\",\n \"isDeleted\": false\n}\n\nValidation error — HTTP 422:\nNothing is persisted (all-or-nothing). Structural/request-level problems come back under messages; per-row problems under itemErrors.
{\n \"error\": \"VALIDATION_FAILED\",\n \"messages\": [ \"destination warehouse must differ from source\" ],\n \"itemErrors\": [\n { \"index\": 0, \"refNumber\": \"4480541734500\", \"error\": \"INSUFFICIENT_QUANTITY\", \"available\": 8, \"requested\": 12 },\n { \"index\": 1, \"barcode\": \"449061657\", \"error\": \"PRODUCT_NOT_FOUND_FOR_CUSTOMER\" }\n ]\n}\n\nPer-row error codes (itemErrors[].error): PRODUCT_NOT_FOUND_FOR_CUSTOMER (no product with that refNumber/barcode belongs to companyId), INSUFFICIENT_QUANTITY (requested qty exceeds item-level availability; includes available + requested), INSUFFICIENT_BATCH_QUANTITY (requested qty exceeds per-batch stock in the source warehouse, or the batch doesn't exist; includes available + requested).
Structural codes/messages (messages[]): INVALID_QUANTITY (quantity missing/zero/fractional/non-numeric), BATCH_INCOMPLETE (batchNo without batchDate or vice versa), PROTOCOL_TYPE_NOT_ALLOWED (protocolType=2 requested by a non-admin token), \"destination warehouse must differ from source\", \"company not accessible for this token\".
HTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","fulfilment","create-transfer"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"f8261a6b-c858-264d-42ed-b6ea6dd7d569"}],"id":"aff54543-9f63-42ad-b615-d84c4337474f","description":"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\".
\nWith this service, you can receive detailed COD information. In the \"referenceNumber\" URL segment, fill the value you sent in \"referenceNumber\" when creating the AWB. The value can be an order number, a product number or an invoice number.
\nRequirements
\nMethod: GET\nAuthorization: Bearer API_TOKEN
\nAPI Call Input Fields\nURL query parameters
\nExample URLs:
\nTest: https://test-api.inout.bg/api/v1/check-cod-by-order/CCS-03207-CZ?testMode=1\nProduction: https://api1.inout.bg/api/v1/check-cod-by-order/CCS-03207-CZ?testMode=0
\nAPI Response (Output Fields)
\nExample:
\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}\n\nImportant - not-found behavior: if no shipment matches the reference number, or the shipment was not created with your API token, the service does NOT return an HTTP error. It responds with HTTP 200 and an empty (null) body. Always check that the response body actually contains data before processing it.
\nNote: \"payedNumber\" and \"payedDate\" are null while the COD has not yet been paid out. A response with these two fields set to null therefore means \"COD collected/registered but not paid out yet\", not an error.
\nHTTP Errors:
\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\nAuthorization: Bearer API_TOKEN
\nAPI Call Input Fields\nURL query parameters
\nExample URLs:
\nTest: https://test-api.inout.bg/api/v1/check-actions/64506083?testMode=1\nProduction: https://api1.inout.bg/api/v1/check-actions/64506083?testMode=0
\nAPI Response (Output Fields)
\nPossible ACTION values:
\nExample:
\n{\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\nImportant - \"no actions\" behavior: if the AWB exists but has no phone call actions, the service responds with HTTP 200 and the following body (there is no \"actions\" field in this case):
\n{\n \"error\": \"Not found actions to specified AWB!\"\n}\n\nDo not rely only on the HTTP status code - always check whether the response body contains \"actions\" or \"error\".
\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":"Pre AWB Creation lets you register an order in the euShipments system without creating a courier waybill yet. No AWB/tracking number is generated at this step - the order is queued internally and a courier shipment is created for it later (in the euShipments back office or via a subsequent process). Use this when you want to reserve/queue an order before the courier waybill itself is needed.
\nPrecondition: the Pre AWB service must be activated for your company in euShipments. If it isn't, every call fails with an \"unauthorized\" error - contact your euShipments account manager to have it enabled for your senderId.
\nRequirements
\nMethod: POST\nAuthorization: Bearer API_TOKEN
\nExample URLs
\nAPI Call Input Fields\nBody (JSON)
\nrecipient
\nAddressing rules (all three apply independently - read carefully, they differ from the createAWB endpoint):
\nawb
\nawb.packages
\nOptional array.
\nproducts (top-level array)
\nOptional, and only lightly validated on this endpoint (only qty is checked - refNumber/price are not). For richer product data, prefer awb.products / awb.productsInfo above.
\nNot supported on this endpoint: unlike createAWB, Pre AWB does not accept/validate awb.document, sender, invoice, customsData, customs_declaration, courierRequest, returnLabel, courierReturnAWB or warehouseInfo. Sending them has no effect - configure those aspects on the real shipment once it is created from the order.
\nAPI Response (Output Fields)
\nOn success the service returns HTTP 201 with:
\nExample:
\n{\n \"orderId\": 4815162,\n \"error\": false,\n \"code\": 201\n}\n\nOn a business/processing error (e.g. the order could not be created for a reason surfaced after your input passed validation), the response has this shape, with the HTTP status equal to the code value:
\n{\n \"orderId\": null,\n \"inoutLabelNum\": null,\n \"error\": \"error text\",\n \"code\": 422\n}\n\nOn a plain input-validation error (a required field missing, a value failing the rules in the tables above), the response is the simpler shape used across the API, with HTTP 400:
\n{\n \"error\": \"error text\"\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":"This is the same endpoint and validation as Pre_AWB_Creation_Web_Service-v1.0 (it creates an order in euShipments without a courier waybill yet). This page highlights the additional awb.generateInoutLabelNum flag: when sent as true, the order also gets an internal 17-digit INOUT label number that you can print immediately via Pre_AWB_INOUT_LABEL_Web_Service_v1.0 / Pre_AWB_INOUT_LABEL_BY_NUM_Web_Service_v1.0, before any courier waybill exists for the order.
Precondition: the Pre AWB service must be activated for your company in euShipments. If it isn't, every call fails with an \"unauthorized\" error - contact your euShipments account manager to have it enabled for your senderId.
\nRequirements
\nMethod: POST\nAuthorization: Bearer API_TOKEN
\nExample URLs
\nAPI Call Input Fields\nBody (JSON)
\nAll fields are identical to Pre_AWB_Creation_Web_Service-v1.0 - see that page for the full field-by-field reference (testMode, senderId, courierId, serviceName, waybillAvailableDate, recipient., awb., awb.packages., products.). Only the extra flag is shown below.
\nReminder - addressing rules for recipient (same as the base endpoint):
\nAPI Response (Output Fields)
\nOn success the service returns HTTP 201 with:
\nExample:
\n{\n \"orderId\": 4815162,\n \"error\": false,\n \"code\": 201,\n \"inoutLabelNum\": \"33333330004815162\"\n}\n\nOn a business/processing error, the response follows the orderId/error/code shape, with the HTTP status equal to the code value, and inoutLabelNum always present as null:
\n{\n \"orderId\": null,\n \"inoutLabelNum\": null,\n \"error\": \"error text\",\n \"code\": 422\n}\n\nOn a plain input-validation error (a required field missing, a value failing the rules), the response is the simpler shape used across the API, with HTTP 400:
\n{\n \"error\": \"error text\"\n}\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","preAWB"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"c51766fb-49c6-4109-bb31-b8770475f169"},{"name":"Pre_AWB_INOUT_LABEL_Web_Service_v1.0","id":"04d12849-27f9-4f52-b202-d2a73d257e1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Prints (retrieves) the INOUT label for a pre-AWB order, identified by the order's internal orderId (the value returned by Pre_AWB_Creation_INOUT_LABEL_Web_Service-v1.1 in the orderId field, for an order that was created with awb.generateInoutLabelNum: true). No courier waybill needs to exist yet - this label is generated purely from the pre-AWB order data.
If you only have the 17-digit inoutLabelNum (not the internal orderId), use Pre_AWB_INOUT_LABEL_BY_NUM_Web_Service_v1.0 instead.
Requirements
\nMethod: GET\nAuthorization: Bearer API_TOKEN
\nExample URLs
\nAPI Call Input Fields\nPath parameter
\nQuery string
\nAPI Response (Output Fields)
\nOn success the service returns HTTP 200 with:
\nExample (PDF):
\n{\n \"type\": \"PDF\",\n \"awb_print\": \"JVBERi0xLjcKJcfsj6IKOCAwIG9iago8PC9MZW5ndGggOSAwIFIvRmlsdGVyIC9GbGF0ZURlY29kZT4+...\"\n}\n\nExample (ZPL):
\n{\n \"type\": \"ZPL\",\n \"awb_print\": \"^XA^FO50,50^A0N,40,40^FDTest label^FS^XZ\"\n}\n\nOn error:
\n{\n \"error\": \"error text\"\n}\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","preAWB","print","inout","label","{OrderId}"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"04d12849-27f9-4f52-b202-d2a73d257e1f"},{"name":"Pre_AWB_INOUT_LABEL_BY_NUM_Web_Service_v1.0","id":"b8522877-d382-4d06-bdd4-54eb406857b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Prints (retrieves) the INOUT label for a pre-AWB order, identified by the 17-digit inoutLabelNum itself (the value returned by Pre_AWB_Creation_INOUT_LABEL_Web_Service-v1.1 in the inoutLabelNum field, format 33333330#########, for an order that was created with awb.generateInoutLabelNum: true). No courier waybill needs to exist yet - this label is generated purely from the pre-AWB order data.
If you have the internal orderId instead of the label number, use Pre_AWB_INOUT_LABEL_Web_Service_v1.0 instead.
\nRequirements
\nMethod: GET\nAuthorization: Bearer API_TOKEN
\nExample URLs
\nAPI Call Input Fields\nPath parameter
\nQuery string
\nAPI Response (Output Fields)
\nOn success the service returns HTTP 200 with:
\nExample (PDF):
\n{\n \"type\": \"PDF\",\n \"awb_print\": \"JVBERi0xLjcKJcfsj6IKOCAwIG9iago8PC9MZW5ndGggOSAwIFIvRmlsdGVyIC9GbGF0ZURlY29kZT4+...\"\n}\n\nExample (ZPL):
\n{\n \"type\": \"ZPL\",\n \"awb_print\": \"^XA^FO50,50^A0N,40,40^FDTest label^FS^XZ\"\n}\n\nOn error:
\n{\n \"error\": \"error text\"\n}\n\nHTTP Errors:
\n","urlObject":{"protocol":"https","path":["api","v1","preAWB","print","inout","label","num","{inoutLabelNum}"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"b8522877-d382-4d06-bdd4-54eb406857b2"}],"id":"b7d237b5-06e4-45b9-9866-25c6f80d3d85","_postman_id":"b7d237b5-06e4-45b9-9866-25c6f80d3d85","description":""},{"name":"Others","item":[{"name":"Couriers_Web_Service_v1.0","id":"07afb7f2-3347-4702-8836-cbbfe189e455","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We offer you the ability to ask for couriers directly from your company's software or website by taking advantage of the \"Couriers Web Service\".
\nRequirements
\nMethod: GET
\nAuthorization: Bearer API_TOKEN
\nImportant:
\nExamples:
\nTest environment\nhttps://test-api.inout.bg/api/v1/couriers/333
\nProduction environment\nhttps://api1.inout.bg/api/v1/couriers/333
\nAPI 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","{companyId}"],"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 offer you the ability to ask for the companies (client accounts) linked to your API token directly from your company's software or website by taking advantage of the \"Companies Web Service\".
\nThe ID returned by this service is the companyId that you need for the Couriers Web Service (/couriers/{companyId}).
\nRequirements
\nMethod: GET
\nAuthorization: Bearer API_TOKEN
\nAPI Call Input Fields
\nURL query parameters
\nExamples:
\nTest environment\nhttps://test-api.inout.bg/api/v1/get-user-companies
\nProduction environment\nhttps://api1.inout.bg/api/v1/get-user-companies
\nAPI Response (Output Fields)
\nThe response is a JSON array — one element per company linked to your API token.
\nExample:
\n[\n {\n \"ID\": 333,\n \"NAME\": \"Example Company Ltd.\",\n \"BULSTAT\": \"123456789\",\n \"ADDRESS\": \"Sofia, ul. Primerna 1\",\n \"MOL\": \"Ivan Ivanov\"\n }\n]\n\nHTTP Errors
\n","urlObject":{"protocol":"https","path":["api","v1","get-user-companies"],"host":["api1","inout","bg"],"query":[],"variable":[]}},"response":[],"_postman_id":"5f6055d7-be14-469a-afea-757ff1f5ad87"},{"name":"AWB_Details_Web_Service_v1.0","id":"63ddd4c4-23f3-4311-81e7-eee0cc200f54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"We can now offer you the ability to ask for AWB details directly from your company's software or website by taking advantage of \"AWB Details Web Service\".
\nRequirements
\nMethod: GET\nAuthorization: Bearer API_TOKEN
\nAPI Call Input Fields\nURL query parameters
\nExample URLs:
\nTest: https://test-api.inout.bg/api/v1/get-awb/64506083?testMode=1\nProduction: https://api1.inout.bg/api/v1/get-awb/64506083?testMode=0
\nAPI Response (Output Fields)
\nExample:
\n{\n \"ID\": 12345678,\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 \"COURIER_PAYED_NUMBER\": \"451208\",\n \"COURIER_PAYED_DATE\": \"2024-08-05 00:00: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;\nBulgaria - phone number without country phone prefix;\nGreece - phone number without country phone prefix;\nPoland - phone number without country phone prefix;\nCzech Republic - country phone prefix +420 or 00420 + valid mobile number (9 digits);\nHungary - country phone prefix +36 or 0036 + valid mobile number (9 digits);\nSlovakia - country phone prefix +421 or 00421 + valid mobile number (9 digits);\nCroatia - country phone prefix +385 or 00385 + valid mobile number (9 digits).
\nWarning: Send exactly ONE international prefix. Do not combine the national trunk prefix with the country code — for example, a Hungarian number sent as \"0036\" + \"06...\" (i.e. the national \"06...\" form concatenated after the country code) will be misread and may be rejected as a landline/invalid number. Strip the national prefix first: 06 30 123 4567 must be sent as 0036301234567 (or +36301234567).
\n1. Download the office nomenclature from https://api1.inout.bg/api/v1/offices-by-courier/{courierId} (see the Courier Offices Web Service).
\n2. Submit the shipment request in one of the following ways:
\n2.1 Recommended: in the \"officeId\" field, submit the \"ID\" value from our nomenclature. This is the most reliable option. Alternatively, you can submit the office code in the \"officeCode\" field.
\n2.2 In the \"streetName\" field, submit the keyword office + \"OFFICE_NAME\" from our nomenclature. Important: the word \"office\" must be at the very START of the streetName field (e.g. \"office Aidemir\").
\n2.3 In the \"streetName\" field, submit the keyword office + \"ADDRESS\" from our nomenclature. Important: the word \"office\" must be at the very START of the streetName field.
\nSample data for the points described above:
\n2.1 (recommended — by officeId)
\n``` json\n\"recipient\": {\n \"name\": \"Test User\",\n \"countryIsoCode\": \"BG\",\n \"cityId\": null,\n \"region\": null,\n \"cityName\": \"Aidemir\",\n \"zipCode\": \"7538\",\n \"streetName\": \"\",\n \"buildingNumber\": 0,\n \"officeId\": 1297,\n \"officeCode\": \"\",\n \"addressText\": \"additional text, address test\",\n \"contactPerson\": \"Test User\",\n \"phoneNumber\": \"0889000000\",\n \"email\": \"test@example.com\"\n}
\n2.2 (by office name in streetName)
\n\"recipient\": {\n \"name\": \"Test User\",\n \"countryIsoCode\": \"BG\",\n \"cityId\": null,\n \"region\": null,\n \"cityName\": \"Aidemir\",\n \"zipCode\": \"7538\",\n \"streetName\": \"office Aidemir\",\n \"buildingNumber\": 0,\n \"officeId\": null,\n \"officeCode\": \"\",\n \"addressText\": \"additional text, address test\",\n \"contactPerson\": \"Test User\",\n \"phoneNumber\": \"0889000000\",\n \"email\": \"test@example.com\"\n}
\n2.3 (by office address in streetName)
\n\"recipient\": {\n \"name\": \"Test User\",\n \"countryIsoCode\": \"BG\",\n \"cityId\": null,\n \"region\": null,\n \"cityName\": \"Aidemir\",\n \"zipCode\": \"7538\",\n \"streetName\": \"office Aidemir kv. Delenkite ul. Sofia №7\",\n \"buildingNumber\": 0,\n \"officeId\": null,\n \"officeCode\": \"\",\n \"addressText\": \"additional text, address test\",\n \"contactPerson\": \"Test User\",\n \"phoneNumber\": \"0889000000\",\n \"email\": \"test@example.com\"\n}
\nNote: fields without a value should be sent as JSON null (e.g. \"region\": null), not as the string \"null\".
\n","_postman_id":"98ae42aa-58b8-4e4d-8e93-e5a5460f77b7"}]}