{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8a7e65b3-ee3a-4c73-8ca3-a156d280a94c","name":"Helm API","description":"The Helm API provides a powerful set of tools to integrate with and automate various warehousing and fulfillment operations. Using this API, you can easily manage inventory, orders, shipments, and stock levels. It offers a range of functionalities to streamline your warehousing processes, including:\n\n- **Order Management:** Retrieve, create, and update orders to keep your fulfillment process in sync.\n    \n- **Shipping:** Manage shipments, print labels, and track the status of your packages effortlessly.\n    \n- **Inventory Management:** Add, update, and organize inventory items and stock levels to ensure accurate and up-to-date records.\n    \n- **Stock Control:** Perform bulk updates, stock adjustments, and manage inventory quantities in real-time.\n    \n\nWith these capabilities, the Helm API allows you to optimize your warehouse operations, reduce manual tasks, and enhance the overall efficiency of your fulfillment workflow.\n\n---\n\n## ⚙️ Environment Variable\n\nTo make your requests more dynamic and reusable across environments.\n\n- 🔧 **Base URL Variable:**  \n    `{{base_url}}` → `https://app-api.helmwms.app`\n    \n- ✅ **Example Usage:**  \n    `{{base_url}}/api/v1/companies/{{company_id}}/orders`\n    \n\n## **🔑 How to Get a Token**\n\nAfter logging into your account:\n\n1. Go to your profile and click **Edit Profile**\n    \n2. Navigate to the **API Access** section\n    \n3. Enter a name for your API key (e.g., `test`)\n    \n4. Copy and securely store the generated **API Key (token)**\n    \n\n## 🚀 How to Use the Token\n\nUse this token as a **Bearer Token** in your API requests:\n\n`Authorization: Bearer YOUR_API_TOKEN`\n\nInclude this header in your requests to authenticate successfully.\n\nThis document lists the query parameters (filters, sortable fields, includable relations) accepted by each public API `index` and `show` endpoint. Paste the relevant section into the matching Postman request description.\n\nCommon conventions:\n\n- `includes` is a comma-separated list of relation paths.\n    \n- Array filters accept either `param[]=1&param[]=2` or a JSON array body.\n    \n- `sort_direction` defaults to `asc` when omitted; meaningful only when `sort_by` is sent.\n    \n\n---","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"18762619","team":2890280,"collectionId":"8a7e65b3-ee3a-4c73-8ca3-a156d280a94c","publishedId":"2sAY4xA21R","public":true,"publicUrl":"https://documenter-api.postman.tech/view/18762619/2sAY4xA21R","privateUrl":"https://go.postman.co/documentation/18762619-8a7e65b3-ee3a-4c73-8ca3-a156d280a94c","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2b7ffb"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/33f65e47-0ee7-4ab5-bb2c-189258f14350/aGVsbS1sb2dvLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"2b7ffb"}},{"name":"light","logo":"https://content.pstmn.io/2e4be23a-db4c-44fb-b075-9c9d19adc3b7/aGVsbS5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2b7ffb"}}]}},"version":"8.11.4","publishDate":"2025-08-18T13:20:34.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/2e4be23a-db4c-44fb-b075-9c9d19adc3b7/aGVsbS5wbmc=","logoDark":"https://content.pstmn.io/33f65e47-0ee7-4ab5-bb2c-189258f14350/aGVsbS1sb2dvLnBuZw=="}},"statusCode":200},"environments":[{"name":"Public API","id":"ebb0b67d-9cf8-4a82-95cc-4269b5f722e4","owner":"18762619","values":[{"key":"inventory_id","value":"","enabled":true,"type":"default"},{"key":"category_id","value":"","enabled":true,"type":"default"},{"key":"group_item_id","value":"","enabled":true,"type":"default"},{"key":"inventory_item_id","value":"1","enabled":true,"type":"default"},{"key":"customer_id","value":"1","enabled":true,"type":"default"},{"key":"order_id","value":"","enabled":true,"type":"default"},{"key":"order_item_id","value":"131","enabled":true,"type":"default"},{"key":"shipment_id","value":"","enabled":true,"type":"default"},{"key":"batch_id","value":"","enabled":true,"type":"default"},{"key":"batch_file_id","value":"","enabled":true,"type":"default"},{"key":"shipment_file_id","value":"","enabled":true,"type":"default"},{"key":"courier_key","value":"","enabled":true,"type":"default"},{"key":"courier_id","value":"","enabled":true,"type":"default"},{"key":"warehouse_id","value":"1","enabled":true,"type":"default"},{"key":"location_id","value":"","enabled":true,"type":"default"},{"key":"zone_id","value":"","enabled":true,"type":"default"},{"key":"stock_id","value":"","enabled":true,"type":"default"},{"key":"courier_service_id","value":"1","enabled":true,"type":"default"},{"key":"tax_group_id","value":"","enabled":true,"type":"default"},{"key":"supplier_id","value":"","enabled":true,"type":"default"},{"key":"delivery_id","value":"4","enabled":true,"type":"default"},{"key":"purchase_order_id","value":"","type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/983854447b59f03178cbf007061630cff718613914c567687887a126ad6c5cf1","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Public API","value":"18762619-ebb0b67d-9cf8-4a82-95cc-4269b5f722e4"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAY4xA21R"}