{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","description":"# HELM WMS — Public API v2\n\nREST API for the HELM WMS warehouse management platform. All responses are JSON;  \nerrors follow [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807) `application/problem+json`.\n\n## Base URL\n\n```\nhttps://app-api.helmwms.app/api/v2\n\n ```\n\nEvery request is built on the `{{baseUrl}}` collection variable — point it at  \nyour environment's API host (the default is the spec's `https://app-api.helmwms.app/api/v2`). All data  \nendpoints are scoped to a company: `{{baseUrl}}/companies/{{company_id}}/...`.  \nSet the `company_id` variable once and it flows through every request.\n\n## Authentication\n\nThe API uses **bearer tokens** (Personal Access Tokens). Send your token on every  \nrequest:\n\n```\nAuthorization: Bearer <your-token>\n\n ```\n\nThis collection is pre-configured with collection-level Bearer auth bound to the  \n`token` variable — set `token` in the collection variables and every request  \ninherits it. Missing or invalid credentials return `401 Unauthorized`.\n\nAuthorization is enforced per endpoint by role permissions: a token whose role  \nlacks the required permission receives `403 Forbidden`.\n\n## Rate limiting\n\nLimits are applied **per endpoint, per token** — each endpoint has its own  \nindependent budget (stated in that request's description). Exceeding it returns  \n`429 Too Many Requests` with:\n\n- `Retry-After` — seconds to wait before retrying,\n    \n- `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset`.\n    \n\n## Pagination\n\nList endpoints are **cursor-paginated by default**. Each response carries  \n`meta.next_cursor` / `meta.prev_cursor`; pass the opaque token back as  \n`?cursor=` to page forward/back.\n\n- `?page=N` — opt out of cursor mode and use classic page pagination.\n    \n- `?per_page=N` — page size, default **10**, maximum **250** (over 250 → `422`).\n    \n\n## Filtering\n\nFilters are **flat query-string parameters** named after the field — there is no  \n`filter[...]` wrapper. For example `?status=2&store_id=5`. Range filters expose  \n`_from` / `_to` (e.g. `created_at_from`, `created_at_to`). Most  \ncollections also accept `id`, `ids`, `excepted_ids` and `ignore_ids`. The exact  \nfilter set for each endpoint is listed in that request's description.\n\n## Includes (eager-loading relations)\n\nUse the plural `includes` parameter with a comma-separated list to embed related  \nresources, e.g. `?includes=items,customer,shippingAddress.address.country`. Each  \nlist endpoint documents its **allowed relations** (drawn from the model's  \nincludable whitelist); requesting a relation outside that set is ignored.\n\n## Sorting\n\n`?sort_by=&sort_direction=asc|desc`.\n\n## Errors\n\nErrors use `application/problem+json`:\n\n``` json\n{\n  \"type\": \"about:blank\",\n  \"title\": \"Unauthorized\",\n  \"status\": 401,\n  \"detail\": \"Human-readable, localized explanation.\",\n  \"instance\": null\n}\n\n ```\n\nValidation failures return `422` with field-level detail. Error messages are  \nlocalized to the caller's language.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"11966424","team":6823610,"collectionId":"188f74b7-3468-4f3c-b836-f924ecefe2b2","publishedId":"2sBY4JvMo4","public":true,"publicUrl":"https://api.helmwms.app","privateUrl":"https://go.postman.co/documentation/11966424-188f74b7-3468-4f3c-b836-f924ecefe2b2","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0056FB"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Helm postman documentation"},{"name":"title","value":"Helm Postman Docs"}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/7dd2d930-2ca7-4432-b763-a1c5be0beeb1/SGVsbVNxdWFyZS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"0056FB"}},{"name":"light","logo":"https://content.pstmn.io/7dd2d930-2ca7-4432-b763-a1c5be0beeb1/SGVsbVNxdWFyZS5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0056FB"}}]}},"version":"8.12.2","publishDate":"2026-07-06T09:26:52.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Helm Postman Docs","description":"Helm postman documentation"},"logos":{"logoLight":"https://content.pstmn.io/7dd2d930-2ca7-4432-b763-a1c5be0beeb1/SGVsbVNxdWFyZS5wbmc=","logoDark":"https://content.pstmn.io/7dd2d930-2ca7-4432-b763-a1c5be0beeb1/SGVsbVNxdWFyZS5wbmc="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/a289c85f84369fd7e890bbd89655de9b840e455b879088f42b6bc55a5e1f9ec8","favicon":"https://helmwms.app/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api.helmwms.app/view/metadata/2sBY4JvMo4"}