{"info":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","description":"

HELM WMS — Public API v2

REST API for the HELM WMS warehouse management platform. All responses are JSON;\nerrors follow RFC 7807 application/problem+json.

Base URL

https://app-api.helmwms.app/api/v2\n

Every request is built on the https://app-api.helmwms.app/api/v2 collection variable — point it at\nyour environment's API host (the default is the production API, https://app-api.helmwms.app/api/v2). All data\nendpoints are scoped to a company: https://app-api.helmwms.app/api/v2/companies//....\nSet the company_id variable once and it flows through every request.

Authentication

The API uses bearer tokens (Personal Access Tokens). Send your token on every\nrequest:

Authorization: Bearer <your-token>\n

This collection is pre-configured with collection-level Bearer auth bound to the\ntoken variable — set token in the collection variables and every request\ninherits it. Missing or invalid credentials return 401 Unauthorized.

Authorization is enforced per endpoint by role permissions: a token whose role\nlacks the required permission receives 403 Forbidden.

Basic Mode and Full Mode

A company's warehouse runs in one of two stock-control modes.

Basic Mode tracks a single stock figure per product. Full Mode\n(advanced stock control) adds warehouse locations, and with them zones,\npicking, transfer picking, stock movements, inventory checks, sorting,\nbatch/serial tracking and the warehouse cost dashboard.

Requests whose description opens with Full Mode only need Full Mode on the\ncompany's primary warehouse. Calling one for a Basic Mode company returns\n403 Forbidden with a problem+json body, rather than an empty list or a write\nthat quietly does nothing. Switch the warehouse to Full Mode in Settings to\nenable them.

The static reference lists stay open in Basic Mode: the location type, storage\ntype and location colour dropdowns return their enum values whatever mode the\nwarehouse is in, so an integration can read them before the switch.

Rate limiting

Limits are applied per endpoint, per token — each endpoint has its own\nindependent budget (stated in that request's description). Exceeding it returns\n429 Too Many Requests with:

Retry-After — seconds to wait before retrying,
X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

Pagination

List endpoints are cursor-paginated by default. Each response carries\nmeta.next_cursor / meta.prev_cursor; pass the opaque token back as\n?cursor=<token> to page forward/back.

?page=N — opt out of cursor mode and use classic page pagination.
?per_page=N — page size, default 10, maximum 250 (over 250 → 422).

Filtering

Filters are flat query-string parameters named after the field — there is no\nfilter[...] wrapper. For example ?status=2&store_id=5. Range filters expose\n<field>_from / <field>_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.

Includes (eager-loading relations)

Use 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.

Sorting

?sort_by=<field>&sort_direction=asc|desc.

Errors

Errors use application/problem+json:

{\n  \"type\": \"about:blank\",\n  \"title\": \"Unauthorized\",\n  \"status\": 401,\n  \"detail\": \"Human-readable, localized explanation.\",\n  \"instance\": null\n}\n

Validation failures return 422 with field-level detail. Error messages are\nlocalized to the caller's language.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"HELM WMS — Public API v2","slug":"helm-wms-public-api-v2"}],"owner":"11966424","collectionId":"188f74b7-3468-4f3c-b836-f924ecefe2b2","publishedId":"2sBY4JvMo4","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0056FB"},"publishDate":"2026-07-06T09:26:52.000Z"},"item":[{"name":"Batch Shipments","item":[{"name":"Batch shipments list","id":"b26a0b4c-31dc-48f6-8b07-abef38dfaf60","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//batch-shipments","description":"

Rate limit: 120 requests/minute, per token, for this endpoint. Each endpoint has its own independent budget. Exceeding it returns 429 Too Many Requests with Retry-After and X-RateLimit-* headers.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`status`	Filter by Status.
`reference`	Filter by Reference.
`created_at_from`	Filter by Created At From.
`created_at_to`	Filter by Created At To.
`downloaded_at_from`	Filter by Downloaded At From.
`downloaded_at_to`	Filter by Downloaded At To.
`label_size`	Filter by Label Size.
`label_format`	Filter by Label Format.
`shipments_count_from`	Filter by Shipments Count From.
`shipments_count_to`	Filter by Shipments Count To.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

shipments
shipments.shipmentFile
shipments.order
shipments.order.customer.contact
shipments.order.shippingAddress.address.country
failedShipments
cancelledShipments
pendingShipments
completedShipments
batchFile

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Reference.

\n","type":"text/plain"},"key":"reference","value":""},{"disabled":true,"description":{"content":"

Filter by Created At From.

\n","type":"text/plain"},"key":"created_at_from","value":""},{"disabled":true,"description":{"content":"

Filter by Created At To.

\n","type":"text/plain"},"key":"created_at_to","value":""},{"disabled":true,"description":{"content":"

Filter by Downloaded At From.

\n","type":"text/plain"},"key":"downloaded_at_from","value":""},{"disabled":true,"description":{"content":"

Filter by Downloaded At To.

\n","type":"text/plain"},"key":"downloaded_at_to","value":""},{"disabled":true,"description":{"content":"

Filter by Label Size.

\n","type":"text/plain"},"key":"label_size","value":""},{"disabled":true,"description":{"content":"

Filter by Label Format.

\n","type":"text/plain"},"key":"label_format","value":""},{"disabled":true,"description":{"content":"

Filter by Shipments Count From.

\n","type":"text/plain"},"key":"shipments_count_from","value":""},{"disabled":true,"description":{"content":"

Filter by Shipments Count To.

\n","type":"text/plain"},"key":"shipments_count_to","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

Opaque cursor token from meta.next_cursor / meta.prev_cursor of a previous response. Cursor pagination is the default mode for list endpoints — pass ?page= instead to use classic page pagination.

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - shipments - shipments.shipmentFile - shipments.order - shipments.order.customer.contact - shipments.order.shippingAddress.address.country - failedShipments - cancelledShipments - pendingShipments - completedShipments - batchFile

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"b26a0b4c-31dc-48f6-8b07-abef38dfaf60"},{"name":"Batch shipments show","id":"621ce88b-0168-4243-ae59-2c731123cb7a","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//batch-shipments/:batchShipmentID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`batchShipmentID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

shipments
shipments.shipmentFile
shipments.order
shipments.order.customer.contact
shipments.order.shippingAddress.address.country
failedShipments
cancelledShipments
pendingShipments
completedShipments
batchFile

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"fdbdc8a2-8937-4582-94c2-717b5ecbea4a","type":"any","value":"","key":"batchShipmentID"}]}},"response":[],"_postman_id":"621ce88b-0168-4243-ae59-2c731123cb7a"},{"name":"Batch shipments failed shipments","id":"9f14eafb-117a-4a4f-9bb9-590a08352958","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//batch-shipments/:batchShipmentID/failed-shipments","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`batchShipmentID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Rate limit: 60 requests/minute, per token, for this endpoint. Each endpoint has its own independent budget. Exceeding it returns 429 Too Many Requests with Retry-After and X-RateLimit-* headers.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`batchShipmentID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`batch_shipment_id`	integer	yes	—
`label_format`	string	yes	Allowed: `2`, `3`, `4`, `5`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`batchID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`batch_id`	—
`file_name`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`batchID`	integer	yes
`batchFileID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`batch_id`	integer	yes	—
`batch_file_id`	integer	yes	—

Batch Shipments — 6 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"3ca3a6a0-ceae-4718-82be-a63e29c02580","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Channel Linking","item":[{"name":"Channel linking logs list","id":"29b3c631-d1bd-442e-84e2-f7989bc76abc","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//channel-linking/logs","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`channel_product_id`	—
`query`	—
`created_at[startDate]`	—
`created_at[endDate]`	—
`log_status[]`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"29b3c631-d1bd-442e-84e2-f7989bc76abc"},{"name":"Channel linking logs show","id":"0b5a9695-948f-4329-a1db-5563418b7803","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//channel-linking/logs/:activityID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`activityID`	string \| null	yes

Channel Linking — 2 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"b986e24e-4ca6-4714-91ad-8adb20a06b87","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Countries","item":[{"name":"Countries defaults","id":"32cb72b3-14e0-4fdc-a83d-d404891b8003","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//countries/:countryID/defaults","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`countryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"0e2c423b-afa6-4d11-ae44-4980988b406d"},{"name":"Countries states list","id":"735bd956-dd6a-4eca-9870-3d3d7d6243d6","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//countries/states","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"735bd956-dd6a-4eca-9870-3d3d7d6243d6"},{"name":"Countries states country states","id":"8ed2cbc9-3ace-403a-a5cc-61fba493d22c","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//countries/:countryID/states","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`countryID`	integer	yes

Countries — 4 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"22bfdaac-9455-419b-b12b-5dcdf8b9d9e6","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Courier Logs","item":[{"name":"Courier logs list","id":"6c49ede8-1a3c-45c5-b753-9396f53d2c48","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//courier-logs","description":"

Read-only view of the courier calls stored in the observability request-log\nstore. Every row is one call made to the courier service - shipment creation,\ncancellation, manifest, account and lookup calls.

Rows are returned newest first and paged with an opaque cursor:\nmeta.next_cursor carries the token for the next page.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes	Company the logs belong to.

Response fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`request_id`	string	Log id, used by the detail endpoint.
`timestamp`	string	When the call was made.
`action`	string	Raw action key, e.g. `shipment.create`. Also the filter value.
`action_title`	string	The same action translated to the caller's language.
`courier`	object \| null	`{ id, key, name, logo }` - null when the call is not tied to a courier.
`courier_key`	string \| null	Raw courier key, kept beside `courier`.
`courier_service`	object \| null	`{ id, name }`.
`status_code`	integer	HTTP status the courier returned.
`response_success`	boolean	Whether the call succeeded.
`execution_time_ms`	integer	How long the call took.
`user_id`	integer \| null	User who triggered the call, null for system calls.
`order`	object \| null	`{ id, order_number }`.
`shipment`	object \| null	`{ id, reference }`.
`batch_id`	integer \| null	Set instead of `order` for batch calls.

Free-text search over order number, shipment reference, courier name and action label. Partial, case-insensitive.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by action key, e.g. shipment.create. Repeat the parameter for more than one value. Allowed values come from GET /tools/filters/options?key=courier_log_actions.

\n","type":"text/plain"},"key":"action","value":""},{"disabled":true,"description":{"content":"

Filter by courier key, e.g. royal_mail. Repeatable.

\n","type":"text/plain"},"key":"courier_key","value":""},{"disabled":true,"description":{"content":"

Filter by courier id. Repeatable.

\n","type":"text/plain"},"key":"courier_id","value":""},{"disabled":true,"description":{"content":"

Filter by courier service id. Repeatable.

\n","type":"text/plain"},"key":"courier_service_id","value":""},{"disabled":true,"description":{"content":"

Filter by order id. Repeatable.

\n","type":"text/plain"},"key":"order_id","value":""},{"disabled":true,"description":{"content":"

Filter by exact order number. Repeatable.

\n","type":"text/plain"},"key":"order_number","value":""},{"disabled":true,"description":{"content":"

Filter by shipment id. Repeatable.

\n","type":"text/plain"},"key":"shipment_id","value":""},{"disabled":true,"description":{"content":"

Filter by exact shipment reference. Repeatable.

\n","type":"text/plain"},"key":"shipment_reference","value":""},{"disabled":true,"description":{"content":"

Filter by batch shipment id.

\n","type":"text/plain"},"key":"batch_id","value":""},{"disabled":true,"description":{"content":"

Filter by the user who triggered the call. Repeatable.

\n","type":"text/plain"},"key":"user_id","value":""},{"disabled":true,"description":{"content":"

true returns successful calls only, false failed ones only.

\n","type":"text/plain"},"key":"response_success","value":""},{"disabled":true,"description":{"content":"

Start of the timestamp range (ISO 8601). Defaults to 30 days ago.

\n","type":"text/plain"},"key":"date_start","value":""},{"disabled":true,"description":{"content":"

End of the timestamp range (ISO 8601). Defaults to now.

\n","type":"text/plain"},"key":"date_end","value":""},{"disabled":true,"description":{"content":"

One of timestamp, status_code, route_name, courier_key, user_id. Anything else is rejected with 422.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\". Default desc.

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 20, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

Opaque cursor from meta.next_cursor of the previous response. Courier logs are cursor-paginated only; ?page= is not supported.

\n","type":"text/plain"},"key":"cursor","value":""}],"variable":[]}},"response":[],"_postman_id":"6c49ede8-1a3c-45c5-b753-9396f53d2c48"},{"name":"Courier log detail","id":"ad35046c-c0e4-41f2-bf44-7b1a62562951","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//courier-logs/{{request_id}}","description":"

One courier log with the full request and response payload as it was sent to and\nreturned by the courier service.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes	Company the log belongs to.
`request_id`	string	yes	Log id from the list response.

Response fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`meta`	object	Same fields as a list row, plus `ip` and `batch_id`.
`payload`	object	`request_headers`, `request_body`, `response_headers`, `response_body`.
`links`	object	`order` and `shipment` the call belongs to, when there is one.

Returns 404 Not Found when the id is unknown, or belongs to a request log that\nis not a courier call.

Courier Logs — 2 endpoints.

Read-only view of the courier calls already stored in the observability request-log store. Filters are flat query params; paging is cursor-only (cursor / meta.next_cursor).

\n","_postman_id":"ccf42620-b354-4ce9-8cd5-5c191b5d9165","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Couriers","item":[{"name":"Couriers available","id":"8e3be73d-d1a4-4e52-9ccf-b91d84c0d539","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//couriers/available","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

NOTE: filters are FLAT query params named after the filter method (e.g. ?ids=1,2&store_id=5), resolved by App\\Filters\\QueryFilters against top-level request keys — there is NO nested filter[...] contract at runtime, so none is declared/documented here.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`courierKey`	string	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`courierKey`	string	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`name`	Filter by Name.
`friendly_name`	Filter by Friendly Name.
`service_name`	Filter by Service Name.
`courier_key`	Filter by Courier Key.
`is_test_account`	Filter by Is Test Account.
`status`	Filter by Status.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

services

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Friendly Name.

\n","type":"text/plain"},"key":"friendly_name","value":""},{"disabled":true,"description":{"content":"

Filter by Service Name.

\n","type":"text/plain"},"key":"service_name","value":""},{"disabled":true,"description":{"content":"

Filter by Courier Key.

\n","type":"text/plain"},"key":"courier_key","value":""},{"disabled":true,"description":{"content":"

Filter by Is Test Account.

\n","type":"text/plain"},"key":"is_test_account","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - services

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"af68833d-4276-4918-b947-dcff9f561fdd"},{"name":"Couriers create","id":"6f312127-870d-4e1c-81ea-dcfc84f276f2","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"courier_key\": \"courier_key\",\n \"name\": \"name\",\n \"testing\": false,\n \"default_label_size\": \"2\",\n \"collection_times\": {\n \"monday\": [\n \"\"\n ],\n \"tuesday\": [\n \"\"\n ],\n \"wednesday\": [\n \"\"\n ],\n \"thursday\": [\n \"\"\n ],\n \"friday\": [\n \"\"\n ],\n \"saturday\": [\n \"\"\n ],\n \"sunday\": [\n \"\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//couriers","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`courier_key`	string	yes	—
`name`	string	yes	—
`testing`	boolean	yes	—
`default_label_size`	string \| null	no	LabelSizes values: - `2` = PAPER_A5 - `3` = LABEL_8x4 - `4` = LABEL_6X4 - `5` = LABEL_4X4 Allowed: `2`, `3`, `4`, `5`
`collection_times`	object	no	—
`collection_times.monday`	array \| null	no	—
`collection_times.tuesday`	array \| null	no	—
`collection_times.wednesday`	array \| null	no	—
`collection_times.thursday`	array \| null	no	—
`collection_times.friday`	array \| null	no	—
`collection_times.saturday`	array \| null	no	—
`collection_times.sunday`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`courierID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`courierID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`status`	boolean	yes	—
`name`	string	yes	—
`config`	array \| null	no	—
`default_label_size`	string \| null	no	LabelSizes values: - `2` = PAPER_A5 - `3` = LABEL_8x4 - `4` = LABEL_6X4 - `5` = LABEL_4X4 Allowed: `2`, `3`, `4`, `5`
`collection_times`	object	no	—
`collection_times.monday`	array \| null	no	—
`collection_times.tuesday`	array \| null	no	—
`collection_times.wednesday`	array \| null	no	—
`collection_times.thursday`	array \| null	no	—
`collection_times.friday`	array \| null	no	—
`collection_times.saturday`	array \| null	no	—
`collection_times.sunday`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`courierID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`use_custom_credentials`	boolean	yes	—
`custom_name`	string \| null	no	—
`custom_token`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`couriers_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`courierKey`	string	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string	yes	—
`testing`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`courierKey`	string	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`courierID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`courier_id`	integer	yes	—
`courier_service_name`	string	yes	—
`label_reference`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`
`label_secondary_reference`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`
`presets`	array \| null	no	—
`specifics`	array \| null	no	—
`specifics.*.key`	string	yes	—
`specifics.*.value`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`courierID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`courier_id`	integer	yes	—
`services`	array	yes	—
`services.*.courier_service_name`	string	yes	—
`services.*.shipping_service_id`	string	yes	—
`services.*.label_reference`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`
`services.*.label_secondary_reference`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`courierID`	integer	yes
`courierServiceID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`courier_id`	integer	yes	—
`courier_service_id`	integer	yes	—
`status`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`courierID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`courier_id`	integer	yes	—
`status`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`courierID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`courier_id`	integer	yes	—
`collection_times`	object	yes	—
`collection_times.monday`	array	yes	—
`collection_times.tuesday`	array	yes	—
`collection_times.wednesday`	array	yes	—
`collection_times.thursday`	array	yes	—
`collection_times.friday`	array	yes	—
`collection_times.saturday`	array	yes	—
`collection_times.sunday`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`courierID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`courier_id`	integer	yes	—
`schedule`	object	no	—
`schedule.monday`	string \| null	no	—
`schedule.tuesday`	string \| null	no	—
`schedule.wednesday`	string \| null	no	—
`schedule.thursday`	string \| null	no	—
`schedule.friday`	string \| null	no	—
`schedule.saturday`	string \| null	no	—
`schedule.sunday`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`courierID`	integer	yes

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[{"id":"d044868b-da4b-4e91-8498-3dc93599bbef","type":"any","value":"","key":"courierID"}]}},"response":[],"_postman_id":"3c9ca707-cdeb-48a4-9e05-e230b4dd733d"},{"name":"Couriers services create","id":"64b83f1c-0d42-4b78-959d-d997c2d0b163","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"courier_service_name\": \"courier_service_name\",\n \"shipping_service_id\": \"{{shipping_service_id}}\",\n \"label_reference\": \"1\",\n \"label_secondary_reference\": \"1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//couriers/:courierID/services","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`courierID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`courier_service_name`	string	yes	—
`shipping_service_id`	string	yes	—
`label_reference`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`
`label_secondary_reference`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`courierID`	integer	yes
`courierServiceID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`courierID`	integer	yes
`courierServiceID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`courier_service_name`	string	yes	—
`status`	boolean \| null	no	—
`label_reference`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`
`label_secondary_reference`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`
`presets`	array \| null	no	—
`specifics`	array \| null	no	—
`specifics.*.key`	string	yes	—
`specifics.*.value`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`courierID`	integer	yes
`courierServiceID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`courierKey`	string	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`courier_service_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`courierServiceID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`courier_service_id`	integer	yes	—
`fields`	array	yes	—
`fields.*.key`	string	yes	—
`fields.*.value`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`courierServiceID`	integer	yes

Returns the indexed metadata, the full request and response payload as sent to and received from the courier, and the records the call belongs to.

A request id that exists but is not a courier call returns 404, as does a payload that has passed its retention window.

The log's request_id from the list endpoint.

\n","type":"text/plain"},"type":"any","value":"99f2d9ac-f002-446a-9b4b-5dd62a4eb69d","key":"request_id"}]}},"response":[{"id":"5db990e7-4ea5-4dad-82de-a4c3bb00105b","name":"The courier log.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://app-api.helmwms.app/api/v2/companies/:company_id/courier-logs/:request_id","host":["https://app-api.helmwms.app/api/v2"],"path":["companies",":company_id","courier-logs",":request_id"],"variable":[{"key":"company_id","value":"2496","description":"The company the token belongs to."},{"key":"request_id","value":"8d6a7e9d-9931-12f2-1aa6-13b2192d3c44","description":"The log's `request_id` from the list endpoint."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"meta\": {\n \"request_id\": \"99f2d9ac-f002-446a-9b4b-5dd62a4eb69d\",\n \"timestamp\": \"2026-07-30T08:35:09+00:00\",\n \"action\": \"shipment.create\",\n \"courier_key\": \"Test\",\n \"courier_id\": 1,\n \"courier_service_id\": 1,\n \"status_code\": 200,\n \"response_success\": true,\n \"execution_time_ms\": 640,\n \"user_id\": 1,\n \"ip\": \"10.0.0.14\"\n },\n \"payload\": {\n \"request_headers\": {},\n \"request_body\": {\n \"courier\": \"Test\",\n \"shipment\": {\n \"reference\": \"SH-900BDCE7\"\n }\n },\n \"response_headers\": {},\n \"response_body\": \"{\\\"tracking_codes\\\":[\\\"TEST123456\\\"]}\"\n },\n \"links\": {\n \"shipment\": {\n \"id\": 168,\n \"reference\": \"SH-900BDCE7\",\n \"status\": 1\n },\n \"order\": {\n \"id\": 216,\n \"order_number\": \"OR-4958B4AE\"\n }\n }\n }\n}"},{"id":"d87e3771-bbdc-4077-b489-8cc7b4af6203","name":"Missing, expired or invalid token.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/problem+json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://app-api.helmwms.app/api/v2/companies/:company_id/courier-logs/:request_id","host":["https://app-api.helmwms.app/api/v2"],"path":["companies",":company_id","courier-logs",":request_id"],"variable":[{"key":"company_id","value":"2496","description":"The company the token belongs to."},{"key":"request_id","value":"8d6a7e9d-9931-12f2-1aa6-13b2192d3c44","description":"The log's `request_id` from the list endpoint."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/problem+json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 2940,\n \"detail\": \"string\"\n}"},{"id":"8a23e709-e95a-4af8-90c0-be7b32899c07","name":"The token's user may not read request logs.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/problem+json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://app-api.helmwms.app/api/v2/companies/:company_id/courier-logs/:request_id","host":["https://app-api.helmwms.app/api/v2"],"path":["companies",":company_id","courier-logs",":request_id"],"variable":[{"key":"company_id","value":"2496","description":"The company the token belongs to."},{"key":"request_id","value":"8d6a7e9d-9931-12f2-1aa6-13b2192d3c44","description":"The log's `request_id` from the list endpoint."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/problem+json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 2940,\n \"detail\": \"string\"\n}"},{"id":"3e70e572-9632-49f3-8a24-540a7550f624","name":"No courier log with that request id.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/problem+json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://app-api.helmwms.app/api/v2/companies/:company_id/courier-logs/:request_id","host":["https://app-api.helmwms.app/api/v2"],"path":["companies",":company_id","courier-logs",":request_id"],"variable":[{"key":"company_id","value":"2496","description":"The company the token belongs to."},{"key":"request_id","value":"8d6a7e9d-9931-12f2-1aa6-13b2192d3c44","description":"The log's `request_id` from the list endpoint."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/problem+json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 2940,\n \"detail\": \"string\"\n}"},{"id":"4739ade1-71c9-470f-bceb-9fe1fd07f9b3","name":"Rate limit exceeded.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/problem+json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://app-api.helmwms.app/api/v2/companies/:company_id/courier-logs/:request_id","host":["https://app-api.helmwms.app/api/v2"],"path":["companies",":company_id","courier-logs",":request_id"],"variable":[{"key":"company_id","value":"2496","description":"The company the token belongs to."},{"key":"request_id","value":"8d6a7e9d-9931-12f2-1aa6-13b2192d3c44","description":"The log's `request_id` from the list endpoint."}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/problem+json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 2940,\n \"detail\": \"string\"\n}"}],"_postman_id":"ac8ad841-f8c8-4a8c-9c27-9e01fc087b59"},{"name":"List courier logs","id":"daf79466-0a6a-4845-be75-551160268787","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//courier-logs","description":"

Returns courier calls newest first. Results are cursor paginated: pass the meta.next_cursor value from the previous response as cursor to fetch the next page. A null cursor means there are no further pages.

All filters are optional and combine with AND. Multi-value filters accept a repeated query parameter (?action[]=a&action[]=b) or a single value.

order_number and shipment_reference are matched exactly and resolved to the ids stored on the log; a value that matches no record returns an empty list rather than an unfiltered one.

Courier action to include.

\n","type":"text/plain"},"key":"action[]","value":"shipment.create"},{"disabled":true,"description":{"content":"

Courier key, e.g. RoyalMail.

\n","type":"text/plain"},"key":"courier_key[]","value":"string"},{"disabled":true,"description":{"content":"

Courier key, e.g. RoyalMail.

\n","type":"text/plain"},"key":"courier_key[]","value":"string"},{"disabled":true,"description":{"content":"

Courier record id.

\n","type":"text/plain"},"key":"courier_id[]","value":"5661"},{"disabled":true,"description":{"content":"

Courier record id.

\n","type":"text/plain"},"key":"courier_id[]","value":"3575"},{"disabled":true,"description":{"content":"

Courier service id.

\n","type":"text/plain"},"key":"courier_service_id[]","value":"5661"},{"disabled":true,"description":{"content":"

Courier service id.

\n","type":"text/plain"},"key":"courier_service_id[]","value":"3575"},{"disabled":true,"description":{"content":"

Order id, when known. Prefer order_number[] for human input.

\n","type":"text/plain"},"key":"order_id[]","value":"5661"},{"disabled":true,"description":{"content":"

Order id, when known. Prefer order_number[] for human input.

\n","type":"text/plain"},"key":"order_id[]","value":"3575"},{"disabled":true,"description":{"content":"

Order number, matched exactly.

\n","type":"text/plain"},"key":"order_number[]","value":"OR-4958B4AE"},{"disabled":true,"description":{"content":"

Shipment id, when known. Prefer shipment_reference[] for human input.

\n","type":"text/plain"},"key":"shipment_id[]","value":"5661"},{"disabled":true,"description":{"content":"

Shipment id, when known. Prefer shipment_reference[] for human input.

\n","type":"text/plain"},"key":"shipment_id[]","value":"3575"},{"disabled":true,"description":{"content":"

Shipment reference, matched exactly.

\n","type":"text/plain"},"key":"shipment_reference[]","value":"SH-900BDCE7"},{"disabled":true,"description":{"content":"

Batch shipment id. Batch calls cover many orders, so they carry a batch id instead of an order.

\n","type":"text/plain"},"key":"batch_id","value":"2496"},{"disabled":true,"description":{"content":"

User who triggered the call. Absent for system-triggered calls such as label pre-generation.

\n","type":"text/plain"},"key":"user_id[]","value":"5661"},{"disabled":true,"description":{"content":"

User who triggered the call. Absent for system-triggered calls such as label pre-generation.

\n","type":"text/plain"},"key":"user_id[]","value":"3575"},{"disabled":true,"description":{"content":"

true returns successful calls only, false returns failed attempts only.

\n","type":"text/plain"},"key":"response_success","value":"false"},{"disabled":true,"description":{"content":"

Start of the time range. Defaults to 30 days ago.

\n","type":"text/plain"},"key":"date_start","value":"1995-08-02T07:47:17.544Z"},{"disabled":true,"description":{"content":"

End of the time range. Must not be earlier than date_start.

\n","type":"text/plain"},"key":"date_end","value":"1995-08-02T07:47:17.544Z"},{"disabled":true,"key":"sort_by","value":"timestamp"},{"disabled":true,"key":"sort_direction","value":"desc"},{"disabled":true,"description":{"content":"

Cursor from the previous response's meta.next_cursor.

\n","type":"text/plain"},"key":"cursor","value":"string"},{"disabled":true,"description":{"content":"

Free-text search over order number, shipment reference, courier name and action label. Partial and case-insensitive.

\n","type":"text/plain"},"key":"query","value":"SH-900BDCE7"},{"disabled":true,"description":{"content":"

Items per page. Default 20, maximum 250.

\n","type":"text/plain"},"key":"per_page","value":"50"},{"disabled":true,"description":{"content":"

timestamp, status_code, route_name, courier_key, user_id

\n","type":"text/plain"},"key":"sort_by","value":"timestamp"}],"variable":[]}},"response":[{"id":"95a44ba4-3a04-4482-8629-fa88c029040b","name":"A page of courier logs.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://app-api.helmwms.app/api/v2/companies/:company_id/courier-logs?action[]=shipment.create&courier_key[]=string&courier_id[]=3575&courier_service_id[]=3575&order_id[]=3575&order_number[]=OR-4958B4AE&shipment_id[]=3575&shipment_reference[]=SH-900BDCE7&batch_id=2496&user_id[]=3575&response_success=false&date_start=1995-08-02T07:47:17.544Z&date_end=1995-08-02T07:47:17.544Z&sort_by=timestamp&sort_direction=desc&cursor=string","host":["https://app-api.helmwms.app/api/v2"],"path":["companies",":company_id","courier-logs"],"query":[{"description":"Courier action to include.","key":"action[]","value":"shipment.create"},{"description":"Courier key, e.g. `RoyalMail`.","key":"courier_key[]","value":"string"},{"description":"Courier record id.","key":"courier_id[]","value":"3575"},{"description":"Courier service id.","key":"courier_service_id[]","value":"3575"},{"description":"Order id, when known. Prefer `order_number[]` for human input.","key":"order_id[]","value":"3575"},{"description":"Order number, matched exactly.","key":"order_number[]","value":"OR-4958B4AE"},{"description":"Shipment id, when known. Prefer `shipment_reference[]` for human input.","key":"shipment_id[]","value":"3575"},{"description":"Shipment reference, matched exactly.","key":"shipment_reference[]","value":"SH-900BDCE7"},{"description":"Batch shipment id. Batch calls cover many orders, so they carry a batch id instead of an order.","key":"batch_id","value":"2496"},{"description":"User who triggered the call. Absent for system-triggered calls such as label pre-generation.","key":"user_id[]","value":"3575"},{"description":"`true` returns successful calls only, `false` returns failed attempts only.","key":"response_success","value":"false"},{"description":"Start of the time range. Defaults to 30 days ago.","key":"date_start","value":"1995-08-02T07:47:17.544Z"},{"description":"End of the time range. Must not be earlier than `date_start`.","key":"date_end","value":"1995-08-02T07:47:17.544Z"},{"key":"sort_by","value":"timestamp"},{"key":"sort_direction","value":"desc"},{"description":"Cursor from the previous response's `meta.next_cursor`.","key":"cursor","value":"string"}],"variable":[{"key":"company_id","value":"2496","description":"The company the token belongs to."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"request_id\": \"6054047d-7f30-48ed-b870-a9c5c826e729\",\n \"timestamp\": \"2026-07-30T08:33:39+00:00\",\n \"action\": \"shipment.create\",\n \"courier_key\": \"RoyalMail\",\n \"courier_id\": 2,\n \"courier_service\": {\n \"id\": 4,\n \"name\": \"Royal Mail 24 Parcel\"\n },\n \"status_code\": 401,\n \"response_success\": false,\n \"execution_time_ms\": 812,\n \"user_id\": 1,\n \"order\": {\n \"id\": 216,\n \"order_number\": \"OR-4958B4AE\"\n },\n \"shipment\": null,\n \"batch_id\": null\n },\n {\n \"request_id\": \"99f2d9ac-f002-446a-9b4b-5dd62a4eb69d\",\n \"timestamp\": \"2026-07-30T08:35:09+00:00\",\n \"action\": \"shipment.create\",\n \"courier_key\": \"Test\",\n \"courier_id\": 1,\n \"courier_service\": {\n \"id\": 1,\n \"name\": \"Test Label\"\n },\n \"status_code\": 200,\n \"response_success\": true,\n \"execution_time_ms\": 640,\n \"user_id\": 1,\n \"order\": {\n \"id\": 216,\n \"order_number\": \"OR-4958B4AE\"\n },\n \"shipment\": {\n \"id\": 168,\n \"reference\": \"SH-900BDCE7\"\n },\n \"batch_id\": null\n }\n ],\n \"meta\": {\n \"next_cursor\": \"WzE3NTM4NjQxMzkwMDAsIjYwNTQwNDdkIl0=\"\n }\n}"},{"id":"85a47d85-b15a-4fa6-82e5-e005d25b996e","name":"Missing, expired or invalid token.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/problem+json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://app-api.helmwms.app/api/v2/companies/:company_id/courier-logs?action[]=shipment.create&courier_key[]=string&courier_id[]=3575&courier_service_id[]=3575&order_id[]=3575&order_number[]=OR-4958B4AE&shipment_id[]=3575&shipment_reference[]=SH-900BDCE7&batch_id=2496&user_id[]=3575&response_success=false&date_start=1995-08-02T07:47:17.544Z&date_end=1995-08-02T07:47:17.544Z&sort_by=timestamp&sort_direction=desc&cursor=string","host":["https://app-api.helmwms.app/api/v2"],"path":["companies",":company_id","courier-logs"],"query":[{"description":"Courier action to include.","key":"action[]","value":"shipment.create"},{"description":"Courier key, e.g. `RoyalMail`.","key":"courier_key[]","value":"string"},{"description":"Courier record id.","key":"courier_id[]","value":"3575"},{"description":"Courier service id.","key":"courier_service_id[]","value":"3575"},{"description":"Order id, when known. Prefer `order_number[]` for human input.","key":"order_id[]","value":"3575"},{"description":"Order number, matched exactly.","key":"order_number[]","value":"OR-4958B4AE"},{"description":"Shipment id, when known. Prefer `shipment_reference[]` for human input.","key":"shipment_id[]","value":"3575"},{"description":"Shipment reference, matched exactly.","key":"shipment_reference[]","value":"SH-900BDCE7"},{"description":"Batch shipment id. Batch calls cover many orders, so they carry a batch id instead of an order.","key":"batch_id","value":"2496"},{"description":"User who triggered the call. Absent for system-triggered calls such as label pre-generation.","key":"user_id[]","value":"3575"},{"description":"`true` returns successful calls only, `false` returns failed attempts only.","key":"response_success","value":"false"},{"description":"Start of the time range. Defaults to 30 days ago.","key":"date_start","value":"1995-08-02T07:47:17.544Z"},{"description":"End of the time range. Must not be earlier than `date_start`.","key":"date_end","value":"1995-08-02T07:47:17.544Z"},{"key":"sort_by","value":"timestamp"},{"key":"sort_direction","value":"desc"},{"description":"Cursor from the previous response's `meta.next_cursor`.","key":"cursor","value":"string"}],"variable":[{"key":"company_id","value":"2496","description":"The company the token belongs to."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/problem+json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 2940,\n \"detail\": \"string\"\n}"},{"id":"33a4ec66-4454-44ac-8ad4-eb7eaf79a333","name":"The token's user may not read request logs.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/problem+json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://app-api.helmwms.app/api/v2/companies/:company_id/courier-logs?action[]=shipment.create&courier_key[]=string&courier_id[]=3575&courier_service_id[]=3575&order_id[]=3575&order_number[]=OR-4958B4AE&shipment_id[]=3575&shipment_reference[]=SH-900BDCE7&batch_id=2496&user_id[]=3575&response_success=false&date_start=1995-08-02T07:47:17.544Z&date_end=1995-08-02T07:47:17.544Z&sort_by=timestamp&sort_direction=desc&cursor=string","host":["https://app-api.helmwms.app/api/v2"],"path":["companies",":company_id","courier-logs"],"query":[{"description":"Courier action to include.","key":"action[]","value":"shipment.create"},{"description":"Courier key, e.g. `RoyalMail`.","key":"courier_key[]","value":"string"},{"description":"Courier record id.","key":"courier_id[]","value":"3575"},{"description":"Courier service id.","key":"courier_service_id[]","value":"3575"},{"description":"Order id, when known. Prefer `order_number[]` for human input.","key":"order_id[]","value":"3575"},{"description":"Order number, matched exactly.","key":"order_number[]","value":"OR-4958B4AE"},{"description":"Shipment id, when known. Prefer `shipment_reference[]` for human input.","key":"shipment_id[]","value":"3575"},{"description":"Shipment reference, matched exactly.","key":"shipment_reference[]","value":"SH-900BDCE7"},{"description":"Batch shipment id. Batch calls cover many orders, so they carry a batch id instead of an order.","key":"batch_id","value":"2496"},{"description":"User who triggered the call. Absent for system-triggered calls such as label pre-generation.","key":"user_id[]","value":"3575"},{"description":"`true` returns successful calls only, `false` returns failed attempts only.","key":"response_success","value":"false"},{"description":"Start of the time range. Defaults to 30 days ago.","key":"date_start","value":"1995-08-02T07:47:17.544Z"},{"description":"End of the time range. Must not be earlier than `date_start`.","key":"date_end","value":"1995-08-02T07:47:17.544Z"},{"key":"sort_by","value":"timestamp"},{"key":"sort_direction","value":"desc"},{"description":"Cursor from the previous response's `meta.next_cursor`.","key":"cursor","value":"string"}],"variable":[{"key":"company_id","value":"2496","description":"The company the token belongs to."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/problem+json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 2940,\n \"detail\": \"string\"\n}"},{"id":"ac25183e-b56d-4e44-8cf7-57345341bc34","name":"One or more query parameters are invalid.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/problem+json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://app-api.helmwms.app/api/v2/companies/:company_id/courier-logs?action[]=shipment.create&courier_key[]=string&courier_id[]=3575&courier_service_id[]=3575&order_id[]=3575&order_number[]=OR-4958B4AE&shipment_id[]=3575&shipment_reference[]=SH-900BDCE7&batch_id=2496&user_id[]=3575&response_success=false&date_start=1995-08-02T07:47:17.544Z&date_end=1995-08-02T07:47:17.544Z&sort_by=timestamp&sort_direction=desc&cursor=string","host":["https://app-api.helmwms.app/api/v2"],"path":["companies",":company_id","courier-logs"],"query":[{"description":"Courier action to include.","key":"action[]","value":"shipment.create"},{"description":"Courier key, e.g. `RoyalMail`.","key":"courier_key[]","value":"string"},{"description":"Courier record id.","key":"courier_id[]","value":"3575"},{"description":"Courier service id.","key":"courier_service_id[]","value":"3575"},{"description":"Order id, when known. Prefer `order_number[]` for human input.","key":"order_id[]","value":"3575"},{"description":"Order number, matched exactly.","key":"order_number[]","value":"OR-4958B4AE"},{"description":"Shipment id, when known. Prefer `shipment_reference[]` for human input.","key":"shipment_id[]","value":"3575"},{"description":"Shipment reference, matched exactly.","key":"shipment_reference[]","value":"SH-900BDCE7"},{"description":"Batch shipment id. Batch calls cover many orders, so they carry a batch id instead of an order.","key":"batch_id","value":"2496"},{"description":"User who triggered the call. Absent for system-triggered calls such as label pre-generation.","key":"user_id[]","value":"3575"},{"description":"`true` returns successful calls only, `false` returns failed attempts only.","key":"response_success","value":"false"},{"description":"Start of the time range. Defaults to 30 days ago.","key":"date_start","value":"1995-08-02T07:47:17.544Z"},{"description":"End of the time range. Must not be earlier than `date_start`.","key":"date_end","value":"1995-08-02T07:47:17.544Z"},{"key":"sort_by","value":"timestamp"},{"key":"sort_direction","value":"desc"},{"description":"Cursor from the previous response's `meta.next_cursor`.","key":"cursor","value":"string"}],"variable":[{"key":"company_id","value":"2496","description":"The company the token belongs to."}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/problem+json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 2940,\n \"detail\": \"string\"\n}"},{"id":"63f95c05-2a4a-48d0-af44-c0b65e15ae4a","name":"Rate limit exceeded.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/problem+json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://app-api.helmwms.app/api/v2/companies/:company_id/courier-logs?action[]=shipment.create&courier_key[]=string&courier_id[]=3575&courier_service_id[]=3575&order_id[]=3575&order_number[]=OR-4958B4AE&shipment_id[]=3575&shipment_reference[]=SH-900BDCE7&batch_id=2496&user_id[]=3575&response_success=false&date_start=1995-08-02T07:47:17.544Z&date_end=1995-08-02T07:47:17.544Z&sort_by=timestamp&sort_direction=desc&cursor=string","host":["https://app-api.helmwms.app/api/v2"],"path":["companies",":company_id","courier-logs"],"query":[{"description":"Courier action to include.","key":"action[]","value":"shipment.create"},{"description":"Courier key, e.g. `RoyalMail`.","key":"courier_key[]","value":"string"},{"description":"Courier record id.","key":"courier_id[]","value":"3575"},{"description":"Courier service id.","key":"courier_service_id[]","value":"3575"},{"description":"Order id, when known. Prefer `order_number[]` for human input.","key":"order_id[]","value":"3575"},{"description":"Order number, matched exactly.","key":"order_number[]","value":"OR-4958B4AE"},{"description":"Shipment id, when known. Prefer `shipment_reference[]` for human input.","key":"shipment_id[]","value":"3575"},{"description":"Shipment reference, matched exactly.","key":"shipment_reference[]","value":"SH-900BDCE7"},{"description":"Batch shipment id. Batch calls cover many orders, so they carry a batch id instead of an order.","key":"batch_id","value":"2496"},{"description":"User who triggered the call. Absent for system-triggered calls such as label pre-generation.","key":"user_id[]","value":"3575"},{"description":"`true` returns successful calls only, `false` returns failed attempts only.","key":"response_success","value":"false"},{"description":"Start of the time range. Defaults to 30 days ago.","key":"date_start","value":"1995-08-02T07:47:17.544Z"},{"description":"End of the time range. Must not be earlier than `date_start`.","key":"date_end","value":"1995-08-02T07:47:17.544Z"},{"key":"sort_by","value":"timestamp"},{"key":"sort_direction","value":"desc"},{"description":"Cursor from the previous response's `meta.next_cursor`.","key":"cursor","value":"string"}],"variable":[{"key":"company_id","value":"2496","description":"The company the token belongs to."}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/problem+json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 2940,\n \"detail\": \"string\"\n}"}],"_postman_id":"daf79466-0a6a-4845-be75-551160268787"}],"id":"0eaaf338-8040-4d66-a0be-c6503931b2f9","description":"

Couriers — 28 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"0eaaf338-8040-4d66-a0be-c6503931b2f9","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Currencies","item":[{"name":"Company currencies list","id":"b6d1bef9-ef58-49e9-91f5-7f38a0724e36","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//company-currencies","description":"

The currencies this company has enabled. Send a currency_id from here\nwherever a field is validated against the company's currencies - supplier\nsettings.currency_id is the common one. These are the same identifiers as\nthe global currency list returns, restricted to the ones this company\naccepts, so an id that is valid globally is not necessarily valid here.

Not every currency field is scoped this way: the order, shipping and\ndespatch-target rule builders validate against the global list instead, and\naccept any currency.

rate is rebased against this company's base currency, the row whose\nis_base is true. That makes the base row's own rate 1, unless it carries a\nfixed or formula rate of its own.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"b6d1bef9-ef58-49e9-91f5-7f38a0724e36"},{"name":"Currencies list","id":"aca75835-d4a0-4844-a837-4e6c21b7ce88","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//currencies","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`base`	—
`name`	Filter by Name.
`code`	Filter by Code.

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Code.

\n","type":"text/plain"},"key":"code","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"aca75835-d4a0-4844-a837-4e6c21b7ce88"},{"name":"Display the specified currency with its base-rebased rate","id":"47b88331-3fd0-462e-8584-735164e7170b","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//currencies/:currencyID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`currencyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`base`	—

Currencies — 3 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"fcd92f6d-8a59-43cd-ba9c-d04ebe98ae1a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Custom Fields","item":[{"name":"Custom fields types","id":"ae862444-2aac-49b9-9838-e48c484bfa72","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//custom-fields/types","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`filter[query]`	—
`filter[search]`	—
`filter[custom_field_type_id]`	Options: `1`, `2`, `3`, `4`, `5`, `6`
`filter[custom_field_group_type_id]`	Options: `1`, `2`, `3`, `4`, `5`
`query`	Filter by Query.
`search`	Filter by Search.
`custom_field_type_id`	Filter by Custom Field Type Id.
`custom_field_group_type_id`	Filter by Custom Field Group Type Id.
`inventory_id`	Filter by Inventory Id.
`order_id`	Filter by Order Id.
`customer_id`	Filter by Customer Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Search.

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

Filter by Custom Field Type Id.

\n","type":"text/plain"},"key":"custom_field_type_id","value":""},{"disabled":true,"description":{"content":"

Filter by Custom Field Group Type Id.

\n","type":"text/plain"},"key":"custom_field_group_type_id","value":""},{"disabled":true,"description":{"content":"

Filter by Inventory Id.

\n","type":"text/plain"},"key":"inventory_id","value":""},{"disabled":true,"description":{"content":"

Filter by Order Id.

\n","type":"text/plain"},"key":"order_id","value":""},{"disabled":true,"description":{"content":"

Filter by Customer Id.

\n","type":"text/plain"},"key":"customer_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"3096064b-0ed4-465c-8e6f-6786449fc9f7"},{"name":"Custom fields create","id":"b6d510f4-b144-45a6-9b41-ce910b78ea51","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"custom_field_type_id\": \"1\",\n \"custom_field_group_type_id\": \"1\",\n \"name\": \"name\",\n \"options\": [\n {\n \"name\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//custom-fields","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`custom_field_type_id`	string	yes	Allowed: `1`, `2`, `3`, `4`, `5`, `6`
`custom_field_group_type_id`	string	yes	CustomFieldGroupTypes values: - `1` = INVENTORY - `2` = ORDERS - `3` = PURCHASE_ORDERS - `4` = CUSTOMER - `5` = SUPPLIERS Allowed: `1`, `2`, `3`, `4`, `5`
`name`	string	yes	—
`options`	array	no	—
`options.*.name`	string	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`customFieldID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`custom_field_id`	integer	yes	Route-injected (validationData()) so the reused CustomFieldService::update receives it via validated(). Intentionally NOT a company-scoped Rule::exists: ownership is gated by the controller's pre-resolve abort_if(404), keeping a cross-tenant id a canonical 404 (not a 422). See class docblock (BOLA).
`custom_field_type_id`	string	yes	Allowed: `1`, `2`, `3`, `4`, `5`, `6`
`name`	string	yes	—
`options`	array	no	—
`options.*.option_id`	integer	no	—
`options.*.name`	string	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`relationID`	integer	yes
`customFieldGroupTypeID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`custom_field_group_type_id`	Options: `1`, `2`, `4`, `5`
`relation_id`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[{"id":"2773050f-71f9-4ee0-b2e0-c658f47c33b4","type":"any","value":"","key":"relationID"},{"id":"7065485f-c331-4da6-85e7-69a9d8501430","type":"any","value":"","key":"customFieldGroupTypeID"}]}},"response":[],"_postman_id":"b8fec83d-e0ca-4b01-aef4-3eb289fcd000"},{"name":"Custom fields relations bulk update","id":"a1353802-dcae-4c67-bb62-6eb05fea7ba2","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"custom_field_group_type_id\": \"1\",\n \"relation_id\": \"{{relation_id}}\",\n \"fields\": [\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//custom-fields/relations/:relationID/bulk-update","description":"

Rate limit: 20 requests/minute, per token, for this endpoint. Each endpoint has its own independent budget. Exceeding it returns 429 Too Many Requests with Retry-After and X-RateLimit-* headers.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`relationID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`custom_field_group_type_id`	string	yes	CustomFieldGroupTypes values: - `1` = INVENTORY - `2` = ORDERS - `4` = CUSTOMER - `5` = SUPPLIERS Allowed: `1`, `2`, `4`, `5`
`relation_id`	string	no	—
`fields`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`relationID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`custom_field_group_type_id`	Options: `1`, `2`, `4`, `5`
`relation_id`	—
`all`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`relationID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`custom_field_group_type_id`	string	yes	CustomFieldGroupTypes values: - `1` = INVENTORY - `2` = ORDERS - `4` = CUSTOMER - `5` = SUPPLIERS Allowed: `1`, `2`, `4`, `5`
`relation_id`	string	no	—
`custom_field_type_id`	string	yes	Allowed: `1`, `2`, `3`, `4`, `5`, `6`
`custom_field_id`	integer	yes	—
`value`	boolean	no	—
`custom_field_option_id`	integer	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`relationID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`custom_field_group_type_id`	Options: `1`, `2`, `4`, `5`
`relation_id`	—
`custom_field_value_id`	—

Custom Fields — 9 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"b764a5a7-49fd-49a4-8f32-bde38501786b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Customers","item":[{"name":"Customers types","id":"d95a7871-3e3f-4352-b314-6b40d3c80ac1","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//customers/types","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`customers`	array	yes	—
`customers.*.type`	string	yes	Allowed: `1`, `2`
`customers.*.name`	string	yes	—
`customers.*.surname`	string \| null	no	—
`customers.*.phone`	string \| null	no	—
`customers.*.tags`	array \| null	no	—
`customers.*.file_manager_id`	integer \| null	no	—
`customers.*.addresses`	array \| null	no	—
`customers..addresses..company_name`	string \| null	no	—
`customers..addresses..name`	string \| null	no	—
`customers..addresses..surname`	string \| null	no	—
`customers..addresses..phone`	string \| null	no	—
`customers..addresses..email`	string \| null	no	—
`customers..addresses..address_line_1`	string	yes	—
`customers..addresses..address_line_2`	string \| null	no	—
`customers..addresses..address_line_3`	string \| null	no	—
`customers..addresses..city`	string	yes	—
`customers..addresses..county`	string \| null	no	—
`customers..addresses..country_id`	integer	yes	—
`customers..addresses..postcode`	string \| null	no	—
`customers..addresses..vat_number`	string \| null	no	—
`customers..addresses..eori`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`customers`	array	yes	—
`customers.*.customer_id`	integer	yes	—
`customers.*.type`	string	yes	Allowed: `1`, `2`
`customers.*.name`	string	yes	—
`customers.*.surname`	string \| null	no	—
`customers.*.phone`	string \| null	no	—
`customers.*.tags`	array \| null	no	—
`customers.*.addresses`	array \| null	no	—
`customers..addresses..company_name`	string \| null	no	—
`customers..addresses..name`	string \| null	no	—
`customers..addresses..surname`	string \| null	no	—
`customers..addresses..phone`	string \| null	no	—
`customers..addresses..email`	string \| null	no	—
`customers..addresses..address_line_1`	string	yes	—
`customers..addresses..address_line_2`	string \| null	no	—
`customers..addresses..address_line_3`	string \| null	no	—
`customers..addresses..city`	string	yes	—
`customers..addresses..county`	string \| null	no	—
`customers..addresses..country_id`	integer	yes	—
`customers..addresses..postcode`	string \| null	no	—
`customers..addresses..vat_number`	string \| null	no	—
`customers..addresses..eori`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`customer_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`customer_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`customer_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`archived`	Filter by Archived.
`search`	Filter by Search.
`id`	Filter by Id.
`tags`	Filter by Tags.
`customer_type`	Filter by Customer Type.
`last_ordered_date_from`	Filter by Last Ordered Date From.
`last_ordered_date_to`	Filter by Last Ordered Date To.
`average_spend_from`	Filter by Average Spend From.
`average_spend_to`	Filter by Average Spend To.
`total_spend_from`	Filter by Total Spend From.
`total_spend_to`	Filter by Total Spend To.
`total_orders_from`	Filter by Total Orders From.
`total_orders_to`	Filter by Total Orders To.
`name`	Filter by Name.
`postcode`	Filter by Postcode.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

customerContacts
customerAddresses
tags
notes
orders
statistic
fileManager
customFields
customFields.customFieldOption

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Archived.

\n","type":"text/plain"},"key":"archived","value":""},{"disabled":true,"description":{"content":"

Filter by Search.

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Tags.

\n","type":"text/plain"},"key":"tags","value":""},{"disabled":true,"description":{"content":"

Filter by Customer Type.

\n","type":"text/plain"},"key":"customer_type","value":""},{"disabled":true,"description":{"content":"

Filter by Last Ordered Date From.

\n","type":"text/plain"},"key":"last_ordered_date_from","value":""},{"disabled":true,"description":{"content":"

Filter by Last Ordered Date To.

\n","type":"text/plain"},"key":"last_ordered_date_to","value":""},{"disabled":true,"description":{"content":"

Filter by Average Spend From.

\n","type":"text/plain"},"key":"average_spend_from","value":""},{"disabled":true,"description":{"content":"

Filter by Average Spend To.

\n","type":"text/plain"},"key":"average_spend_to","value":""},{"disabled":true,"description":{"content":"

Filter by Total Spend From.

\n","type":"text/plain"},"key":"total_spend_from","value":""},{"disabled":true,"description":{"content":"

Filter by Total Spend To.

\n","type":"text/plain"},"key":"total_spend_to","value":""},{"disabled":true,"description":{"content":"

Filter by Total Orders From.

\n","type":"text/plain"},"key":"total_orders_from","value":""},{"disabled":true,"description":{"content":"

Filter by Total Orders To.

\n","type":"text/plain"},"key":"total_orders_to","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Postcode.

\n","type":"text/plain"},"key":"postcode","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - customerContacts - customerAddresses - tags - notes - orders - statistic - fileManager - customFields - customFields.customFieldOption

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"c247e991-e164-4e09-803f-a94db866039e"},{"name":"Customers create","id":"e4040f53-bc1d-4cba-b54d-1d57c827378a","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"type\": \"1\",\n \"name\": \"name\",\n \"surname\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"file_manager_id\": \"{{file_manager_id}}\",\n \"tags\": [\n \"\"\n ],\n \"addresses\": [\n {\n \"company_name\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"phone\": \"\",\n \"email\": \"user@example.com\",\n \"address_line_1\": \"address_line_1\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"city\": \"city\",\n \"county\": \"\",\n \"country_id\": \"{{country_id}}\",\n \"postcode\": \"\",\n \"vat_number\": \"\",\n \"eori\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//customers","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`type`	string	yes	Allowed: `1`, `2`
`name`	string	yes	—
`surname`	string \| null	no	—
`email`	string	yes	—
`phone`	string \| null	no	—
`file_manager_id`	integer \| null	no	—
`tags`	array \| null	no	—
`addresses`	array \| null	no	—
`addresses.*.company_name`	string \| null	no	—
`addresses.*.name`	string \| null	no	—
`addresses.*.surname`	string \| null	no	—
`addresses.*.phone`	string \| null	no	—
`addresses.*.email`	string \| null	no	—
`addresses.*.address_line_1`	string	yes	—
`addresses.*.address_line_2`	string \| null	no	—
`addresses.*.address_line_3`	string \| null	no	—
`addresses.*.city`	string	yes	—
`addresses.*.county`	string \| null	no	—
`addresses.*.country_id`	integer	yes	—
`addresses.*.postcode`	string \| null	no	—
`addresses.*.vat_number`	string \| null	no	—
`addresses.*.eori`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`customerID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

customerContacts
customerAddresses
tags
notes
orders
statistic
fileManager
customFields
customFields.customFieldOption

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"c9123ab2-399f-4ab6-b6df-95f10b67845c","type":"any","value":"","key":"customerID"}]}},"response":[],"_postman_id":"615c6a36-27a2-4f82-8c14-d285742dc6dd"},{"name":"Customers update","id":"03b61482-883f-455d-9a1d-e6f28cfce09a","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"customer_id\": \"{{customer_id}}\",\n \"type\": \"1\",\n \"name\": \"name\",\n \"surname\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"file_manager_id\": \"{{file_manager_id}}\",\n \"tags\": [\n \"\"\n ],\n \"addresses\": [\n {\n \"id\": \"{{id}}\",\n \"company_name\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"phone\": \"\",\n \"email\": \"user@example.com\",\n \"address_line_1\": \"address_line_1\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"city\": \"city\",\n \"county\": \"\",\n \"country_id\": \"{{country_id}}\",\n \"postcode\": \"\",\n \"vat_number\": \"\",\n \"eori\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//customers/:customerID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`customerID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`customer_id`	string	yes	—
`type`	string	yes	Allowed: `1`, `2`
`name`	string	yes	—
`surname`	string \| null	no	—
`email`	string	yes	—
`phone`	string \| null	no	—
`file_manager_id`	string \| null	no	—
`tags`	array \| null	no	—
`addresses`	array \| null	no	—
`addresses.*.id`	string \| null	no	—
`addresses.*.company_name`	string \| null	no	—
`addresses.*.name`	string \| null	no	—
`addresses.*.surname`	string \| null	no	—
`addresses.*.phone`	string \| null	no	—
`addresses.*.email`	string \| null	no	—
`addresses.*.address_line_1`	string	yes	—
`addresses.*.address_line_2`	string \| null	no	—
`addresses.*.address_line_3`	string \| null	no	—
`addresses.*.city`	string	yes	—
`addresses.*.county`	string \| null	no	—
`addresses.*.country_id`	integer	yes	—
`addresses.*.postcode`	string \| null	no	—
`addresses.*.vat_number`	string \| null	no	—
`addresses.*.eori`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`customerID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`customer_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`customerID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`customer_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`customerID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`customer_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`customerID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`customer_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`customerID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`customer_id`	integer	yes	—
`name`	string	yes	—
`email`	string	yes	—
`phone`	string \| null	no	—
`file_manager_id`	integer \| null	no	—
`vat_number`	string \| null	no	—
`eori`	string \| null	no	—

The reused service returns a plain ->get() collection (not a paginator), so\nit does NOT auto-wrap — wrap explicitly under data.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`customerID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`customer_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`customerID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`postcode`	Filter by Postcode.
`archive`	Filter by Archive.
`customer_id`	Filter by Customer Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

customer
address
contact

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Postcode.

\n","type":"text/plain"},"key":"postcode","value":""},{"disabled":true,"description":{"content":"

Filter by Archive.

\n","type":"text/plain"},"key":"archive","value":""},{"disabled":true,"description":{"content":"

Filter by Customer Id.

\n","type":"text/plain"},"key":"customer_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - customer - address - contact

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"269818d2-d546-4ca5-8909-7330c6bc6bdc","type":"any","value":"","key":"customerID"}]}},"response":[],"_postman_id":"6aa4b7c3-a9ac-43e0-91b0-26b5e5f4a702"},{"name":"Customers addresses create","id":"00f372ab-d7b9-49f9-a41e-281635132ccb","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"customer_id\": \"{{customer_id}}\",\n \"ship_to_somebody_else\": false,\n \"company_name\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"phone\": \"\",\n \"email\": \"user@example.com\",\n \"address_line_1\": \"address_line_1\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"city\": \"city\",\n \"county\": \"\",\n \"country_id\": \"{{country_id}}\",\n \"postcode\": \"\",\n \"vat_number\": \"\",\n \"eori\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//customers/:customerID/addresses","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`customerID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`customer_id`	integer	yes	—
`ship_to_somebody_else`	boolean	yes	—
`company_name`	string \| null	no	—
`name`	string \| null	no	—
`surname`	string \| null	no	—
`phone`	string \| null	no	—
`email`	string \| null	no	—
`address_line_1`	string	yes	—
`address_line_2`	string \| null	no	—
`address_line_3`	string \| null	no	—
`city`	string	yes	—
`county`	string \| null	no	—
`country_id`	integer	yes	—
`postcode`	string \| null	no	—
`vat_number`	string \| null	no	—
`eori`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`customerID`	integer	yes
`addressID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

customer
address
contact

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - customer - address - contact

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"d16e0a12-10a1-4164-996d-f7e481ce87d1","type":"any","value":"","key":"customerID"},{"id":"9ec1f7df-1d16-4298-84fe-3581faad7616","type":"any","value":"","key":"addressID"}]}},"response":[],"_postman_id":"b9119bbe-ed94-47e3-923e-9a098a42112a"},{"name":"Customers addresses update","id":"7ab65e90-7c77-44cc-af1d-ae94063a23f3","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"customer_id\": \"{{customer_id}}\",\n \"address_id\": \"{{address_id}}\",\n \"ship_to_somebody_else\": false,\n \"company_name\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"phone\": \"\",\n \"email\": \"user@example.com\",\n \"address_line_1\": \"address_line_1\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"city\": \"city\",\n \"county\": \"\",\n \"country_id\": \"{{country_id}}\",\n \"postcode\": \"\",\n \"vat_number\": \"\",\n \"eori\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//customers/:customerID/addresses/:addressID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`customerID`	integer	yes
`addressID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`customer_id`	integer	yes	—
`address_id`	integer	yes	—
`ship_to_somebody_else`	boolean	yes	—
`company_name`	string \| null	no	—
`name`	string \| null	no	—
`surname`	string \| null	no	—
`phone`	string \| null	no	—
`email`	string \| null	no	—
`address_line_1`	string	yes	—
`address_line_2`	string \| null	no	—
`address_line_3`	string \| null	no	—
`city`	string	yes	—
`county`	string \| null	no	—
`country_id`	integer	yes	—
`postcode`	string \| null	no	—
`vat_number`	string \| null	no	—
`eori`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`customerID`	integer	yes
`addressID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`customer_id`	—
`address_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`customerID`	integer	yes
`addressID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`customer_id`	integer	yes	—
`address_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`customerID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`archive`	Filter by Archive.
`company_customer_id`	Filter by Company Customer Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

companyCustomer
customer
contact
fileManager

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Archive.

\n","type":"text/plain"},"key":"archive","value":""},{"disabled":true,"description":{"content":"

Filter by Company Customer Id.

\n","type":"text/plain"},"key":"company_customer_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - companyCustomer - customer - contact - fileManager

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"588f5188-717b-4f9d-a1ec-b18eb3f3aebe","type":"any","value":"","key":"customerID"}]}},"response":[],"_postman_id":"de863b0e-c8d7-4eed-9545-f099577ffc0e"},{"name":"Customers contacts create","id":"d2faa9e2-c9b7-478e-8f2e-d1b2d9996a85","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"company_customer_id\": \"{{company_customer_id}}\",\n \"name\": \"name\",\n \"surname\": \"surname\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"file_manager_id\": \"{{file_manager_id}}\",\n \"title\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//customers/:customerID/contacts","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`customerID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`company_customer_id`	integer	yes	—
`name`	string	yes	—
`surname`	string	yes	—
`email`	string	yes	—
`phone`	string \| null	no	—
`file_manager_id`	integer \| null	no	—
`title`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`customerID`	integer	yes
`contactID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

companyCustomer
customer
contact
fileManager

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - companyCustomer - customer - contact - fileManager

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"7474e272-b2df-43a4-8f29-fae23c7ae9ba","type":"any","value":"","key":"customerID"},{"id":"d8e723ba-215c-4b06-bfbe-b4a5ea80f720","type":"any","value":"","key":"contactID"}]}},"response":[],"_postman_id":"9c697b90-d698-4533-b10d-076eb523f4f5"},{"name":"Customers contacts update","id":"5638b479-db01-4d4e-9cce-b0d7a4bf6e40","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"company_customer_id\": \"{{company_customer_id}}\",\n \"contact_id\": \"{{contact_id}}\",\n \"name\": \"name\",\n \"surname\": \"surname\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"file_manager_id\": \"{{file_manager_id}}\",\n \"title\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//customers/:customerID/contacts/:contactID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`customerID`	integer	yes
`contactID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`company_customer_id`	integer	yes	—
`contact_id`	integer	yes	—
`name`	string	yes	—
`surname`	string	yes	—
`email`	string	yes	—
`phone`	string \| null	no	—
`file_manager_id`	integer \| null	no	—
`title`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`customerID`	integer	yes
`contactID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`company_customer_id`	—
`contact_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`customerID`	integer	yes
`contactID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`company_customer_id`	integer	yes	—
`contact_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`customerID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`customer_id`	Filter by Customer Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

customer
user

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Customer Id.

\n","type":"text/plain"},"key":"customer_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - customer - user

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"c5605abf-4fe1-47b2-96d7-578ce9aebddb","type":"any","value":"","key":"customerID"}]}},"response":[],"_postman_id":"fe644990-85e4-453a-88c7-0bb45b9a2a99"},{"name":"Customers notes create","id":"b44e4d07-064f-471e-a311-a1ef7f835793","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"customer_id\": \"{{customer_id}}\",\n \"note\": \"note\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//customers/:customerID/notes","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`customerID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`customer_id`	integer	yes	—
`note`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`customerID`	integer	yes
`noteID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`customer_id`	—
`note_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`customerID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`customer_id`	Filter by Customer Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

company
customer
tag

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Customer Id.

\n","type":"text/plain"},"key":"customer_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - company - customer - tag

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"a5a6cb49-2dd4-4d11-8f22-4449e6761b3d","type":"any","value":"","key":"customerID"}]}},"response":[],"_postman_id":"c8b70eb8-ddca-4df2-a93a-57ad88d0e32b"},{"name":"Customers tags create","id":"556d50a6-ab1c-499f-8f17-45c5177dcfe5","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"customer_id\": \"{{customer_id}}\",\n \"name\": \"name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//customers/:customerID/tags","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`customerID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`customer_id`	integer	yes	—
`name`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`customerID`	integer	yes
`tagID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`customer_id`	integer	yes	—
`tag_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`customerID`	integer	yes
`tagID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`customer_id`	—
`tag_id`	—

Customers — 35 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"f66935f5-50dd-44ba-ae5c-ec84bc7eecfa","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Dashboard","item":[{"name":"Dashboard costdashboard figures","id":"bf1ef671-d661-4618-b88a-abb7eb630a3c","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//dashboard/costdashboard/figures?start_time=&end_time=","description":"

Full Mode only. This endpoint needs Full Mode (advanced stock control) on the company's primary warehouse. A company in Basic Mode has no warehouse locations, so the request is rejected with 403 Forbidden before it reaches the resource. Switch the warehouse to Full Mode in Settings to use it.

Rate limit: 30 requests/minute, per token, for this endpoint. Each endpoint has its own independent budget. Exceeding it returns 429 Too Many Requests with Retry-After and X-RateLimit-* headers.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`start_time`	—
`end_time`	—
`compare_start_time`	—
`compare_end_time`	—
`include[]`	Options: `picking`, `packing`, `receiving`, `movement`, `inventory_check`, `storage`, `courier`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`start_time`	—
`end_time`	—
`compare_start_time`	—
`compare_end_time`	—
`include[]`	Options: `picking`, `packing`, `receiving`, `movement`, `inventory_check`, `storage`, `courier`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`start_time`	—
`end_time`	—
`compare_start_time`	—
`compare_end_time`	—
`view`	Options: `department`, `job`
`limit`	—
`include[]`	Options: `picking`, `packing`, `receiving`, `movement`, `inventory_check`, `storage`, `courier`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`start_time`	—
`end_time`	—
`compare_start_time`	—
`compare_end_time`	—
`group_by`	Options: `daily`, `weekly`, `monthly`
`include[]`	Options: `picking`, `packing`, `receiving`, `movement`, `inventory_check`, `storage`, `courier`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`start_time`	—
`end_time`	—
`compare_start_time`	—
`compare_end_time`	—
`include[]`	Options: `picking`, `packing`, `receiving`, `movement`, `inventory_check`, `storage`, `courier`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`start_time`	—
`end_time`	—
`compare_start_time`	—
`compare_end_time`	—
`view`	Options: `supplier`, `store`, `channel`, `client`, `customer`, `top_products`
`limit`	—
`include[]`	Options: `picking`, `packing`, `receiving`, `movement`, `inventory_check`, `storage`, `courier`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`start_time`	—
`end_time`	—
`compare_start_time`	—
`compare_end_time`	—
`view`	Options: `courier`, `store`, `channel`, `service`, `courier_service`
`limit`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`statuses[]`	Options: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`status`	Options: `delivered`, `late`, `exception`, `failed`
`date_start`	—
`date_end`	—
`has_comparison`	Required. Accepted values are 1 and 0; the literal words true and false are rejected. Send 1 to add a comparison range, which makes comparison_date_start and comparison_date_end required: comparison_date_start must fall before date_start, and comparison_date_end between comparison_date_start and date_end, so the two ranges may overlap. Send 0 for no comparison, and the comparison is left out of the response and both bounds ignored, valid or not.
`comparison_date_start`	—
`comparison_date_end`	—

Required. Accepted values are 1 and 0; the literal words true and false are rejected. Send 1 to add a comparison range, which makes comparison_date_start and comparison_date_end required: comparison_date_start must fall before date_start, and comparison_date_end between comparison_date_start and date_end, so the two ranges may overlap. Send 0 for no comparison, and the comparison is left out of the response and both bounds ignored, valid or not.

\n","type":"text/plain"},"key":"has_comparison","value":""},{"disabled":true,"key":"comparison_date_start","value":""},{"disabled":true,"key":"comparison_date_end","value":""}],"variable":[]}},"response":[],"_postman_id":"a73d2a50-8dae-429e-9b59-364632e05583"},{"name":"Dashboard customer care shipment performance by country","id":"748cf913-b0a5-47ad-ae3e-5ce8e238dc1b","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//dashboard/customer-care/shipment-performance-by-country?country_id=&date_start=&date_end=&has_comparison=","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`country_id`	—
`date_start`	—
`date_end`	—
`has_comparison`	Required. Accepted values are 1 and 0; the literal words true and false are rejected. Send 1 to add a comparison range, which makes comparison_date_start and comparison_date_end required: comparison_date_start must fall before date_start, and comparison_date_end between comparison_date_start and date_end, so the two ranges may overlap. Send 0 for no comparison, and the comparison is left out of the response, but any bounds you send are still validated.
`comparison_date_start`	—
`comparison_date_end`	—

\n","type":"text/plain"},"key":"has_comparison","value":""},{"disabled":true,"key":"comparison_date_start","value":""},{"disabled":true,"key":"comparison_date_end","value":""}],"variable":[]}},"response":[],"_postman_id":"748cf913-b0a5-47ad-ae3e-5ce8e238dc1b"},{"name":"Dashboard customer care orders vs returns","id":"95b5567a-da39-4e4b-a1c1-3025db186630","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//dashboard/customer-care/orders-vs-returns?date_start=&date_end=&has_comparison=","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`date_start`	—
`date_end`	—
`has_comparison`	Required. Accepted values are 1 and 0; the literal words true and false are rejected. Send 1 to add a comparison range, which makes comparison_date_start and comparison_date_end required: comparison_date_start must fall before date_start, and comparison_date_end between comparison_date_start and date_end, so the two ranges may overlap. Send 0 for no comparison, and the comparison is left out of the response and both bounds ignored, valid or not.
`comparison_date_start`	—
`comparison_date_end`	—

\n","type":"text/plain"},"key":"has_comparison","value":""},{"disabled":true,"key":"comparison_date_start","value":""},{"disabled":true,"key":"comparison_date_end","value":""}],"variable":[]}},"response":[],"_postman_id":"95b5567a-da39-4e4b-a1c1-3025db186630"},{"name":"Dashboard customer care delivery performance by courier","id":"b5b79a7c-4636-4f9a-a3c7-6d25374fb532","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//dashboard/customer-care/delivery-performance-by-courier?type=&date_start=&date_end=","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`type`	Options: `courier`, `service`
`date_start`	—
`date_end`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`statuses[]`	Options: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`limit`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`date_start`	—
`date_end`	—
`has_comparison`	Required. Accepted values are 1 and 0; the literal words true and false are rejected. Send 1 to add a comparison range, which makes comparison_date_start and comparison_date_end required: comparison_date_start must fall before date_start, and comparison_date_end between comparison_date_start and date_end, so the two ranges may overlap. Send 0 for no comparison, and the comparison is left out of the response, but any bounds you send are still validated.
`comparison_date_start`	—
`comparison_date_end`	—

\n","type":"text/plain"},"key":"has_comparison","value":""},{"disabled":true,"key":"comparison_date_start","value":""},{"disabled":true,"key":"comparison_date_end","value":""}],"variable":[]}},"response":[],"_postman_id":"61e2feab-4883-406a-adc6-54469d2bcb2d"},{"name":"Dashboard overview revenue","id":"5628f88b-6372-4e96-8b10-a08c7624c3d3","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//dashboard/overview/revenue?date_start=&date_end=&has_comparison=","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`date_start`	—
`date_end`	—
`has_comparison`	Required. Accepted values are 1 and 0; the literal words true and false are rejected. Send 1 to add a comparison range, which makes comparison_date_start and comparison_date_end required: comparison_date_start must fall before date_start, and comparison_date_end between comparison_date_start and date_end, so the two ranges may overlap. Send 0 for no comparison, and the comparison is left out of the response and both bounds ignored, valid or not.
`comparison_date_start`	—
`comparison_date_end`	—

\n","type":"text/plain"},"key":"has_comparison","value":""},{"disabled":true,"key":"comparison_date_start","value":""},{"disabled":true,"key":"comparison_date_end","value":""}],"variable":[]}},"response":[],"_postman_id":"5628f88b-6372-4e96-8b10-a08c7624c3d3"},{"name":"Dashboard overview top channels","id":"45a22998-9740-451c-88f2-9657ca57abfc","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//dashboard/overview/top-channels?date_start=&date_end=&has_comparison=","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`date_start`	—
`date_end`	—
`has_comparison`	Required. Accepted values are 1 and 0; the literal words true and false are rejected. Send 1 to add a comparison range, which makes comparison_date_start and comparison_date_end required: comparison_date_start must fall before date_start, and comparison_date_end between comparison_date_start and date_end, so the two ranges may overlap. Send 0 for no comparison, and the comparison is left out of the response and both bounds ignored, valid or not.
`comparison_date_start`	—
`comparison_date_end`	—
`limit`	—

\n","type":"text/plain"},"key":"has_comparison","value":""},{"disabled":true,"key":"comparison_date_start","value":""},{"disabled":true,"key":"comparison_date_end","value":""},{"disabled":true,"key":"limit","value":""}],"variable":[]}},"response":[],"_postman_id":"45a22998-9740-451c-88f2-9657ca57abfc"},{"name":"Dashboard overview top couriers","id":"7028a547-d068-47c7-9040-f1850d4387b9","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//dashboard/overview/top-couriers?date_start=&date_end=&has_comparison=","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`date_start`	—
`date_end`	—
`has_comparison`	Required. Accepted values are 1 and 0; the literal words true and false are rejected. Send 1 to add a comparison range, which makes comparison_date_start and comparison_date_end required: comparison_date_start must fall before date_start, and comparison_date_end between comparison_date_start and date_end, so the two ranges may overlap. Send 0 for no comparison, and the comparison is left out of the response and both bounds ignored, valid or not.
`comparison_date_start`	—
`comparison_date_end`	—
`limit`	—

\n","type":"text/plain"},"key":"has_comparison","value":""},{"disabled":true,"key":"comparison_date_start","value":""},{"disabled":true,"key":"comparison_date_end","value":""},{"disabled":true,"key":"limit","value":""}],"variable":[]}},"response":[],"_postman_id":"7028a547-d068-47c7-9040-f1850d4387b9"},{"name":"Dashboard overview top products","id":"f9e67f1c-a475-472b-8a98-0c0f8510a198","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//dashboard/overview/top-products?date_start=&date_end=&has_comparison=","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`date_start`	—
`date_end`	—
`has_comparison`	Required. Accepted values are 1 and 0; the literal words true and false are rejected. Send 1 to add a comparison range, which makes comparison_date_start and comparison_date_end required: comparison_date_start must fall before date_start, and comparison_date_end between comparison_date_start and date_end, so the two ranges may overlap. Send 0 for no comparison, and the comparison is left out of the response and both bounds ignored, valid or not.
`comparison_date_start`	—
`comparison_date_end`	—
`limit`	—

\n","type":"text/plain"},"key":"has_comparison","value":""},{"disabled":true,"key":"comparison_date_start","value":""},{"disabled":true,"key":"comparison_date_end","value":""},{"disabled":true,"key":"limit","value":""}],"variable":[]}},"response":[],"_postman_id":"f9e67f1c-a475-472b-8a98-0c0f8510a198"},{"name":"Dashboard salesdashboard figures","id":"33c93e90-c412-42bc-b0c6-40ba979a5763","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//dashboard/salesdashboard/figures?start_time=&end_time=","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`start_time`	—
`end_time`	—
`compare_start_time`	—
`compare_end_time`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`start_time`	—
`end_time`	—
`compare_start_time`	—
`compare_end_time`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`start_time`	—
`end_time`	—
`compare_start_time`	—
`compare_end_time`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`start_time`	—
`end_time`	—
`compare_start_time`	—
`compare_end_time`	—
`exclude_domestic`	Required. Accepted values are 1 and 0; the literal words true and false are rejected. Send 1 to leave the company's own country out of the response entirely: it is dropped from the country breakdown and its revenue is left out of total_revenue and of the comparison total. That country is the one on the company address, or the United Kingdom when the company has no country on file. Send 0 to include every country.

Required. Accepted values are 1 and 0; the literal words true and false are rejected. Send 1 to leave the company's own country out of the response entirely: it is dropped from the country breakdown and its revenue is left out of total_revenue and of the comparison total. That country is the one on the company address, or the United Kingdom when the company has no country on file. Send 0 to include every country.

\n","type":"text/plain"},"key":"exclude_domestic","value":""}],"variable":[]}},"response":[],"_postman_id":"32280231-1032-4333-8166-0c8248a35ca9"},{"name":"Dashboard salesdashboard product revenue","id":"e1e92a01-8b15-463c-a190-80bd7adec91d","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//dashboard/salesdashboard/product-revenue?start_time=&end_time=","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`start_time`	—
`end_time`	—
`compare_start_time`	—
`compare_end_time`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`start_time`	—
`end_time`	—
`compare_start_time`	—
`compare_end_time`	—

Dashboard — 32 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"d2a26461-3662-48f8-a585-268ad5fabcfb","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Deliveries","item":[{"name":"Deliveries types","id":"ac878ec3-44ea-4b8c-b150-04aa72cd559b","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//deliveries/types","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`deliveries`	array	yes	—
`deliveries.*.type`	string	yes	Allowed: `1`, `2`
`deliveries.*.reference_number`	string	yes	—
`deliveries.*.supplier_id`	integer \| null	no	—
`deliveries.*.delivery_number`	string \| null	no	—
`deliveries.*.warehouse_location_id`	integer \| null	no	—
`deliveries.*.expected_delivery_date`	string \| null	no	—
`deliveries.*.assigned_user_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`deliveries`	array	yes	—
`deliveries.*.delivery_id`	integer	yes	—
`deliveries.*.type`	string	yes	Allowed: `1`, `2`
`deliveries.*.supplier_id`	integer \| null	no	—
`deliveries.*.delivery_number`	string \| null	no	—
`deliveries.*.warehouse_location_id`	integer \| null	no	—
`deliveries.*.expected_delivery_date`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`delivery_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`delivery_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`delivery_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

Parameter	Description
`includes_count`	—
`archived`	Filter by Archived.
`reference_number`	Filter by Reference Number.
`query`	Filter by Query.
`supplier_id`	Filter by Supplier Id.
`item_count_from`	Filter by Item Count From.
`item_count_to`	Filter by Item Count To.
`expected_delivery_date_from`	Filter by Expected Delivery Date From.
`expected_delivery_date_to`	Filter by Expected Delivery Date To.
`status`	Filter by Status.
`tags`	Filter by Tags.
`assigned_user_id`	Filter by Assigned User Id.
`is_mobile`	Filter by Is Mobile.
`unassigned_deliveries`	Filter by Unassigned Deliveries.
`delivery_number`	Filter by Delivery Number.
`delivery_number_exclude`	Filter by Delivery Number Exclude.
`import_ids`	Filter by Import Ids.
`received_at_from`	Filter by Received At From.
`received_at_to`	Filter by Received At To.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

supplier
supplier.fileManager
supplier.contact
warehouseLocation
items
items.inventory
items.inventory.meta
items.purchaseOrder
items.purchaseOrder.items
assignedUser
assignedUser.user
assignedUser.user.fileManager
assignedUser.timeTracking
assignedUsers
assignedUsers.user
assignedUsers.user.fileManager
assignedUsers.timeTracking
tags
tags.tag
sizes
attachments

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Archived.

\n","type":"text/plain"},"key":"archived","value":""},{"disabled":true,"description":{"content":"

Filter by Reference Number.

\n","type":"text/plain"},"key":"reference_number","value":""},{"disabled":true,"description":{"content":"

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Supplier Id.

\n","type":"text/plain"},"key":"supplier_id","value":""},{"disabled":true,"description":{"content":"

Filter by Item Count From.

\n","type":"text/plain"},"key":"item_count_from","value":""},{"disabled":true,"description":{"content":"

Filter by Item Count To.

\n","type":"text/plain"},"key":"item_count_to","value":""},{"disabled":true,"description":{"content":"

Filter by Expected Delivery Date From.

\n","type":"text/plain"},"key":"expected_delivery_date_from","value":""},{"disabled":true,"description":{"content":"

Filter by Expected Delivery Date To.

\n","type":"text/plain"},"key":"expected_delivery_date_to","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Tags.

\n","type":"text/plain"},"key":"tags","value":""},{"disabled":true,"description":{"content":"

Filter by Assigned User Id.

\n","type":"text/plain"},"key":"assigned_user_id","value":""},{"disabled":true,"description":{"content":"

Filter by Is Mobile.

\n","type":"text/plain"},"key":"is_mobile","value":""},{"disabled":true,"description":{"content":"

Filter by Unassigned Deliveries.

\n","type":"text/plain"},"key":"unassigned_deliveries","value":""},{"disabled":true,"description":{"content":"

Filter by Delivery Number.

\n","type":"text/plain"},"key":"delivery_number","value":""},{"disabled":true,"description":{"content":"

Filter by Delivery Number Exclude.

\n","type":"text/plain"},"key":"delivery_number_exclude","value":""},{"disabled":true,"description":{"content":"

Filter by Import Ids.

\n","type":"text/plain"},"key":"import_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Received At From.

\n","type":"text/plain"},"key":"received_at_from","value":""},{"disabled":true,"description":{"content":"

Filter by Received At To.

\n","type":"text/plain"},"key":"received_at_to","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - supplier - supplier.fileManager - supplier.contact - warehouseLocation - items - items.inventory - items.inventory.meta - items.purchaseOrder - items.purchaseOrder.items - assignedUser - assignedUser.user - assignedUser.user.fileManager - assignedUser.timeTracking - assignedUsers - assignedUsers.user - assignedUsers.user.fileManager - assignedUsers.timeTracking - tags - tags.tag - sizes - attachments

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"8d436899-565b-46ed-bcd7-103e6fa5a8c4"},{"name":"Deliveries create","id":"a18f555a-52b5-4156-9963-33e9c12905a7","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"type\": \"1\",\n \"reference_number\": \"reference_number\",\n \"supplier_id\": \"{{supplier_id}}\",\n \"delivery_number\": \"\",\n \"warehouse_location_id\": \"{{warehouse_location_id}}\",\n \"expected_delivery_date\": \"\",\n \"assigned_user_id\": \"{{assigned_user_id}}\",\n \"mark_as_all_received\": false,\n \"tags\": [\n \"\"\n ],\n \"sizes\": [\n {\n \"unit\": \"1\",\n \"qty\": 0\n }\n ],\n \"items\": [\n {\n \"inventory_id\": \"{{inventory_id}}\",\n \"expected_qty\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//deliveries","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`type`	string	yes	Allowed: `1`, `2`
`reference_number`	string	yes	—
`supplier_id`	integer	no	—
`delivery_number`	string \| null	no	—
`warehouse_location_id`	integer \| null	no	—
`expected_delivery_date`	string \| null	no	—
`assigned_user_id`	integer \| null	no	Staff users live on the global accounts connection; tenant scoping goes through the company_user membership pivot, as in v1.
`mark_as_all_received`	boolean \| null	no	—
`tags`	array \| null	no	—
`sizes`	array \| null	no	—
`sizes.*.unit`	string	yes	Allowed: `1`, `2`, `3`
`sizes.*.qty`	number	yes	—
`items`	array \| null	no	—
`items.*.inventory_id`	integer	yes	—
`items.*.expected_qty`	number	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

supplier
supplier.fileManager
supplier.contact
warehouseLocation
items
items.inventory
items.inventory.meta
items.purchaseOrder
items.purchaseOrder.items
assignedUser
assignedUser.user
assignedUser.user.fileManager
assignedUser.timeTracking
assignedUsers
assignedUsers.user
assignedUsers.user.fileManager
assignedUsers.timeTracking
tags
tags.tag
sizes
attachments

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"bda39bcb-7020-463a-92b7-eac3a33d50a4","type":"any","value":"","key":"deliveryID"}]}},"response":[],"_postman_id":"e4994578-62a6-47e6-bbfa-abadcb36ef6a"},{"name":"Deliveries update","id":"7c156fb3-8478-42a0-8a63-6304a8fcd1aa","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"type\": \"1\",\n \"supplier_id\": \"{{supplier_id}}\",\n \"delivery_number\": \"\",\n \"warehouse_location_id\": \"{{warehouse_location_id}}\",\n \"expected_delivery_date\": \"\",\n \"tags\": [\n \"\"\n ],\n \"sizes\": [\n {\n \"id\": null,\n \"unit\": \"1\",\n \"qty\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//deliveries/:deliveryID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`type`	string	yes	Allowed: `1`, `2`
`supplier_id`	integer	no	—
`delivery_number`	string \| null	no	—
`warehouse_location_id`	integer \| null	no	—
`expected_delivery_date`	string \| null	no	—
`tags`	array \| null	no	—
`sizes`	array \| null	no	—
`sizes.*.id`	integer \| null	no	—
`sizes.*.unit`	string	yes	Allowed: `1`, `2`, `3`
`sizes.*.qty`	number	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`type`	string	yes	Allowed: `1`, `2`
`supplier_id`	integer	no	—
`delivery_number`	string \| null	no	—
`warehouse_location_id`	integer \| null	no	—
`expected_delivery_date`	string \| null	no	—
`tags`	array \| null	no	—
`sizes`	array \| null	no	—
`sizes.*.id`	integer \| null	no	—
`sizes.*.unit`	string	yes	Allowed: `1`, `2`, `3`
`sizes.*.qty`	number	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`delivery_id`	integer	yes	—
`expected_delivery_date`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`delivery_id`	Filter by Delivery Id.
`user_id`	Filter by User Id.
`received_qty_from`	Filter by Received Qty From.
`received_qty_to`	Filter by Received Qty To.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

delivery
user
user.fileManager
timeTracking

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Delivery Id.

\n","type":"text/plain"},"key":"delivery_id","value":""},{"disabled":true,"description":{"content":"

Filter by User Id.

\n","type":"text/plain"},"key":"user_id","value":""},{"disabled":true,"description":{"content":"

Filter by Received Qty From.

\n","type":"text/plain"},"key":"received_qty_from","value":""},{"disabled":true,"description":{"content":"

Filter by Received Qty To.

\n","type":"text/plain"},"key":"received_qty_to","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - delivery - user - user.fileManager - timeTracking

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"6a6636c2-841e-4253-832c-4f5d1cb1f33c","type":"any","value":"","key":"deliveryID"}]}},"response":[],"_postman_id":"c57344f9-7869-4c42-bcae-de782c4bf231"},{"name":"Deliveries assigned users create","id":"991a1d02-4ed2-46e6-8dc7-07124b04a271","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"delivery_id\": \"{{delivery_id}}\",\n \"user_id\": \"{{user_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//deliveries/:deliveryID/assigned-users","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`delivery_id`	integer	yes	—
`user_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`delivery_id`	integer	yes	—
`is_mobile`	boolean \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`delivery_id`	integer	yes	—
`stopped_at`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`delivery_id`	Filter by Delivery Id.
`inventory_id`	Filter by Inventory Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

delivery
inventory
inventory.meta
fileManager

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Delivery Id.

\n","type":"text/plain"},"key":"delivery_id","value":""},{"disabled":true,"description":{"content":"

Filter by Inventory Id.

\n","type":"text/plain"},"key":"inventory_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - delivery - inventory - inventory.meta - fileManager

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"86f90c00-bedc-4e55-ac81-5d6f2ac2cff1","type":"any","value":"","key":"deliveryID"}]}},"response":[],"_postman_id":"e6e50d9a-b8d1-47d3-9d3e-b7438c7158e7"},{"name":"Deliveries attachments create","id":"e6f3706f-dfd1-4aa2-b16e-15dd93f5afaf","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"delivery_id\": \"{{delivery_id}}\",\n \"type\": \"1\",\n \"file_manager_id\": \"{{file_manager_id}}\",\n \"inventory_id\": \"{{inventory_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//deliveries/:deliveryID/attachments","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`delivery_id`	integer	yes	—
`type`	string	yes	Allowed: `1`, `2`
`file_manager_id`	integer	yes	—
`inventory_id`	integer	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`deliveryID`	integer	yes
`attachmentID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`delivery_id`	integer	yes	—
`attachment_id`	integer	yes	—
`type`	string	yes	Allowed: `1`, `2`
`file_manager_id`	integer	yes	—
`inventory_id`	integer	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`deliveryID`	integer	yes
`attachmentID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`delivery_id`	integer	yes	—
`attachment_id`	integer	yes	—
`type`	string	yes	Allowed: `1`, `2`
`file_manager_id`	integer	yes	—
`inventory_id`	integer	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`deliveryID`	integer	yes
`attachmentID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`delivery_id`	—
`attachment_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`sort`	—
`includes_count`	—
`delivery_id`	Filter by Delivery Id.
`warehouse_location_id`	Filter by Warehouse Location Id.
`purchase_order_id`	Filter by Purchase Order Id.
`expected_qty_from`	Filter by Expected Qty From.
`expected_qty_to`	Filter by Expected Qty To.
`received_qty_from`	Filter by Received Qty From.
`received_qty_to`	Filter by Received Qty To.
`search`	Filter by Search.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

delivery
inventory
inventory.meta
batch
warehouseLocation
purchaseOrder

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Delivery Id.

\n","type":"text/plain"},"key":"delivery_id","value":""},{"disabled":true,"description":{"content":"

Filter by Warehouse Location Id.

\n","type":"text/plain"},"key":"warehouse_location_id","value":""},{"disabled":true,"description":{"content":"

Filter by Purchase Order Id.

\n","type":"text/plain"},"key":"purchase_order_id","value":""},{"disabled":true,"description":{"content":"

Filter by Expected Qty From.

\n","type":"text/plain"},"key":"expected_qty_from","value":""},{"disabled":true,"description":{"content":"

Filter by Expected Qty To.

\n","type":"text/plain"},"key":"expected_qty_to","value":""},{"disabled":true,"description":{"content":"

Filter by Received Qty From.

\n","type":"text/plain"},"key":"received_qty_from","value":""},{"disabled":true,"description":{"content":"

Filter by Received Qty To.

\n","type":"text/plain"},"key":"received_qty_to","value":""},{"disabled":true,"description":{"content":"

Filter by Search.

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - delivery - inventory - inventory.meta - batch - warehouseLocation - purchaseOrder

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"e246425f-98fe-4c77-878a-0d4e5b3a678b","type":"any","value":"","key":"deliveryID"}]}},"response":[],"_postman_id":"8cdebd32-692f-44de-a0fc-84068b046f8e"},{"name":"Deliveries items create","id":"b430f6ae-1112-4263-b16d-8903c64f2441","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"delivery_type\": \"1\",\n \"mark_as_all_received\": false,\n \"items\": [\n {\n \"inventory_id\": \"{{inventory_id}}\",\n \"purchase_order_id\": \"{{purchase_order_id}}\",\n \"expected_qty\": 1,\n \"warehouse_location_id\": \"{{warehouse_location_id}}\",\n \"shelf\": \"\",\n \"batch_number\": \"\",\n \"expiry_date\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//deliveries/:deliveryID/items","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`delivery_type`	string	yes	Allowed: `1`, `2`
`mark_as_all_received`	boolean \| null	no	—
`items`	array	yes	—
`items.*.inventory_id`	integer	yes	—
`items.*.purchase_order_id`	integer	no	—
`items.*.expected_qty`	number	yes	—
`items.*.warehouse_location_id`	integer \| null	no	—
`items.*.shelf`	string \| null	no	—
`items.*.batch_number`	string \| null	no	—
`items.*.expiry_date`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`delivery_id`	integer	yes	—
`items`	array	yes	—
`items.*.inventory_id`	integer	yes	—
`items.*.expected_qty`	integer	yes	—
`items.*.purchase_order_id`	string \| null	no	—
`items.*.warehouse_location_id`	string \| null	no	—
`items.*.batch_number`	string \| null	no	—
`items.*.expiry_date`	string \| null	no	—
`items.*.shelf`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`deliveryID`	integer	yes
`itemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`delivery_id`	string	yes	—
`item_id`	string	yes	—
`quantity`	integer	yes	—
`reason`	integer	yes	Allowed: `1`, `2`
`apply_purchase_order`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`deliveryID`	integer	yes
`itemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`delivery_id`	string	yes	—
`item_id`	string	yes	—
`warehouse_location_id`	string	no	—
`shelf`	string	no	—
`batch_number`	string \| null	no	—
`expiry_date`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`deliveryID`	integer	yes
`itemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`delivery_id`	integer	yes	—
`item_id`	integer	yes	—
`action_qty`	number	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`deliveryID`	integer	yes
`itemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`delivery_id`	integer	yes	—
`item_id`	integer	yes	—
`lines`	array	yes	—
`lines.*.quantity`	number	yes	—
`lines.*.batch_number`	string \| null	no	—
`lines.*.expiry_date`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`delivery_id`	Filter by Delivery Id.
`unit`	Filter by Unit.
`qty_from`	Filter by Qty From.
`qty_to`	Filter by Qty To.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

delivery

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Delivery Id.

\n","type":"text/plain"},"key":"delivery_id","value":""},{"disabled":true,"description":{"content":"

Filter by Unit.

\n","type":"text/plain"},"key":"unit","value":""},{"disabled":true,"description":{"content":"

Filter by Qty From.

\n","type":"text/plain"},"key":"qty_from","value":""},{"disabled":true,"description":{"content":"

Filter by Qty To.

\n","type":"text/plain"},"key":"qty_to","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - delivery

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"bbc6108b-8136-484e-9318-c3ea81a58469","type":"any","value":"","key":"deliveryID"}]}},"response":[],"_postman_id":"351e5026-1630-48c2-a60f-7f8db1a4d61b"},{"name":"Deliveries sizes create","id":"487c0be6-35b7-4938-8868-b0b5e0f97c38","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"delivery_id\": \"{{delivery_id}}\",\n \"sizes\": [\n {\n \"id\": null,\n \"unit\": \"1\",\n \"qty\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//deliveries/:deliveryID/sizes","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`delivery_id`	integer	yes	—
`sizes`	array	yes	—
`sizes.*.id`	integer \| null	no	—
`sizes.*.unit`	string	yes	Allowed: `1`, `2`, `3`
`sizes.*.qty`	number	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`delivery_ids[]`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`delivery_id`	Filter by Delivery Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

company
delivery
tag

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Delivery Id.

\n","type":"text/plain"},"key":"delivery_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - company - delivery - tag

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"4cefd416-c856-4fc1-8153-8bfe7a1ae388","type":"any","value":"","key":"deliveryID"}]}},"response":[],"_postman_id":"83cf8154-79ab-4dc0-a03b-6e7f3f5e36fd"},{"name":"Deliveries tags create","id":"51c2ed41-8b23-4f19-9bdb-5e7883f14ab3","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"delivery_id\": \"{{delivery_id}}\",\n \"name\": \"name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//deliveries/:deliveryID/tags","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`deliveryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`delivery_id`	integer	yes	—
`name`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`deliveryID`	integer	yes
`tagID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`delivery_id`	integer	yes	—
`tag_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`deliveryID`	integer	yes
`tagID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`delivery_id`	integer	yes	—
`tag_id`	integer	yes	—

Deliveries — 40 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"c751bab1-d05b-4507-9a75-29968ef7e2d0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Delivery Manifest","item":[{"name":"Delivery manifest extract items","id":"9d4fe348-f818-42de-a02a-d4a33d5bf1f3","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"imageUrls\": [\n \"\"\n ],\n \"suppliers\": [\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//delivery-manifest/extract-items","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`imageUrls`	array	yes	—
`suppliers`	array	no	—

Delivery Manifest — 1 endpoint.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"af7f2840-a7c5-4d91-a389-a69c133f7cf1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Despatch Target Rules","item":[{"name":"Despatch target rules list","id":"620d8450-f3df-4149-bc54-9cc93a535f5c","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//despatch-target-rules","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

conditionGroups
actions
customSchedules

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - conditionGroups - actions - customSchedules

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"620d8450-f3df-4149-bc54-9cc93a535f5c"},{"name":"Despatch target rules create","id":"2d29b6cc-b762-400b-995c-369210965f4b","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"name\": \"name\",\n \"despatch_target_hour\": 1,\n \"schedule_type\": \"1\",\n \"store_and_channels\": [\n 0\n ],\n \"conditions\": [\n [\n {\n \"field\": 1,\n \"operator\": 0,\n \"value\": [\n \"\"\n ]\n }\n ]\n ],\n \"custom_schedules\": [\n {\n \"day_of_week\": 1,\n \"is_active\": false,\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n ],\n \"actions\": [\n {\n \"action\": 1,\n \"value\": [\n \"\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//despatch-target-rules","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`despatch_target_hour`	integer	yes	—
`schedule_type`	string	yes	Allowed: `1`, `2`, `3`
`store_and_channels`	array	yes	—
`conditions`	array \| null	no	—
`custom_schedules`	array	no	—
`custom_schedules.*.day_of_week`	integer	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`
`custom_schedules.*.is_active`	boolean	yes	—
`custom_schedules.*.start_time`	string	no	—
`custom_schedules.*.end_time`	string	no	—
`actions`	array \| null	no	—
`actions.*.action`	integer	no	Allowed: `1`, `2`
`actions.*.value`	array	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`despatchTargetRuleID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

conditionGroups
actions
customSchedules

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - conditionGroups - actions - customSchedules

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"c582d6cf-4471-48cf-b562-6699d2c899d5","type":"any","value":"","key":"despatchTargetRuleID"}]}},"response":[],"_postman_id":"f9deebc5-5bde-4c85-99b1-9e024d90fac1"},{"name":"Despatch target rules update","id":"0cd391e9-8b5c-4a43-a97f-e370c9e5cf86","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"name\": \"name\",\n \"despatch_target_hour\": 1,\n \"schedule_type\": \"1\",\n \"store_and_channels\": [\n 0\n ],\n \"conditions\": [\n [\n {\n \"field\": 1,\n \"operator\": 0,\n \"value\": [\n \"\"\n ]\n }\n ]\n ],\n \"custom_schedules\": [\n {\n \"day_of_week\": 1,\n \"is_active\": false,\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n ],\n \"actions\": [\n {\n \"action\": 1,\n \"value\": [\n \"\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//despatch-target-rules/:despatchTargetRuleID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`despatchTargetRuleID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`despatch_target_hour`	integer	yes	—
`schedule_type`	string	yes	Allowed: `1`, `2`, `3`
`store_and_channels`	array	yes	—
`conditions`	array \| null	no	—
`custom_schedules`	array	no	—
`custom_schedules.*.day_of_week`	integer	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`
`custom_schedules.*.is_active`	boolean	yes	—
`custom_schedules.*.start_time`	string	no	—
`custom_schedules.*.end_time`	string	no	—
`actions`	array \| null	no	—
`actions.*.action`	integer	no	Allowed: `1`, `2`
`actions.*.value`	array	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`despatchTargetRuleID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`despatch_target_rule_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`despatchTargetRuleID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`despatchTargetRuleID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`sorting`	array	yes	—
`sorting.*.id`	integer	yes	—
`sorting.*.order`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`conditions`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`savedConditionID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`saved_condition_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`savedConditionID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`saved_condition_id`	integer	yes	—

Despatch Target Rules — 12 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"3b81373e-7f74-4355-b4f8-29637ae3aaf5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Document Rules","item":[{"name":"Document rules list","id":"ec11217a-59c4-4499-a84c-5e266ee0a053","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//document-rules","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

conditionGroups
printTemplate

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - conditionGroups - printTemplate

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"ec11217a-59c4-4499-a84c-5e266ee0a053"},{"name":"Document rules create","id":"35a968e3-97d0-4415-812a-376a772e8822","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//document-rules","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`documentRuleID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

conditionGroups
printTemplate

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - conditionGroups - printTemplate

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"256c28d7-81fb-48bb-9962-4ebfa6641493","type":"any","value":"","key":"documentRuleID"}]}},"response":[],"_postman_id":"47555517-0b8b-4796-b7da-a040050faf08"},{"name":"Document rules update","id":"9eb13365-0570-4fce-98be-2402e41d295d","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//document-rules/:documentRuleID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`documentRuleID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`documentRuleID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`document_rule_id`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`documentRuleID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`document_rule_id`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`conditions`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`sorting`	array	yes	—
`sorting.*.id`	integer	yes	—
`sorting.*.order`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`savedConditionID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`saved_condition_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`savedConditionID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`saved_condition_id`	integer	yes	—

Document Rules — 11 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"442b5800-e699-4f92-bb0f-d80522954fcf","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Email Templates","item":[{"name":"Email templates list","id":"0333ae11-40ae-4141-921c-a81e5d8567e2","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//email-templates","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`name`	Filter by Name.
`type`	Filter by Type.
`format`	Filter by Format.
`status`	Filter by Status.
`tags`	Filter by Tags.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Type.

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

Filter by Format.

\n","type":"text/plain"},"key":"format","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Tags.

\n","type":"text/plain"},"key":"tags","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"0333ae11-40ae-4141-921c-a81e5d8567e2"},{"name":"Email templates create","id":"835421ca-3a75-4860-8bb8-5cb258c7367a","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"name\": \"name\",\n \"format\": \"1\",\n \"type\": \"1\",\n \"html\": \"\",\n \"json\": \"\",\n \"file_manager_id\": \"{{file_manager_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//email-templates","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`format`	string	yes	EMailTemplateFormats values: - `1` = HTML - `2` = EDITOR Allowed: `1`, `2`
`type`	string	yes	Allowed: `1`, `2`
`html`	string \| null	no	—
`json`	string \| null	no	—
`file_manager_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`emailTemplateID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`emailTemplateID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`email_template_id`	integer	yes	—
`name`	string	yes	—
`format`	string	yes	EMailTemplateFormats values: - `1` = HTML - `2` = EDITOR Allowed: `1`, `2`
`html`	string \| null	no	—
`json`	string \| null	no	—
`file_manager_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`emailTemplateID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`email_template_id`	integer	yes	—
`name`	string	yes	—
`format`	string	yes	EMailTemplateFormats values: - `1` = HTML - `2` = EDITOR Allowed: `1`, `2`
`html`	string \| null	no	—
`json`	string \| null	no	—
`file_manager_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`emailTemplateID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`email_template_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`types[]`	Options: `1`, `2`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`html`	string \| null	no	—
`emails`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`emailTemplateID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`email_template_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`emailTemplateID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`email_template_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`emailTemplateID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string	yes	—
`company_id`	integer	yes	—
`email_template_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`emailTemplateID`	integer	yes
`tagID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`email_template_id`	integer	yes	—
`tag_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`emailTemplateID`	integer	yes
`tagID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`email_template_id`	integer	yes	—
`tag_id`	integer	yes	—

Email Templates — 14 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"02d3c2de-1ab9-4e1e-a645-dd6665e32aac","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Virtual Stock","item":[{"name":"Virtual stock list","id":"8bc975bc-37ff-4a3a-91d7-0fe25346990b","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//inventory/{{inventory_id}}/external-stocks","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`inventory_id`	integer	yes	—
`source_id`	integer	yes	—
`quantity`	integer	yes	—

Creates the entry if it does not exist yet and overwrites the quantity if it does, so the\nsame call can be replayed safely - you do not need to store the entry id. A product holds at\nmost one entry per source. The source must be active.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`externalStockSourceID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`inventory_id`	integer	yes	—
`external_stock_source_id`	integer	yes	—
`quantity`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`externalStockID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`inventory_id`	integer	yes	—
`external_stock_id`	integer	yes	—
`quantity`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`externalStockID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`inventory_id`	integer	yes	—
`external_stock_id`	integer	yes	—
`quantity`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`externalStockID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`externalStockID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`type`	integer	yes	Allowed: `1`, `2`, `3`
`is_active`	boolean	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`externalStockSourceID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`externalStockSourceID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`external_stock_source_id`	integer	yes	—
`name`	string	no	—
`type`	integer	no	Allowed: `1`, `2`, `3`
`is_active`	boolean	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`externalStockSourceID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`external_stock_source_id`	integer	yes	—
`name`	string	no	—
`type`	integer	no	Allowed: `1`, `2`, `3`
`is_active`	boolean	no	—

A source can be deleted while products are using it; doing so also removes it from every one\nof those products, lowering their Available quantity accordingly.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`externalStockSourceID`	integer	yes

6 = INVENTORY (product image), 7 = ORDER (order attachment)

\n"},{"key":"file","type":"file","description":"

max 10 MB; image: png/jpg/jpeg, order attachment: pdf/doc/docx/csv/png/jpg/jpeg

\n","src":[]}]},"url":"https://app-api.helmwms.app/api/v2/companies//file-manager/upload","description":"

Uploads a file as multipart/form-data and returns its id, ready to be attached to a record.

Two kinds of file can be created through the API:

type = 6 (INVENTORY) — a product image (png, jpg, jpeg). Attach the returned id with\nPOST /companies/{companyID}/inventory/{inventoryID}/image, or as file_manager_id on inventory\ncreate/update. If your images are already on a public URL you do not need this endpoint — send\nimage_url instead.
type = 7 (ORDER) — an order attachment (pdf, doc, docx, csv, png, jpg, jpeg).\nAttach the returned id with POST /companies/{companyID}/orders/{orderID}/attachments.

A file uploaded here is stored permanently: unlike an upload started in the app it is not treated as\na pending temporary file that gets cleaned up when left unattached, so the id stays usable later.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters (multipart/form-data)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`type`	integer	yes	File kind. `6` = INVENTORY (product image), `7` = ORDER (order attachment).
`file`	file	yes	The file, max 10 MB. Product image: `png`, `jpg`, `jpeg`. Order attachment: `pdf`, `doc`, `docx`, `csv`, `png`, `jpg`, `jpeg`.

Returns a stored file: its kind, name, mime type, URL and generated renditions.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`fileManagerID`	integer	yes

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`id`	integer	File id, the value to pass as `file_manager_id`.
`type`	integer	File kind. `6` = INVENTORY (product image), `7` = ORDER (order attachment).
`type_name`	string	The kind resolved to its name, e.g. `INVENTORY`.
`path`	string	URL of the file.
`file_name`	string	Original file name as uploaded.
`mime_type`	string	Stored mime type.
`sizes`	object\|null	Generated renditions, keyed by pixel width.
`status`	integer	`0` pending, `1` awaiting upload, `2` uploaded.
`status_name`	string	The status resolved to its name, e.g. `UPLOADED`.

Id returned by the upload endpoint.

\n","type":"text/plain"},"type":"any","value":"","key":"fileManagerID"}]}},"response":[],"_postman_id":"a55ef049-73a7-4731-85f6-721fb6446e4e"}],"id":"bcdd1f9f-f9b1-4eed-a4d3-2057576b4d53","_postman_id":"bcdd1f9f-f9b1-4eed-a4d3-2057576b4d53","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Fixed Banners","item":[{"name":"Fixed banners list","id":"96983b8a-cd1b-40b6-9c63-73cfcd268065","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//fixed-banners","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"96983b8a-cd1b-40b6-9c63-73cfcd268065"},{"name":"Fixed banners show","id":"98f5a40f-3419-4564-8256-324d6c91e6f1","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//fixed-banners/:fixedBannerID?company_id=&fixed_banner_id=","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`fixedBannerID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`fixed_banner_id`	—
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`fixedBannerID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`fixed_banner_id`	integer	yes	—

Fixed Banners — 3 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"d71564b3-cd2f-40dc-a36d-41e62c45b27f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Global System Notifications","item":[{"name":"Global system notifications list","id":"4eed0d4f-33fb-4ac1-8e51-bdbd763a63ed","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//global-system-notifications","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"4eed0d4f-33fb-4ac1-8e51-bdbd763a63ed"},{"name":"Global system notifications snooze","id":"27f760f6-b42d-4644-b148-f63260c9c8e3","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"notification_id\": \"{{notification_id}}\",\n \"snooze_delay\": \"1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//global-system-notifications/:notificationID/snooze","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`notificationID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`notification_id`	integer	yes	—
`snooze_delay`	string	yes	Allowed: `1`, `2`, `3`, `4`

Global System Notifications — 2 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"90a26035-b12c-4c09-a943-1895aabba503","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Import Export","item":[{"name":"Import export exports types","id":"804e9c8d-1f5c-4561-b08e-a43e449c53aa","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//import-export/exports/types","description":"

Rate limit: 10 requests/minute, per token, for this endpoint. Each endpoint has its own independent budget. Exceeding it returns 429 Too Many Requests with Retry-After and X-RateLimit-* headers.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`export_name`	string	yes	—
`export_type`	string	yes	ExportTypes values: - `1` = INVENTORY - `2` = INVENTORY_CATEGORY - `3` = ORDER - `4` = CUSTOMER - `5` = INVENTORY_BARCODE - `6` = INVENTORY_CONTAINER - `7` = INVENTORY_TAG - `8` = ORDER_TAG - `9` = CUSTOMER_TAG - `10` = WAREHOUSE_LOCATION - `11` = LOCATION_STOCK - `12` = DELIVERY - `13` = SUPPLIER - `14` = PURCHASE_ORDER - `15` = TEAM_MANAGER_WORK_ENTRIES Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`
`mime_type`	string	yes	ExportMimeTypes values: - `0` = CSV - `1` = XLSX Allowed: `0`, `1`
`card_file`	string \| null	no	—
`elastic_filters`	string \| null	no	—
`is_archived`	boolean \| null	no	—
`recipients`	array	yes	—
`elastic_ignore_ids`	array	no	—
`elastic_sortable`	array	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`type`	Filter by Type.
`mime_type`	Filter by Mime Type.
`status`	Filter by Status.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

company
user

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Type.

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

Filter by Mime Type.

\n","type":"text/plain"},"key":"mime_type","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - company - user

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"0967c58f-a21c-41c5-aa7d-968be42be60b"},{"name":"External/file endpoint: streams the generated export file","id":"a5a3e677-4a61-421d-b5f9-73d65e4c4c42","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//import-export/exports/:exportID/download?company_id=&export_id=","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`exportID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`export_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`type`	string	yes	—
`import`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`type`	string	yes	Allowed: `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`
`import_name`	string	yes	—
`key`	string	yes	—
`post_action`	boolean	yes	—
`set_status`	string	no	Allowed: `1`, `2`, `8`
`format`	string	yes	Allowed: `csv`, `xls`, `xlsx`
`mapping_id`	integer	no	—
`mappings`	array	yes	—
`mappings.*.key`	string	yes	Allowed: `code`, `parent_code`, `name`, `type`, `batching_type`, `sync_stock`, `quantity`, `group_quantity`, `inventory_weight`, `inventory_length`, `inventory_width`, `inventory_height`, `inventory_nest_height`, `hs_code`, `country`, `description`, `customs_description`, `customs_value`, `manufacturer_sku`, `manufacturer`, `cpsc_mode`, `cpsc_certifier_id`, `cpsc_product_version`, `cpsc_registry_product_id`, `cpsc_disclaim_code`, `cpsc_intended_use_code`, `cpsc_disclaim_reason`, `cpsc_intended_use_description`, `price`, `cost_price`, `image`, `archived`
`mappings.*.value`	string	yes	—
`mappings.*.is_fixed_value`	boolean \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`name`	Filter by Name.
`type`	Filter by Type.
`status`	Filter by Status.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

company
user

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Type.

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - company - user

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"9c53f6f8-4042-46df-b8d4-bc7f9032dcd8"},{"name":"Import export imports logs","id":"02f096e3-4d3c-4e3b-aa24-f157e9bb45ba","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//import-export/imports/:importID/logs?company_id=&import_id=","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`importID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`company_id`	—
`import_id`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`importID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`type`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`type`	Options: `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`mappings`	array	yes	—
`mappings.*.mapping_id`	integer	yes	—
`mappings.*.name`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`type`	Options: `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"fe30152b-d5ba-442f-b5bf-bd3e5e87bdbf"},{"name":"Import export mappings create","id":"1962608b-fae7-4d7a-8e02-dbed1e98e925","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"name\": \"name\",\n \"type\": \"0\",\n \"mappings\": [\n {\n \"key\": \"code\",\n \"value\": \"value\",\n \"is_fixed_value\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//import-export/mappings","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`type`	string	yes	Allowed: `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`
`mappings`	array	yes	—
`mappings.*.key`	string	yes	Allowed: `code`, `parent_code`, `name`, `type`, `batching_type`, `sync_stock`, `quantity`, `group_quantity`, `inventory_weight`, `inventory_length`, `inventory_width`, `inventory_height`, `inventory_nest_height`, `hs_code`, `country`, `description`, `customs_description`, `customs_value`, `manufacturer_sku`, `manufacturer`, `cpsc_mode`, `cpsc_certifier_id`, `cpsc_product_version`, `cpsc_registry_product_id`, `cpsc_disclaim_code`, `cpsc_intended_use_code`, `cpsc_disclaim_reason`, `cpsc_intended_use_description`, `price`, `cost_price`, `image`, `archived`
`mappings.*.value`	string	yes	—
`mappings.*.is_fixed_value`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`mappingID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`mappingID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`type`	string	yes	Allowed: `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`
`mapping_id`	integer	yes	—
`name`	string	no	—
`mappings`	array	yes	—
`mappings.*.key`	string	yes	Allowed: `code`, `parent_code`, `name`, `type`, `batching_type`, `sync_stock`, `quantity`, `group_quantity`, `inventory_weight`, `inventory_length`, `inventory_width`, `inventory_height`, `inventory_nest_height`, `hs_code`, `country`, `description`, `customs_description`, `customs_value`, `manufacturer_sku`, `manufacturer`, `cpsc_mode`, `cpsc_certifier_id`, `cpsc_product_version`, `cpsc_registry_product_id`, `cpsc_disclaim_code`, `cpsc_intended_use_code`, `cpsc_disclaim_reason`, `cpsc_intended_use_description`, `price`, `cost_price`, `image`, `archived`
`mappings.*.value`	string	yes	—
`mappings.*.is_fixed_value`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`mappingID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`type`	string	yes	Allowed: `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`
`mapping_id`	integer	yes	—
`name`	string	no	—
`mappings`	array	yes	—
`mappings.*.key`	string	yes	Allowed: `code`, `parent_code`, `name`, `type`, `batching_type`, `sync_stock`, `quantity`, `group_quantity`, `inventory_weight`, `inventory_length`, `inventory_width`, `inventory_height`, `inventory_nest_height`, `hs_code`, `country`, `description`, `customs_description`, `customs_value`, `manufacturer_sku`, `manufacturer`, `cpsc_mode`, `cpsc_certifier_id`, `cpsc_product_version`, `cpsc_registry_product_id`, `cpsc_disclaim_code`, `cpsc_intended_use_code`, `cpsc_disclaim_reason`, `cpsc_intended_use_description`, `price`, `cost_price`, `image`, `archived`
`mappings.*.value`	string	yes	—
`mappings.*.is_fixed_value`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`mappingID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`mapping_id`	—

Import Export — 20 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"321c6b4e-6e24-4143-83d2-6ffdf59104cd","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Inventory","item":[{"name":"Inventory barcodes list","id":"3e66f1f9-95ed-42d6-830d-3d4032050994","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//inventory/:inventoryID/barcodes","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[{"id":"67d04bca-fcf0-483a-8c39-ba9ad4b28573","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"3e66f1f9-95ed-42d6-830d-3d4032050994"},{"name":"Inventory barcodes create","id":"a6a86144-f7e2-470c-9a66-6add12ab283f","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"inventory_barcode_type_id\": \"1\",\n \"value\": \"value\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory/:inventoryID/barcodes","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`inventory_barcode_type_id`	string \| null	no	BarcodeTypes values: - `1` = PACK - `2` = BOX - `3` = CARTON - `4` = INNER - `5` = OUTER - `6` = PALLET - `7` = TOTE - `8` = CONTAINER - `9` = CAGE - `10` = PIECE Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`
`value`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`categories`	array	yes	—
`categories.*.name`	string	yes	—
`categories.*.parent_id`	integer \| null	no	—
`categories.*.description`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`categories`	array	yes	—
`categories.*.id`	integer	yes	—
`categories.*.name`	string	yes	—
`categories.*.description`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`inventories`	array	yes	—
`inventories.*.category_id`	integer	yes	—
`inventories.*.inventory_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`inventories`	array	yes	—
`inventories.*.category_id`	integer	yes	—
`inventories.*.inventory_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filter[]`	—
`sort`	—
`includes_count`	—
`parent_id`	Filter by Parent Id.
`name`	Filter by Name.
`category_name`	Filter by Category Name.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

parent
children

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Parent Id.

\n","type":"text/plain"},"key":"parent_id","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Category Name.

\n","type":"text/plain"},"key":"category_name","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - parent - children

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"b6d1858e-257d-46ce-a14f-e992919ddc03"},{"name":"Inventory category create","id":"3e2504f2-09d8-480e-9154-7e95eac36ce7","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"name\",\n \"parent_id\": \"{{parent_id}}\",\n \"description\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory/category","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string	yes	—
`parent_id`	integer \| null	no	—
`description`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`categoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string	yes	—
`description`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`categoryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`new_category_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`categoryID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`categoryID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`term`	—
`ignore_ids[]`	—
`is_archived`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[{"id":"0a135b28-dbe1-4aa9-aec0-50af69bb137d","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"2cc2133b-d989-49cf-8f92-274569d6f55a"},{"name":"Inventory ext containers create","id":"231ebaff-9c3c-4922-9eb7-1c2ade949b23","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"containers\": [\n {\n \"id\": null,\n \"inventory_container_type_id\": \"1\",\n \"height\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"length\": 0,\n \"quantity\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory/:inventoryID/containers","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`containers`	array	yes	—
`containers.*.id`	integer \| null	no	—
`containers.*.inventory_container_type_id`	string	yes	ContainerTypes values: - `1` = PACK - `2` = BOX - `3` = CARTON - `4` = INNER - `5` = OUTER - `6` = PALLET - `7` = TOTE - `8` = CONTAINER - `9` = CAGE - `10` = PCS Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`
`containers.*.height`	number \| null	no	—
`containers.*.weight`	number \| null	no	—
`containers.*.width`	number \| null	no	—
`containers.*.length`	number \| null	no	—
`containers.*.quantity`	number	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`containerID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`term`	—
`ignore_ids[]`	—
`is_archived`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`parent_id`	—
`name`	—
`filter[]`	—
`sort`	—
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`familyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`familyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`inventories`	array	yes	—
`inventories.*.code`	string	yes	—
`inventories.*.name`	string	yes	—
`inventories.*.inventory_type_id`	string	yes	Types values: - `1` = INVENTORY - `2` = GROUP - `3` = SERVICE_CHARGE Allowed: `1`, `2`, `3`
`inventories.*.batching_type`	string \| null	no	Conditional: - Must not be sent unless `inventories.*.inventory_type_id` is `1`. Allowed: `1`, `2`, ``
`inventories.*.courier_service_id`	integer \| null	no	—
`inventories.*.tax_group_id`	integer \| null	no	—
`inventories.*.is_packaging_item`	boolean	no	—
`inventories.*.not_for_resale`	boolean	no	—
`inventories.*.single_parcel_per_item`	boolean	no	Conditional: - Must not be sent when `inventories.*.inventory_type_id` is `2`.
`inventories.*.auto_sync_stock`	boolean	no	—
`inventories.*.height`	number \| null	no	—
`inventories.*.weight`	number \| null	no	—
`inventories.*.width`	number \| null	no	—
`inventories.*.length`	number \| null	no	—
`inventories.*.nest_height`	number \| null	no	—
`inventories.*.shelf`	string \| null	no	—
`inventories.*.tags`	array \| null	no	—
`inventories.*.quantity`	number \| null	no	—
`inventories.*.country_id`	integer \| null	no	—
`inventories.*.hs_code`	number \| null	no	—
`inventories.*.manufacturer_sku`	string \| null	no	Manufacturer part number, up to 100 characters. Sent to the courier as `manufacturer_sku`.
`inventories.*.manufacturer_id`	integer \| null	no	ID of a manufacturer of the same company (see the Manufacturers endpoints). Its MID and address are sent to the courier with the item.
`inventories.*.cpsc_mode`	string	no	US CPSC declaration: `not_applicable`, `certified` or `disclaimed`. Required whenever any `cpsc_*` field is sent. `certified` uses `cpsc_certifier_id` (optional when the company has a default certifier ID in System Defaults), `cpsc_product_version` and `cpsc_registry_product_id`; `disclaimed` uses `cpsc_intended_use_code`, `cpsc_disclaim_code`, `cpsc_disclaim_reason` and, for code `980.000`, `cpsc_intended_use_description`. Fields of the other declaration are ignored and cleared on the product; `not_applicable` clears all of them. The declaration itself is stored in Helm and is not sent to the courier.
`inventories.*.cpsc_certifier_id`	string \| null	no	Certifier ID of a certified declaration, up to 100 characters. Can be left out when the company has a default certifier ID in System Defaults; the default is then sent to the courier. Conditional: - Ignored (dropped from the validated payload) unless `inventories.*.cpsc_mode` is `certified`.
`inventories.*.cpsc_product_version`	string	no	Certificate version of a certified declaration: letters and digits only, up to 50 characters (e.g. `V1`). Conditional: - Ignored (dropped from the validated payload) unless `inventories..cpsc_mode` is `certified`. - Required when `inventories..cpsc_mode` is `certified`.
`inventories.*.cpsc_registry_product_id`	string	no	CPSC Product Registry ID of a certified declaration, up to 100 characters. Conditional: - Ignored (dropped from the validated payload) unless `inventories..cpsc_mode` is `certified`. - Required when `inventories..cpsc_mode` is `certified`.
`inventories.*.cpsc_intended_use_code`	string	no	Intended use code (CBP Appendix R) of a disclaimed declaration, in the form `###.###` (e.g. `980.000`). Conditional: - Ignored (dropped from the validated payload) unless `inventories..cpsc_mode` is `disclaimed`. - Required when `inventories..cpsc_mode` is `disclaimed`.
`inventories.*.cpsc_intended_use_description`	string \| null	no	Intended use as free text, up to 255 characters. Required when `cpsc_intended_use_code` is `980.000` (Other) and not stored for any other code. Conditional: - Ignored (dropped from the validated payload) unless `inventories..cpsc_mode` is `disclaimed`. - Required when `inventories..cpsc_intended_use_code` is `980.000`.
`inventories.*.cpsc_disclaim_code`	string	no	Basis for disclaiming: `A` = not regulated by CPSC, `B` = data not required under CPSC guidance. Disclaimed declaration only. Lower case is accepted and stored in upper case. Conditional: - Ignored (dropped from the validated payload) unless `inventories..cpsc_mode` is `disclaimed`. - Required when `inventories..cpsc_mode` is `disclaimed`.
`inventories.*.cpsc_disclaim_reason`	string	no	Basis for disclaiming as free text, up to 255 characters. Required for a disclaimed declaration. Conditional: - Ignored (dropped from the validated payload) unless `inventories..cpsc_mode` is `disclaimed`. - Required when `inventories..cpsc_mode` is `disclaimed`.
`inventories.*.customs_description`	string \| null	no	—
`inventories.*.customs_value`	number \| null	no	—
`inventories.*.description`	string \| null	no	—
`inventories.*.cost_price`	number \| null	no	—
`inventories.*.price`	number \| null	no	—
`inventories.*.barcodes`	array \| null	no	—
`inventories..barcodes..inventory_barcode_type_id`	string	yes	BarcodeTypes values: - `1` = PACK - `2` = BOX - `3` = CARTON - `4` = INNER - `5` = OUTER - `6` = PALLET - `7` = TOTE - `8` = CONTAINER - `9` = CAGE - `10` = PIECE Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`
`inventories..barcodes..value`	string	yes	—
`inventories.*.image_url`	string	no	Conditional: - When this field is sent, `inventories.*.file_manager_id` must be missing or empty.
`inventories.*.file_manager_id`	integer	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`inventories`	array	yes	—
`inventories.*.inventory_id`	integer	yes	—
`inventories.*.name`	string \| null	no	—
`inventories.*.courier_service_id`	integer \| null	no	—
`inventories.*.tax_group_id`	integer \| null	no	—
`inventories.*.is_packaging_item`	boolean	no	—
`inventories.*.not_for_resale`	boolean	no	—
`inventories.*.single_parcel_per_item`	boolean	no	—
`inventories.*.auto_sync_stock`	boolean	no	—
`inventories.*.height`	number \| null	no	—
`inventories.*.weight`	number \| null	no	—
`inventories.*.width`	number \| null	no	—
`inventories.*.length`	number \| null	no	—
`inventories.*.nest_height`	number \| null	no	—
`inventories.*.shelf`	string \| null	no	—
`inventories.*.tags`	array \| null	no	—
`inventories.*.quantity`	number \| null	no	—
`inventories.*.country_id`	integer \| null	no	—
`inventories.*.hs_code`	number \| null	no	—
`inventories.*.manufacturer_sku`	string \| null	no	Manufacturer part number, up to 100 characters. Sent to the courier as `manufacturer_sku`.
`inventories.*.manufacturer_id`	integer \| null	no	ID of a manufacturer of the same company (see the Manufacturers endpoints). Its MID and address are sent to the courier with the item.
`inventories.*.cpsc_mode`	string	no	US CPSC declaration: `not_applicable`, `certified` or `disclaimed`. Required whenever any `cpsc_*` field is sent. `certified` uses `cpsc_certifier_id` (optional when the company has a default certifier ID in System Defaults), `cpsc_product_version` and `cpsc_registry_product_id`; `disclaimed` uses `cpsc_intended_use_code`, `cpsc_disclaim_code`, `cpsc_disclaim_reason` and, for code `980.000`, `cpsc_intended_use_description`. Fields of the other declaration are ignored and cleared on the product; `not_applicable` clears all of them. The declaration itself is stored in Helm and is not sent to the courier.
`inventories.*.cpsc_certifier_id`	string \| null	no	Certifier ID of a certified declaration, up to 100 characters. Can be left out when the company has a default certifier ID in System Defaults; the default is then sent to the courier. Conditional: - Ignored (dropped from the validated payload) unless `inventories.*.cpsc_mode` is `certified`.
`inventories.*.cpsc_product_version`	string	no	Certificate version of a certified declaration: letters and digits only, up to 50 characters (e.g. `V1`). Conditional: - Ignored (dropped from the validated payload) unless `inventories..cpsc_mode` is `certified`. - Required when `inventories..cpsc_mode` is `certified`.
`inventories.*.cpsc_registry_product_id`	string	no	CPSC Product Registry ID of a certified declaration, up to 100 characters. Conditional: - Ignored (dropped from the validated payload) unless `inventories..cpsc_mode` is `certified`. - Required when `inventories..cpsc_mode` is `certified`.
`inventories.*.cpsc_intended_use_code`	string	no	Intended use code (CBP Appendix R) of a disclaimed declaration, in the form `###.###` (e.g. `980.000`). Conditional: - Ignored (dropped from the validated payload) unless `inventories..cpsc_mode` is `disclaimed`. - Required when `inventories..cpsc_mode` is `disclaimed`.
`inventories.*.cpsc_intended_use_description`	string \| null	no	Intended use as free text, up to 255 characters. Required when `cpsc_intended_use_code` is `980.000` (Other) and not stored for any other code. Conditional: - Ignored (dropped from the validated payload) unless `inventories..cpsc_mode` is `disclaimed`. - Required when `inventories..cpsc_intended_use_code` is `980.000`.
`inventories.*.cpsc_disclaim_code`	string	no	Basis for disclaiming: `A` = not regulated by CPSC, `B` = data not required under CPSC guidance. Disclaimed declaration only. Lower case is accepted and stored in upper case. Conditional: - Ignored (dropped from the validated payload) unless `inventories..cpsc_mode` is `disclaimed`. - Required when `inventories..cpsc_mode` is `disclaimed`.
`inventories.*.cpsc_disclaim_reason`	string	no	Basis for disclaiming as free text, up to 255 characters. Required for a disclaimed declaration. Conditional: - Ignored (dropped from the validated payload) unless `inventories..cpsc_mode` is `disclaimed`. - Required when `inventories..cpsc_mode` is `disclaimed`.
`inventories.*.customs_description`	string \| null	no	—
`inventories.*.customs_value`	number \| null	no	—
`inventories.*.description`	string \| null	no	—
`inventories.*.cost_price`	number \| null	no	—
`inventories.*.price`	number \| null	no	—
`inventories.*.barcodes`	array \| null	no	—
`inventories..barcodes..inventory_barcode_type_id`	string	yes	BarcodeTypes values: - `1` = PACK - `2` = BOX - `3` = CARTON - `4` = INNER - `5` = OUTER - `6` = PALLET - `7` = TOTE - `8` = CONTAINER - `9` = CAGE - `10` = PIECE Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`
`inventories..barcodes..value`	string	yes	—
`inventories.*.containers`	array \| null	no	—
`inventories..containers..id`	integer \| null	no	ContainerService::bulkUpdateOrCreate deletes existing containers whose id is absent from the payload, so id must survive validation.
`inventories..containers..inventory_container_type_id`	string	yes	ContainerTypes values: - `1` = PACK - `2` = BOX - `3` = CARTON - `4` = INNER - `5` = OUTER - `6` = PALLET - `7` = TOTE - `8` = CONTAINER - `9` = CAGE - `10` = PCS Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`
`inventories..containers..height`	number \| null	no	—
`inventories..containers..weight`	number \| null	no	—
`inventories..containers..width`	number \| null	no	—
`inventories..containers..length`	number \| null	no	—
`inventories..containers..quantity`	number	yes	—
`inventories.*.image_url`	string	no	Conditional: - When this field is sent, `inventories.*.file_manager_id` must be missing or empty.
`inventories.*.file_manager_id`	integer	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`inventory_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`inventory_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`inventory_ids`	array	yes	—

Every row carries a levels object. It is not a relation: it is always\npresent and cannot be eager-loaded. Naming it in includes is accepted\nand ignored, so a request that lists it alongside real relations still\nsucceeds.

Rate limit: 600 requests/minute, per token, for this endpoint. Each endpoint has its own independent budget. Exceeding it returns 429 Too Many Requests with Retry-After and X-RateLimit-* headers.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

Parameter	Description
`filter[]`	—
`sort`	—
`includes_count`	—
`search`	Filter by Search.
`code`	Filter by Code.
`inventory_type_id`	Filter by Inventory Type Id.
`channels_id`	Filter by Channels Id.
`name`	Filter by Name.
`hs_code`	Filter by Hs Code.
`barcode`	Filter by Barcode.
`country_id`	Filter by Country Id.
`price_from`	Filter by Price From.
`price_to`	Filter by Price To.
`quantity_from`	Filter by Quantity From.
`quantity_to`	Filter by Quantity To.
`weight_from`	Filter by Weight From.
`weight_to`	Filter by Weight To.
`height_from`	Filter by Height From.
`height_to`	Filter by Height To.
`width_from`	Filter by Width From.
`width_to`	Filter by Width To.
`length_from`	Filter by Length From.
`length_to`	Filter by Length To.
`tag_id`	Filter by Tag Id.
`location_id`	Filter by Location Id.
`category_id`	Filter by Category Id.
`packaging_code`	Filter by Packaging Code.
`archived`	Filter by Archived.
`is_batch_expired`	Filter by Is Batch Expired.
`import_ids`	Filter by Import Ids.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

meta
meta.description
meta.customsDescription
meta.country
meta.packageTemplate
meta.taxGroup
dimension
groupItems
groupItems.inventory
groupItems.inventory.meta
groupItems.inventoryItem
groupItems.inventoryItem.meta
category
category.category
category.category.parent
courierService
courierService.courierService
courierService.courierService.courier
tags
tags.tag
customFields
customFields.customFieldOption
settings
shelf
shelf.shelf
stocks
stocks.location
stocks.location.settings
linkedChannelProduct
linkedChannelProduct.channel
linkedChannelProduct.channel.settings
barcodes
inventorySuppliers
inventorySuppliers.inventoryContainer
inventorySuppliers.supplier
inventorySuppliers.supplier.contact
associatedGroup
associatedGroup.inventory.meta
associatedGroup.inventory.country
purchaseOrderControl
primarySupplier
primarySupplier.supplier
primarySupplier.supplier.contact
primarySupplier.supplier.fileManager
family
family.family
openInventoryChekItems
exportValues
exportValues.countries
exportValues.countries.country
groupItems.inventoryItem.exportValues
groupItems.inventoryItem.exportValues.countries
groupItems.inventoryItem.exportValues.countries.country
containers
exportValues
exportValues.countries
exportValues.countries.country
groupItems.inventoryItem.exportValues
groupItems.inventoryItem.exportValues.countries
groupItems.inventoryItem.exportValues.countries.country
groupItems.inventoryItem.dimension
groupItems.inventoryItem.serials
batches
batches.location
serials
groupItems.inventoryItem.dimension
groupItems.inventoryItem.settings

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Search.

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

Filter by Code.

\n","type":"text/plain"},"key":"code","value":""},{"disabled":true,"description":{"content":"

Filter by Inventory Type Id.

\n","type":"text/plain"},"key":"inventory_type_id","value":""},{"disabled":true,"description":{"content":"

Filter by Channels Id.

\n","type":"text/plain"},"key":"channels_id","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Hs Code.

\n","type":"text/plain"},"key":"hs_code","value":""},{"disabled":true,"description":{"content":"

Filter by Barcode.

\n","type":"text/plain"},"key":"barcode","value":""},{"disabled":true,"description":{"content":"

Filter by Country Id.

\n","type":"text/plain"},"key":"country_id","value":""},{"disabled":true,"description":{"content":"

Filter by Price From.

\n","type":"text/plain"},"key":"price_from","value":""},{"disabled":true,"description":{"content":"

Filter by Price To.

\n","type":"text/plain"},"key":"price_to","value":""},{"disabled":true,"description":{"content":"

Filter by Quantity From.

\n","type":"text/plain"},"key":"quantity_from","value":""},{"disabled":true,"description":{"content":"

Filter by Quantity To.

\n","type":"text/plain"},"key":"quantity_to","value":""},{"disabled":true,"description":{"content":"

Filter by Weight From.

\n","type":"text/plain"},"key":"weight_from","value":""},{"disabled":true,"description":{"content":"

Filter by Weight To.

\n","type":"text/plain"},"key":"weight_to","value":""},{"disabled":true,"description":{"content":"

Filter by Height From.

\n","type":"text/plain"},"key":"height_from","value":""},{"disabled":true,"description":{"content":"

Filter by Height To.

\n","type":"text/plain"},"key":"height_to","value":""},{"disabled":true,"description":{"content":"

Filter by Width From.

\n","type":"text/plain"},"key":"width_from","value":""},{"disabled":true,"description":{"content":"

Filter by Width To.

\n","type":"text/plain"},"key":"width_to","value":""},{"disabled":true,"description":{"content":"

Filter by Length From.

\n","type":"text/plain"},"key":"length_from","value":""},{"disabled":true,"description":{"content":"

Filter by Length To.

\n","type":"text/plain"},"key":"length_to","value":""},{"disabled":true,"description":{"content":"

Filter by Tag Id.

\n","type":"text/plain"},"key":"tag_id","value":""},{"disabled":true,"description":{"content":"

Filter by Location Id.

\n","type":"text/plain"},"key":"location_id","value":""},{"disabled":true,"description":{"content":"

Filter by Category Id.

\n","type":"text/plain"},"key":"category_id","value":""},{"disabled":true,"description":{"content":"

Filter by Packaging Code.

\n","type":"text/plain"},"key":"packaging_code","value":""},{"disabled":true,"description":{"content":"

Filter by Archived.

\n","type":"text/plain"},"key":"archived","value":""},{"disabled":true,"description":{"content":"

Filter by Is Batch Expired.

\n","type":"text/plain"},"key":"is_batch_expired","value":""},{"disabled":true,"description":{"content":"

Filter by Import Ids.

\n","type":"text/plain"},"key":"import_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - meta - meta.description - meta.customsDescription - meta.country - meta.packageTemplate - meta.taxGroup - dimension - groupItems - groupItems.inventory - groupItems.inventory.meta - groupItems.inventoryItem - groupItems.inventoryItem.meta - category - category.category - category.category.parent - courierService - courierService.courierService - courierService.courierService.courier - tags - tags.tag - customFields - customFields.customFieldOption - settings - shelf - shelf.shelf - stocks - stocks.location - stocks.location.settings - linkedChannelProduct - linkedChannelProduct.channel - linkedChannelProduct.channel.settings - barcodes - inventorySuppliers - inventorySuppliers.inventoryContainer - inventorySuppliers.supplier - inventorySuppliers.supplier.contact - associatedGroup - associatedGroup.inventory.meta - associatedGroup.inventory.country - purchaseOrderControl - primarySupplier - primarySupplier.supplier - primarySupplier.supplier.contact - primarySupplier.supplier.fileManager - family - family.family - openInventoryChekItems - exportValues - exportValues.countries - exportValues.countries.country - groupItems.inventoryItem.exportValues - groupItems.inventoryItem.exportValues.countries - groupItems.inventoryItem.exportValues.countries.country - containers - exportValues - exportValues.countries - exportValues.countries.country - groupItems.inventoryItem.exportValues - groupItems.inventoryItem.exportValues.countries - groupItems.inventoryItem.exportValues.countries.country - groupItems.inventoryItem.dimension - groupItems.inventoryItem.serials - batches - batches.location - serials - groupItems.inventoryItem.dimension - groupItems.inventoryItem.settings

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"45cbcef7-c5b3-4240-a0a7-0ab0022ff933"},{"name":"Inventory create","id":"320b320b-0d47-41f5-99eb-3ad4d4c78d4d","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"code\": \"code\",\n \"name\": \"name\",\n \"inventory_type_id\": \"1\",\n \"batching_type\": \"1\",\n \"courier_service_id\": \"{{courier_service_id}}\",\n \"tax_group_id\": \"{{tax_group_id}}\",\n \"is_packaging_item\": false,\n \"not_for_resale\": false,\n \"single_parcel_per_item\": false,\n \"auto_sync_stock\": false,\n \"height\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"length\": 0,\n \"nest_height\": 0,\n \"shelf\": \"\",\n \"quantity\": 0,\n \"country_id\": \"{{country_id}}\",\n \"hs_code\": 0,\n \"customs_description\": \"\",\n \"customs_value\": 0,\n \"description\": \"\",\n \"cost_price\": 0,\n \"price\": 0,\n \"tags\": [\n \"\"\n ],\n \"barcodes\": [\n {\n \"inventory_barcode_type_id\": \"1\",\n \"value\": \"value\"\n }\n ],\n \"image_url\": \"https://example.com/\",\n \"file_manager_id\": \"{{file_manager_id}}\",\n \"manufacturer_sku\": \"\",\n \"manufacturer_id\": \"{{manufacturer_id}}\",\n \"cpsc_mode\": \"\",\n \"cpsc_certifier_id\": \"{{cpsc_certifier_id}}\",\n \"cpsc_product_version\": \"\",\n \"cpsc_registry_product_id\": \"{{cpsc_registry_product_id}}\",\n \"cpsc_intended_use_code\": \"\",\n \"cpsc_intended_use_description\": \"\",\n \"cpsc_disclaim_code\": \"\",\n \"cpsc_disclaim_reason\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`code`	string	yes	`bail` + ScalarValue so an array value cannot reach `distinct` or the unique SELECT (both of which fatal on a non-string): `min:`/`max:` measure count() for an array, so the length rules let it through.
`name`	string	yes	—
`inventory_type_id`	string	yes	Types values: - `1` = INVENTORY - `2` = GROUP - `3` = SERVICE_CHARGE Allowed: `1`, `2`, `3`
`batching_type`	string \| null	no	Allowed: `1`, `2`, ``
`courier_service_id`	integer \| null	no	—
`tax_group_id`	integer \| null	no	—
`is_packaging_item`	boolean	no	—
`not_for_resale`	boolean	no	—
`single_parcel_per_item`	boolean	no	The asterisk in a dependent rule's parameter is resolved to the row being validated, so on bulk-create the prefixed reference compares against the sibling type, not a top-level one. Conditional: - Must not be sent when `inventory_type_id` is `2`.
`auto_sync_stock`	boolean	no	—
`height`	number \| null	no	—
`weight`	number \| null	no	—
`width`	number \| null	no	—
`length`	number \| null	no	—
`nest_height`	number \| null	no	—
`shelf`	string \| null	no	—
`tags`	array \| null	no	—
`quantity`	number \| null	no	Not `required`: create() never reads quantity (a non-advanced-mode row is always seeded at 0), so demanding it only blocked payloads that would have created fine.
`country_id`	integer \| null	no	—
`hs_code`	number \| null	no	`bail` on the numeric fields whose chain ends in a regex rule: `numeric` rejects an array but does not stop the chain, and both `digits_between` and ValidateDecimal preg_match the raw value, which is a TypeError (500) on an array rather than a 422.
`manufacturer_sku`	string \| null	no	Manufacturer part number, up to 100 characters. Sent to the courier as `manufacturer_sku`.
`manufacturer_id`	integer \| null	no	ID of a manufacturer of the same company (see the Manufacturers endpoints). Its MID and address are sent to the courier with the item.
`cpsc_mode`	string	no	US CPSC declaration: `not_applicable`, `certified` or `disclaimed`. Required whenever any `cpsc_*` field is sent. `certified` uses `cpsc_certifier_id` (optional when the company has a default certifier ID in System Defaults), `cpsc_product_version` and `cpsc_registry_product_id`; `disclaimed` uses `cpsc_intended_use_code`, `cpsc_disclaim_code`, `cpsc_disclaim_reason` and, for code `980.000`, `cpsc_intended_use_description`. Fields of the other declaration are ignored and cleared on the product; `not_applicable` clears all of them. The declaration itself is stored in Helm and is not sent to the courier.
`cpsc_certifier_id`	string \| null	no	Certifier ID of a certified declaration, up to 100 characters. Can be left out when the company has a default certifier ID in System Defaults; the default is then sent to the courier. Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `certified`.
`cpsc_product_version`	string	no	Certificate version of a certified declaration: letters and digits only, up to 50 characters (e.g. `V1`). Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `certified`. - Required when `cpsc_mode` is `certified`.
`cpsc_registry_product_id`	string	no	CPSC Product Registry ID of a certified declaration, up to 100 characters. Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `certified`. - Required when `cpsc_mode` is `certified`.
`cpsc_intended_use_code`	string	no	Intended use code (CBP Appendix R) of a disclaimed declaration, in the form `###.###` (e.g. `980.000`). Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `disclaimed`. - Required when `cpsc_mode` is `disclaimed`.
`cpsc_intended_use_description`	string \| null	no	Intended use as free text, up to 255 characters. Required when `cpsc_intended_use_code` is `980.000` (Other) and not stored for any other code. Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `disclaimed`. - Required when `cpsc_intended_use_code` is `980.000`.
`cpsc_disclaim_code`	string	no	Basis for disclaiming: `A` = not regulated by CPSC, `B` = data not required under CPSC guidance. Disclaimed declaration only. Lower case is accepted and stored in upper case. Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `disclaimed`. - Required when `cpsc_mode` is `disclaimed`.
`cpsc_disclaim_reason`	string	no	Basis for disclaiming as free text, up to 255 characters. Required for a disclaimed declaration. Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `disclaimed`. - Required when `cpsc_mode` is `disclaimed`.
`customs_description`	string \| null	no	—
`customs_value`	number \| null	no	—
`description`	string \| null	no	—
`cost_price`	number \| null	no	—
`price`	number \| null	no	—
`barcodes`	array \| null	no	—
`barcodes.*.inventory_barcode_type_id`	string	yes	BarcodeTypes values: - `1` = PACK - `2` = BOX - `3` = CARTON - `4` = INNER - `5` = OUTER - `6` = PALLET - `7` = TOTE - `8` = CONTAINER - `9` = CAGE - `10` = PIECE Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`
`barcodes.*.value`	string	yes	—
`image_url`	string	no	A publicly reachable `http`/`https` URL of the product image. The server fetches and stores it in the background, so it is not part of this response yet — read it back from `meta.image` once processed. Cannot be combined with `file_manager_id`. Conditional: - When this field is sent, `file_manager_id` must be missing or empty.
`file_manager_id`	integer	no	The id of a file already uploaded through POST /file-manager/upload with `type` = 6 (INVENTORY). Nothing is downloaded, so the image is attached immediately. Cannot be combined with `image_url`.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Returns the image currently attached to the product.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`file_manager_id`	integer\|null	Id of the stored file, `null` when the product has no image.
`image`	string\|null	URL of the full-size image.
`sizes`	object\|null	URLs of the generated renditions, keyed by pixel width (600, 426, 150, 30).

The product id.

\n","type":"text/plain"},"type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"4bb738f3-1ce4-4ac8-85b6-3d0b7973e65c"},{"name":"Inventory image store","id":"1936feb2-bc41-452f-8e1f-b9280508ff2f","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"image_url\": \"https://example.com/images/sku-1.jpg\",\n \"file_manager_id\": \"{{file_manager_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory/:inventoryID/image","description":"

Sets the product's image. Send exactly one of the two sources — sending both is a 422.

image_url — a publicly reachable http/https URL. The server downloads and stores it in the\nbackground, so the response is 202 Accepted with no body; read the result back with\nGET .../image (or the product with ?includes=meta).
file_manager_id — the id returned by POST /companies/{companyID}/file-manager/upload with\ntype = 6 (INVENTORY). Nothing has to be downloaded, so the image is attached immediately and\nthe response is 200 with the stored image.

The same two fields are also accepted, optionally, on inventory create, update, bulk-create and\nbulk-update.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`image_url`	string	no	A publicly reachable `http`/`https` URL of the product image. The server fetches and stores it in the background, so it is not part of this response yet — read it back from `meta.image` once processed. Cannot be combined with `file_manager_id`.
`file_manager_id`	integer	no	The id of a file already uploaded through POST /file-manager/upload with `type` = 6 (INVENTORY). Nothing is downloaded, so the image is attached immediately. Cannot be combined with `image_url`.

The product id.

\n","type":"text/plain"},"type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"1936feb2-bc41-452f-8e1f-b9280508ff2f"},{"name":"Inventory image destroy","id":"02e7978a-430b-44ea-a781-952ea919bd4a","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//inventory/:inventoryID/image","description":"

Removes the product's image and queues deletion of the stored file. Responds 204 No Content.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

The product id.

\n","type":"text/plain"},"type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"02e7978a-430b-44ea-a781-952ea919bd4a"},{"name":"Inventory show","id":"9ef5c6f5-cf0c-4e18-a6a7-85838d4abaec","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//inventory/:inventoryID","description":"

Unlike the list endpoint, this one does not return levels. Naming it in\nincludes is accepted and ignored rather than rejected, so one include\nlist works against both endpoints.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

meta
meta.description
meta.customsDescription
meta.country
meta.packageTemplate
meta.taxGroup
dimension
groupItems
groupItems.inventory
groupItems.inventory.meta
groupItems.inventoryItem
groupItems.inventoryItem.meta
category
category.category
category.category.parent
courierService
courierService.courierService
courierService.courierService.courier
tags
tags.tag
customFields
customFields.customFieldOption
settings
shelf
shelf.shelf
stocks
stocks.location
stocks.location.settings
linkedChannelProduct
linkedChannelProduct.channel
linkedChannelProduct.channel.settings
barcodes
inventorySuppliers
inventorySuppliers.inventoryContainer
inventorySuppliers.supplier
inventorySuppliers.supplier.contact
associatedGroup
associatedGroup.inventory.meta
associatedGroup.inventory.country
purchaseOrderControl
primarySupplier
primarySupplier.supplier
primarySupplier.supplier.contact
primarySupplier.supplier.fileManager
family
family.family
openInventoryChekItems
exportValues
exportValues.countries
exportValues.countries.country
groupItems.inventoryItem.exportValues
groupItems.inventoryItem.exportValues.countries
groupItems.inventoryItem.exportValues.countries.country
containers
exportValues
exportValues.countries
exportValues.countries.country
groupItems.inventoryItem.exportValues
groupItems.inventoryItem.exportValues.countries
groupItems.inventoryItem.exportValues.countries.country
groupItems.inventoryItem.dimension
groupItems.inventoryItem.serials
batches
batches.location
serials
groupItems.inventoryItem.dimension
groupItems.inventoryItem.settings

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"5a84ef6e-fe69-4979-96ed-86e505ebb4dd","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"9ef5c6f5-cf0c-4e18-a6a7-85838d4abaec"},{"name":"Inventory update","id":"22470e7b-6411-413c-8fa3-c23f5c57a319","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"name\": \"name\",\n \"courier_service_id\": \"{{courier_service_id}}\",\n \"tax_group_id\": \"{{tax_group_id}}\",\n \"is_packaging_item\": false,\n \"not_for_resale\": false,\n \"single_parcel_per_item\": false,\n \"auto_sync_stock\": false,\n \"height\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"length\": 0,\n \"nest_height\": 0,\n \"shelf\": \"\",\n \"quantity\": 0,\n \"country_id\": \"{{country_id}}\",\n \"hs_code\": 0,\n \"customs_description\": \"\",\n \"customs_value\": 0,\n \"description\": \"\",\n \"cost_price\": 0,\n \"price\": 0,\n \"image_url\": \"https://example.com/\",\n \"file_manager_id\": \"{{file_manager_id}}\",\n \"tags\": [\n \"\"\n ],\n \"barcodes\": [\n {\n \"inventory_barcode_type_id\": \"1\",\n \"value\": \"value\"\n }\n ],\n \"containers\": [\n {\n \"id\": \"{{id}}\",\n \"inventory_container_type_id\": \"1\",\n \"height\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"length\": 0,\n \"quantity\": 0\n }\n ],\n \"manufacturer_sku\": \"\",\n \"manufacturer_id\": \"{{manufacturer_id}}\",\n \"cpsc_mode\": \"\",\n \"cpsc_certifier_id\": \"{{cpsc_certifier_id}}\",\n \"cpsc_product_version\": \"\",\n \"cpsc_registry_product_id\": \"{{cpsc_registry_product_id}}\",\n \"cpsc_intended_use_code\": \"\",\n \"cpsc_intended_use_description\": \"\",\n \"cpsc_disclaim_code\": \"\",\n \"cpsc_disclaim_reason\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory/:inventoryID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string \| null	no	—
`courier_service_id`	integer \| null	no	—
`tax_group_id`	integer \| null	no	—
`is_packaging_item`	boolean	no	—
`not_for_resale`	boolean	no	—
`single_parcel_per_item`	boolean	no	—
`auto_sync_stock`	boolean	no	—
`height`	number \| null	no	—
`weight`	number \| null	no	—
`width`	number \| null	no	—
`length`	number \| null	no	—
`nest_height`	number \| null	no	—
`shelf`	string \| null	no	—
`tags`	array \| null	no	—
`quantity`	number \| null	no	—
`country_id`	integer \| null	no	—
`hs_code`	number \| null	no	—
`manufacturer_sku`	string \| null	no	Manufacturer part number, up to 100 characters. Sent to the courier as `manufacturer_sku`.
`manufacturer_id`	integer \| null	no	ID of a manufacturer of the same company (see the Manufacturers endpoints). Its MID and address are sent to the courier with the item.
`cpsc_mode`	string	no	US CPSC declaration: `not_applicable`, `certified` or `disclaimed`. Required whenever any `cpsc_*` field is sent. `certified` uses `cpsc_certifier_id` (optional when the company has a default certifier ID in System Defaults), `cpsc_product_version` and `cpsc_registry_product_id`; `disclaimed` uses `cpsc_intended_use_code`, `cpsc_disclaim_code`, `cpsc_disclaim_reason` and, for code `980.000`, `cpsc_intended_use_description`. Fields of the other declaration are ignored and cleared on the product; `not_applicable` clears all of them. The declaration itself is stored in Helm and is not sent to the courier.
`cpsc_certifier_id`	string \| null	no	Certifier ID of a certified declaration, up to 100 characters. Can be left out when the company has a default certifier ID in System Defaults; the default is then sent to the courier. Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `certified`.
`cpsc_product_version`	string	no	Certificate version of a certified declaration: letters and digits only, up to 50 characters (e.g. `V1`). Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `certified`. - Required when `cpsc_mode` is `certified`.
`cpsc_registry_product_id`	string	no	CPSC Product Registry ID of a certified declaration, up to 100 characters. Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `certified`. - Required when `cpsc_mode` is `certified`.
`cpsc_intended_use_code`	string	no	Intended use code (CBP Appendix R) of a disclaimed declaration, in the form `###.###` (e.g. `980.000`). Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `disclaimed`. - Required when `cpsc_mode` is `disclaimed`.
`cpsc_intended_use_description`	string \| null	no	Intended use as free text, up to 255 characters. Required when `cpsc_intended_use_code` is `980.000` (Other) and not stored for any other code. Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `disclaimed`. - Required when `cpsc_intended_use_code` is `980.000`.
`cpsc_disclaim_code`	string	no	Basis for disclaiming: `A` = not regulated by CPSC, `B` = data not required under CPSC guidance. Disclaimed declaration only. Lower case is accepted and stored in upper case. Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `disclaimed`. - Required when `cpsc_mode` is `disclaimed`.
`cpsc_disclaim_reason`	string	no	Basis for disclaiming as free text, up to 255 characters. Required for a disclaimed declaration. Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `disclaimed`. - Required when `cpsc_mode` is `disclaimed`.
`customs_description`	string \| null	no	—
`customs_value`	number \| null	no	—
`description`	string \| null	no	—
`cost_price`	number \| null	no	—
`price`	number \| null	no	—
`barcodes`	array \| null	no	—
`barcodes.*.inventory_barcode_type_id`	string	yes	BarcodeTypes values: - `1` = PACK - `2` = BOX - `3` = CARTON - `4` = INNER - `5` = OUTER - `6` = PALLET - `7` = TOTE - `8` = CONTAINER - `9` = CAGE - `10` = PIECE Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`
`barcodes.*.value`	string	yes	—
`containers`	array \| null	no	—
`containers.*.id`	integer \| null	no	ContainerService::bulkUpdateOrCreate deletes existing containers whose id is absent from the payload, so id must survive validation.
`containers.*.inventory_container_type_id`	string	yes	ContainerTypes values: - `1` = PACK - `2` = BOX - `3` = CARTON - `4` = INNER - `5` = OUTER - `6` = PALLET - `7` = TOTE - `8` = CONTAINER - `9` = CAGE - `10` = PCS Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`
`containers.*.height`	number \| null	no	—
`containers.*.weight`	number \| null	no	—
`containers.*.width`	number \| null	no	—
`containers.*.length`	number \| null	no	—
`containers.*.quantity`	number	yes	—
`image_url`	string	no	A publicly reachable `http`/`https` URL of the product image. The server fetches and stores it in the background, so it is not part of this response yet — read it back from `meta.image` once processed. Cannot be combined with `file_manager_id`. Conditional: - When this field is sent, `file_manager_id` must be missing or empty.
`file_manager_id`	integer	no	The id of a file already uploaded through POST /file-manager/upload with `type` = 6 (INVENTORY). Nothing is downloaded, so the image is attached immediately. Cannot be combined with `image_url`.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`removed_inventory_ids`	array \| null	no	—
`items`	array	yes	—
`items.*.quantity`	integer	yes	—
`items.*.group_item_id`	integer \| null	no	—
`items.*.inventory_item_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`inventoryItemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`quantity`	integer	yes	—
`inventory_item_id`	integer	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`package_template_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`auto_sync_stock`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`location`	string \| null	no	—
`cost_price`	number \| null	no	—
`price`	number \| null	no	—
`name`	string	yes	—
`description`	string \| null	no	—
`shelf`	string \| null	no	—
`tax_group_id`	integer \| null	no	—
`count_period`	number \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`
`batching_type`	string \| null	no	Allowed: `1`, `2`
`expiry_lead_time_days`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`height`	number \| null	no	—
`weight`	number \| null	no	—
`width`	number \| null	no	—
`length`	number \| null	no	—
`nest_height`	number \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

Field	Type	Required	Description
`country_id`	integer \| null	no	—
`hs_code`	number \| null	no	—
`manufacturer_sku`	string \| null	no	Manufacturer part number, up to 100 characters. Sent to the courier as `manufacturer_sku`.
`manufacturer_id`	integer \| null	no	ID of a manufacturer of the same company (see the Manufacturers endpoints). Its MID and address are sent to the courier with the item.
`cpsc_mode`	string	no	US CPSC declaration: `not_applicable`, `certified` or `disclaimed`. Required whenever any `cpsc_*` field is sent. `certified` uses `cpsc_certifier_id` (optional when the company has a default certifier ID in System Defaults), `cpsc_product_version` and `cpsc_registry_product_id`; `disclaimed` uses `cpsc_intended_use_code`, `cpsc_disclaim_code`, `cpsc_disclaim_reason` and, for code `980.000`, `cpsc_intended_use_description`. Fields of the other declaration are ignored and cleared on the product; `not_applicable` clears all of them. The declaration itself is stored in Helm and is not sent to the courier.
`cpsc_certifier_id`	string \| null	no	Certifier ID of a certified declaration, up to 100 characters. Can be left out when the company has a default certifier ID in System Defaults; the default is then sent to the courier. Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `certified`.
`cpsc_product_version`	string	no	Certificate version of a certified declaration: letters and digits only, up to 50 characters (e.g. `V1`). Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `certified`. - Required when `cpsc_mode` is `certified`.
`cpsc_registry_product_id`	string	no	CPSC Product Registry ID of a certified declaration, up to 100 characters. Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `certified`. - Required when `cpsc_mode` is `certified`.
`cpsc_intended_use_code`	string	no	Intended use code (CBP Appendix R) of a disclaimed declaration, in the form `###.###` (e.g. `980.000`). Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `disclaimed`. - Required when `cpsc_mode` is `disclaimed`.
`cpsc_intended_use_description`	string \| null	no	Intended use as free text, up to 255 characters. Required when `cpsc_intended_use_code` is `980.000` (Other) and not stored for any other code. Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `disclaimed`. - Required when `cpsc_intended_use_code` is `980.000`.
`cpsc_disclaim_code`	string	no	Basis for disclaiming: `A` = not regulated by CPSC, `B` = data not required under CPSC guidance. Disclaimed declaration only. Lower case is accepted and stored in upper case. Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `disclaimed`. - Required when `cpsc_mode` is `disclaimed`.
`cpsc_disclaim_reason`	string	no	Basis for disclaiming as free text, up to 255 characters. Required for a disclaimed declaration. Conditional: - Ignored (dropped from the validated payload) unless `cpsc_mode` is `disclaimed`. - Required when `cpsc_mode` is `disclaimed`.
`description`	string \| null	no	—
`customs_value`	number \| null	no	—
`export_values`	array	yes	—
`export_values.*.country_ids`	array	yes	—
`export_values.*.value`	number	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`barcodeID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`inventory_barcode_type_id`	string \| null	no	BarcodeTypes values: - `1` = PACK - `2` = BOX - `3` = CARTON - `4` = INNER - `5` = OUTER - `6` = PALLET - `7` = TOTE - `8` = CONTAINER - `9` = CAGE - `10` = PIECE Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`
`value`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`filter[]`	—
`sort`	—
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

inventory
inventory.meta
inventoryItem
inventoryItem.meta

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - inventory - inventory.meta - inventoryItem - inventoryItem.meta

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"2fc019cd-9eee-421c-86ac-1fe3c48ae592","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"52f08776-134b-43fb-9488-ce2681f6e71e"},{"name":"Inventory batches bulk store","id":"3a06f4c2-653d-4e34-a2f3-0834aa967e98","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"batches\": [\n {\n \"location_id\": \"{{location_id}}\",\n \"quantity\": 0,\n \"batch_number\": \"batch_number\",\n \"expiry_date\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory/:inventoryID/batches/bulk","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`batches`	array	yes	—
`batches.*.location_id`	integer	yes	—
`batches.*.quantity`	integer	yes	—
`batches.*.batch_number`	string	yes	—
`batches.*.expiry_date`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`deleted_ids`	array	no	—
`batches`	array	no	—
`batches.*.id`	integer \| null	no	—
`batches.*.location_id`	integer \| null	no	—
`batches.*.quantity`	integer	yes	—
`batches.*.batch_number`	string	yes	—
`batches.*.expiry_date`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[{"id":"95331709-8c5a-48c1-94ce-778f99b86637","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"f61f1c7d-030d-4df3-990e-bf199afda5f7"},{"name":"Inventory batches create","id":"bac0cb0f-b92c-408d-b14f-a34454f0fba9","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"location_id\": \"{{location_id}}\",\n \"quantity\": 0,\n \"batch_number\": \"batch_number\",\n \"expiry_date\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory/:inventoryID/batches","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`location_id`	integer	yes	—
`quantity`	integer	yes	—
`batch_number`	string	yes	—
`expiry_date`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`batchID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`location_id`	string	no	—
`quantity`	integer	yes	—
`batch_number`	string	no	—
`expiry_date`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`batchID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`courier_service_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`items`	array	yes	—
`items.*.country_ids`	array	yes	—
`items.*.value`	number	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[{"id":"89a508d4-68e2-4596-b401-6deb72bf2ea2","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"d732669f-8ff9-4f85-ae65-3d66e48a5450"},{"name":"Inventory items list","id":"eb5396a6-09ab-4627-9edd-83f9c2415c8a","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//inventory/:inventoryID/items","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[{"id":"cb1bbc35-3381-4fee-af8e-901d616aef3e","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"eb5396a6-09ab-4627-9edd-83f9c2415c8a"},{"name":"Inventory items bulk attach","id":"fa2d7e9a-154e-4d2e-bd78-15e3e33aa82a","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"items\": [\n {\n \"quantity\": 1,\n \"inventory_item_id\": \"{{inventory_item_id}}\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory/:inventoryID/items/bulk-attach","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`items`	array	yes	—
`items.*.quantity`	integer	yes	—
`items.*.inventory_item_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`items`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`items`	array	yes	—
`items.*.quantity`	integer	yes	—
`items.*.inventory_item_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`inventoryItemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`quantity`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`inventoryItemID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`inventoryItemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`quantity`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`ordering_method`	string \| null	no	ReturnsMethod values: - `1` = DIRECT_TO_LOCATION - `2` = ADD_SINGLE_MOVEMENT - `3` = ADD_MULTIPLE_MOVEMENT Allowed: `1`, `2`, `3`
`is_warning_open`	boolean \| null	no	—
`warning_level`	integer \| null	no	—
`days_of_stock_required`	number \| null	no	—
`maximum_level`	number \| null	no	—
`exclude_zero_sale_days`	boolean	no	—
`calculation_method`	string \| null	no	Allowed: `1`, `2`
`calculation_timeframe`	string \| null	no	Allowed: `1`, `2`, `3`, `4`
`trigger_level`	string \| null	no	—
`target_level`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`type`	Options: `1`, `3`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`is_packaging_item`	boolean	no	—
`not_for_resale`	boolean	no	—
`single_parcel_per_item`	boolean	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventory_id`	string	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`stocks`	array	yes	—
`stocks.*.location_id`	integer	yes	—
`stocks.*.quantity`	integer	yes	—
`stocks.*.max_level`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventory_id`	string	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`stocks`	array	yes	—
`stocks.*.stock_id`	integer	yes	—
`stocks.*.quantity`	integer	yes	—
`stocks.*.stock_change_reason`	string	yes	—
`stocks.*.max_level`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventory_id`	string	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`stock_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`priorities`	array	yes	—
`priorities.*.stock_id`	integer	yes	—
`priorities.*.priority`	number	yes	—

409 Conflict - the stock record is being updated by another operation (a despatch, a pick or a concurrent stock write on the same product). Retry after the number of seconds in the Retry-After header.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`quantity`	integer	yes	—
`trigger_level`	integer \| null	no	—
`stock_change_reason`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[{"id":"456bbcdd-a7c8-4b07-8b8e-98d481dfa209","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"f5c78938-104e-47e0-ad05-fead96d9d107"},{"name":"Inventory stocks create","id":"94f00f61-c5b3-46d0-940e-a02ec241b161","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"location_id\": \"{{location_id}}\",\n \"quantity\": 0,\n \"job_reason_id\": \"{{job_reason_id}}\",\n \"max_level\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory/:inventoryID/stocks","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`location_id`	integer	yes	—
`quantity`	integer	yes	—
`job_reason_id`	integer \| null	no	—
`max_level`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`stockID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`quantity`	integer	yes	—
`stock_change_reason`	string	yes	—
`max_level`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`stockID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

Parameter	Description
`includes_count`	—
`filter[]`	—
`sort`	—
`inventory_id`	Filter by Inventory Id.
`inventory_batch_id`	Filter by Inventory Batch Id.
`item_serial_id`	Filter by Item Serial Id.
`query`	Filter by Query.
`created_at_from`	Filter by Created At From.
`created_at_to`	Filter by Created At To.
`user_id`	Filter by User Id.
`currency_code`	Filter by Currency Code.
`currency_id`	Filter by Currency Id.
`code`	Filter by Code.
`shelf`	Filter by Shelf.
`location_code`	Filter by Location Code.
`location_id`	Filter by Location Id.
`loggable_type`	Filter by Loggable Type.
`activity_type`	Filter by Activity Type.
`entry_type`	Filter by Entry Type.
`quantity_from`	Filter by Quantity From.
`quantity_to`	Filter by Quantity To.
`unit_value_from`	Filter by Unit Value From.
`unit_value_to`	Filter by Unit Value To.
`entry_value_from`	Filter by Entry Value From.
`entry_value_to`	Filter by Entry Value To.
`unit_cost_from`	Filter by Unit Cost From.
`unit_cost_to`	Filter by Unit Cost To.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.
`listForPreloadFilters`	Filter by List For Preload Filters.
`listForFilters`	Filter by List For Filters.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

inventory
batch
serials
serials.serial
user
beforeLocation
location
loggable
currency
meta

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Inventory Id.

\n","type":"text/plain"},"key":"inventory_id","value":""},{"disabled":true,"description":{"content":"

Filter by Inventory Batch Id.

\n","type":"text/plain"},"key":"inventory_batch_id","value":""},{"disabled":true,"description":{"content":"

Filter by Item Serial Id.

\n","type":"text/plain"},"key":"item_serial_id","value":""},{"disabled":true,"description":{"content":"

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Created At From.

\n","type":"text/plain"},"key":"created_at_from","value":""},{"disabled":true,"description":{"content":"

Filter by Created At To.

\n","type":"text/plain"},"key":"created_at_to","value":""},{"disabled":true,"description":{"content":"

Filter by User Id.

\n","type":"text/plain"},"key":"user_id","value":""},{"disabled":true,"description":{"content":"

Filter by Currency Code.

\n","type":"text/plain"},"key":"currency_code","value":""},{"disabled":true,"description":{"content":"

Filter by Currency Id.

\n","type":"text/plain"},"key":"currency_id","value":""},{"disabled":true,"description":{"content":"

Filter by Code.

\n","type":"text/plain"},"key":"code","value":""},{"disabled":true,"description":{"content":"

Filter by Shelf.

\n","type":"text/plain"},"key":"shelf","value":""},{"disabled":true,"description":{"content":"

Filter by Location Code.

\n","type":"text/plain"},"key":"location_code","value":""},{"disabled":true,"description":{"content":"

Filter by Location Id.

\n","type":"text/plain"},"key":"location_id","value":""},{"disabled":true,"description":{"content":"

Filter by Loggable Type.

\n","type":"text/plain"},"key":"loggable_type","value":""},{"disabled":true,"description":{"content":"

Filter by Activity Type.

\n","type":"text/plain"},"key":"activity_type","value":""},{"disabled":true,"description":{"content":"

Filter by Entry Type.

\n","type":"text/plain"},"key":"entry_type","value":""},{"disabled":true,"description":{"content":"

Filter by Quantity From.

\n","type":"text/plain"},"key":"quantity_from","value":""},{"disabled":true,"description":{"content":"

Filter by Quantity To.

\n","type":"text/plain"},"key":"quantity_to","value":""},{"disabled":true,"description":{"content":"

Filter by Unit Value From.

\n","type":"text/plain"},"key":"unit_value_from","value":""},{"disabled":true,"description":{"content":"

Filter by Unit Value To.

\n","type":"text/plain"},"key":"unit_value_to","value":""},{"disabled":true,"description":{"content":"

Filter by Entry Value From.

\n","type":"text/plain"},"key":"entry_value_from","value":""},{"disabled":true,"description":{"content":"

Filter by Entry Value To.

\n","type":"text/plain"},"key":"entry_value_to","value":""},{"disabled":true,"description":{"content":"

Filter by Unit Cost From.

\n","type":"text/plain"},"key":"unit_cost_from","value":""},{"disabled":true,"description":{"content":"

Filter by Unit Cost To.

\n","type":"text/plain"},"key":"unit_cost_to","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Filter by List For Preload Filters.

\n","type":"text/plain"},"key":"listForPreloadFilters","value":""},{"disabled":true,"description":{"content":"

Filter by List For Filters.

\n","type":"text/plain"},"key":"listForFilters","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - inventory - batch - serials - serials.serial - user - beforeLocation - location - loggable - currency - meta

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"f7c26be3-e63f-4a4b-8419-157cb0c32e0b","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"b7abb5ac-b1f9-49b6-aaa6-bd6df3cce753"},{"name":"Inventory suppliers sorting","id":"f3630b1e-4a5c-4658-9ee7-a2b70a9d9fd3","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sorting\": [\n {\n \"id\": \"{{id}}\",\n \"priority\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory/:inventoryID/suppliers/sorting","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`sorting`	array	yes	—
`sorting.*.id`	integer	yes	—
`sorting.*.priority`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`inventory_suppliers`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filter[]`	—
`sort`	—
`includes_count`	—
`inventory_id`	Filter by Inventory Id.
`supplier_id`	Filter by Supplier Id.
`currency_id`	Filter by Currency Id.
`supplier_code`	Filter by Supplier Code.
`item_cost_from`	Filter by Item Cost From.
`item_cost_to`	Filter by Item Cost To.
`lead_time_from`	Filter by Lead Time From.
`lead_time_to`	Filter by Lead Time To.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

inventory
supplier
supplier.contact
supplier.purchasingSettings
supplier.fileManager
inventoryContainer

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Inventory Id.

\n","type":"text/plain"},"key":"inventory_id","value":""},{"disabled":true,"description":{"content":"

Filter by Supplier Id.

\n","type":"text/plain"},"key":"supplier_id","value":""},{"disabled":true,"description":{"content":"

Filter by Currency Id.

\n","type":"text/plain"},"key":"currency_id","value":""},{"disabled":true,"description":{"content":"

Filter by Supplier Code.

\n","type":"text/plain"},"key":"supplier_code","value":""},{"disabled":true,"description":{"content":"

Filter by Item Cost From.

\n","type":"text/plain"},"key":"item_cost_from","value":""},{"disabled":true,"description":{"content":"

Filter by Item Cost To.

\n","type":"text/plain"},"key":"item_cost_to","value":""},{"disabled":true,"description":{"content":"

Filter by Lead Time From.

\n","type":"text/plain"},"key":"lead_time_from","value":""},{"disabled":true,"description":{"content":"

Filter by Lead Time To.

\n","type":"text/plain"},"key":"lead_time_to","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - inventory - supplier - supplier.contact - supplier.purchasingSettings - supplier.fileManager - inventoryContainer

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"4f2b7f99-f783-4138-8d56-c4b5f8b02cd5","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"35d18ddf-376c-4456-a7cc-ffa72c2d3314"},{"name":"Inventory suppliers create","id":"e2db9ab1-8ef2-4c9b-ae00-194214f3c8dc","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"suppliers\": [\n {\n \"id\": null,\n \"supplier_id\": \"{{supplier_id}}\",\n \"currency_id\": \"{{currency_id}}\",\n \"supplier_code\": \"\",\n \"item_cost\": 0,\n \"lead_time\": 1,\n \"lead_time_type\": 1,\n \"minimum_order_quantity\": 0,\n \"inventory_container_id\": \"{{inventory_container_id}}\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory/:inventoryID/suppliers","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`suppliers`	array	yes	—
`suppliers.*.id`	integer \| null	no	—
`suppliers.*.supplier_id`	integer	yes	—
`suppliers.*.currency_id`	integer	yes	—
`suppliers.*.supplier_code`	string \| null	no	—
`suppliers.*.item_cost`	number	yes	—
`suppliers.*.lead_time`	number	yes	—
`suppliers.*.lead_time_type`	integer	yes	Allowed: `1`
`suppliers.*.minimum_order_quantity`	integer \| null	no	—
`suppliers.*.inventory_container_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`inventorySupplierID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filter[]`	—
`search`	Filter by Search.
`inventory_id`	Filter by Inventory Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Search.

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

Filter by Inventory Id.

\n","type":"text/plain"},"key":"inventory_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"dbb36d54-677a-4c47-869d-f6d4d9adb89b"},{"name":"Inventory ext tags attached","id":"46d80526-461e-463d-98cf-6c588af51a8d","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//inventory/attached-tags?ignore_ids[]=","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filters`	—
`ignore_ids[]`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`tagID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`tagID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`serials`	array	yes	—
`serials.*.serial_number`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`deleted_ids`	array	no	—
`serials`	array	no	—
`serials.*.id`	integer \| null	no	—
`serials.*.serial_number`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`inventory_id`	Filter by Inventory Id.
`in_used`	Filter by In Used.
`status`	Filter by Status.
`serial_number`	Filter by Serial Number.
`order_id`	Filter by Order Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.
`listForPreloadFilters`	Filter by List For Preload Filters.
`listForFilters`	Filter by List For Filters.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

inventory
inventory.meta
order

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Inventory Id.

\n","type":"text/plain"},"key":"inventory_id","value":""},{"disabled":true,"description":{"content":"

Filter by In Used.

\n","type":"text/plain"},"key":"in_used","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Serial Number.

\n","type":"text/plain"},"key":"serial_number","value":""},{"disabled":true,"description":{"content":"

Filter by Order Id.

\n","type":"text/plain"},"key":"order_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Filter by List For Preload Filters.

\n","type":"text/plain"},"key":"listForPreloadFilters","value":""},{"disabled":true,"description":{"content":"

Filter by List For Filters.

\n","type":"text/plain"},"key":"listForFilters","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - inventory - inventory.meta - order

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"9ce96cff-5b7c-4b77-b559-0bf5881250f5","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"c34c912a-3faa-4475-af46-c411187ef925"},{"name":"Inventory serials create","id":"92337361-ba46-4138-b686-b5d0c03c7abf","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"serial_number\": \"serial_number\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory/:inventoryID/serials","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`serial_number`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`serialID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`serial_number`	string	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`serialID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`stockID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`replenishment_type`	string \| null	no	Allowed: `1`, `2`, `3`
`replenishment_level`	integer	no	—
`replenishment_container_id`	integer	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filter[]`	—
`search`	Filter by Search.
`name`	Filter by Name.
`inventory_id`	Filter by Inventory Id.

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Search.

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Inventory Id.

\n","type":"text/plain"},"key":"inventory_id","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"3b8e4c94-dcb1-4f33-9240-3c23df0c4e02"},{"name":"Inventory ext shelves create","id":"0dcefdeb-285e-4550-a2a2-3ba2b0509f67","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory/:inventoryID/shelves","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`shelfID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryID`	integer	yes
`shelfID`	integer	yes

Each row is an inventory item, not a location. The storage locations\nholding it are nested under locations, and that is where location_id\nand quantity live, so the top level of a row says nothing about stock.

A row appears only if the item has at least one location that is in the\ncompany's default warehouse and whose settings record marks it Storage.\nAn item with no such location is left out of the response entirely rather\nthan returned with an empty locations array, so a short list is not\nevidence that the company holds no stock. Stock in another warehouse,\nstock in a Goods In, Goods Out, Returns, Assembly or Sort Wall location,\nand stock in a location that has no settings record at all, are all\nomitted this way.

location_code, zone_id and min_quantity are applied to that same\ntest, so they do more than trim locations: an item whose only matching\nlocation fails one of them drops out of the response too. inventory_id,\ninventory_ids and sku filter the items themselves.

supports array for multiple inventories

\n","type":"text/plain"},"key":"inventory_id","value":"1"},{"disabled":true,"key":"location_code","value":"0"},{"disabled":true,"key":"zone_id","value":"1"},{"disabled":true,"key":"min_quantity","value":"0"},{"disabled":true,"description":{"content":"

Available values: id, created_at, meta.name, code, inventory_type_id, meta.price, meta.hs_code, dimension.weight, batching_type

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Available values: asc,desc

\n","type":"text/plain"},"key":"sort_direction","value":"asc"},{"description":{"content":"

max value is 250

\n","type":"text/plain"},"key":"per_page","value":"10"},{"description":{"content":"

current page

\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"9480da85-9b40-474c-902f-ab0e75187805"}],"id":"c041be86-6d82-42b6-970a-2a10f4da58c5","description":"

Inventory — 106 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"c041be86-6d82-42b6-970a-2a10f4da58c5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Inventory Categories","item":[{"name":"Inventory ext categories inventory count","id":"c966471f-fca0-4fee-902f-bc635b821a4b","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//inventory-categories/:categoryID/inventory-count","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`categoryID`	integer	yes

Inventory Categories — 1 endpoint.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"4ee2e8e5-a96a-45c8-8d51-6cbb6be93cdb","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Inventory Check Transaction","item":[{"name":"Inventory check transaction logs","id":"3b56c59b-bf09-48c9-9641-dc182f9ff8a8","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//inventory-check-transaction/:transactionID/logs","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`transactionID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`status`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`transactionID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`transactionID`	integer	yes

Inventory Check Transaction — 3 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"77b11321-07c2-400b-8eb7-4f6fe4397e63","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Inventory Checks","item":[{"name":"Inventory checks list","id":"7a4fcd28-e610-46c6-aca5-bde31d1823cd","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//inventory-checks","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`archived`	Filter by Archived.
`inventory_check_number`	Filter by Inventory Check Number.
`status`	Filter by Status.
`item_count_from`	Filter by Item Count From.
`item_count_to`	Filter by Item Count To.
`assigned_user_id`	Filter by Assigned User Id.
`created_at_from`	Filter by Created At From.
`created_at_to`	Filter by Created At To.
`assigned_user_date_from`	Filter by Assigned User Date From.
`assigned_user_date_to`	Filter by Assigned User Date To.
`completed_at_from`	Filter by Completed At From.
`completed_at_to`	Filter by Completed At To.
`is_mobile`	Filter by Is Mobile.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

items
items.inventory
items.inventory.meta
items.inventory.barcodes
items.inventory.stocks
items.inventory.stocks.location
items.location
assignedUser
assignedUser.user
assignedUser.user.fileManager
assignedUser.timeTracking
assignedUsers
assignedUsers.user
assignedUsers.user.fileManager
assignedUsers.timeTracking
tags
tags.tag
archivedBy.user
archivedBy.user.fileManager

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Archived.

\n","type":"text/plain"},"key":"archived","value":""},{"disabled":true,"description":{"content":"

Filter by Inventory Check Number.

\n","type":"text/plain"},"key":"inventory_check_number","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Item Count From.

\n","type":"text/plain"},"key":"item_count_from","value":""},{"disabled":true,"description":{"content":"

Filter by Item Count To.

\n","type":"text/plain"},"key":"item_count_to","value":""},{"disabled":true,"description":{"content":"

Filter by Assigned User Id.

\n","type":"text/plain"},"key":"assigned_user_id","value":""},{"disabled":true,"description":{"content":"

Filter by Created At From.

\n","type":"text/plain"},"key":"created_at_from","value":""},{"disabled":true,"description":{"content":"

Filter by Created At To.

\n","type":"text/plain"},"key":"created_at_to","value":""},{"disabled":true,"description":{"content":"

Filter by Assigned User Date From.

\n","type":"text/plain"},"key":"assigned_user_date_from","value":""},{"disabled":true,"description":{"content":"

Filter by Assigned User Date To.

\n","type":"text/plain"},"key":"assigned_user_date_to","value":""},{"disabled":true,"description":{"content":"

Filter by Completed At From.

\n","type":"text/plain"},"key":"completed_at_from","value":""},{"disabled":true,"description":{"content":"

Filter by Completed At To.

\n","type":"text/plain"},"key":"completed_at_to","value":""},{"disabled":true,"description":{"content":"

Filter by Is Mobile.

\n","type":"text/plain"},"key":"is_mobile","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - items - items.inventory - items.inventory.meta - items.inventory.barcodes - items.inventory.stocks - items.inventory.stocks.location - items.location - assignedUser - assignedUser.user - assignedUser.user.fileManager - assignedUser.timeTracking - assignedUsers - assignedUsers.user - assignedUsers.user.fileManager - assignedUsers.timeTracking - tags - tags.tag - archivedBy.user - archivedBy.user.fileManager

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"7a4fcd28-e610-46c6-aca5-bde31d1823cd"},{"name":"Inventory checks create","id":"a2029706-98d2-42de-b8fe-944474aea334","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"is_bulk\": false,\n \"clear_zero_stock_locations\": false,\n \"inventory_list\": [\n {\n \"inventory_id\": \"{{inventory_id}}\"\n }\n ],\n \"split\": {\n \"per_zone\": false,\n \"set_maximum_lines\": false,\n \"maximum_lines\": 0,\n \"assigned_users\": [\n 0\n ]\n },\n \"filters\": [\n [\n {\n \"field\": \"80\",\n \"operator\": 0,\n \"value\": [\n \"\"\n ]\n }\n ]\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory-checks","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`is_bulk`	boolean	yes	—
`clear_zero_stock_locations`	boolean \| null	no	—
`inventory_list`	array \| null	no	—
`inventory_list.*.inventory_id`	integer	no	—
`split`	object	yes	—
`split.per_zone`	boolean \| null	no	—
`split.set_maximum_lines`	boolean \| null	no	—
`split.maximum_lines`	integer \| null	no	—
`split.assigned_users`	array \| null	no	—
`filters`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryCheckID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

items
items.inventory
items.inventory.meta
items.inventory.barcodes
items.inventory.stocks
items.inventory.stocks.location
items.location
assignedUser
assignedUser.user
assignedUser.user.fileManager
assignedUser.timeTracking
assignedUsers
assignedUsers.user
assignedUsers.user.fileManager
assignedUsers.timeTracking
tags
tags.tag
archivedBy.user
archivedBy.user.fileManager

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"03664527-f5a9-4a24-9dad-bc456a160fb9","type":"any","value":"","key":"inventoryCheckID"}]}},"response":[],"_postman_id":"bea8aacc-e353-4bcc-9483-6b854993d443"},{"name":"Inventory checks update","id":"0ed93bd3-a9c0-43a2-b09e-65d5262726ef","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"is_hold\": false,\n \"clear_zero_stock_locations\": false,\n \"assigned_device_name\": \"\",\n \"assigned_device_id\": \"{{assigned_device_id}}\",\n \"notes\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory-checks/:inventoryCheckID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryCheckID`	integer	yes

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

items
items.inventory
items.inventory.meta
items.inventory.barcodes
items.inventory.stocks
items.inventory.stocks.location
items.location
assignedUser
assignedUser.user
assignedUser.user.fileManager
assignedUser.timeTracking
assignedUsers
assignedUsers.user
assignedUsers.user.fileManager
assignedUsers.timeTracking
tags
tags.tag
archivedBy.user
archivedBy.user.fileManager

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`is_hold`	boolean \| null	no	—
`clear_zero_stock_locations`	boolean \| null	no	—
`assigned_device_name`	string \| null	no	—
`assigned_device_id`	string \| null	no	—
`notes`	string \| null	no	—

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"22f6baf1-8167-4396-8bb5-f624fb22634a","type":"any","value":"","key":"inventoryCheckID"}]}},"response":[],"_postman_id":"0ed93bd3-a9c0-43a2-b09e-65d5262726ef"},{"name":"Inventory checks delete","id":"1b586100-1223-4ffd-87d8-ba2bcd61f95d","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//inventory-checks/:inventoryCheckID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryCheckID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryCheckID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

company
inventoryCheck
tag

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - company - inventoryCheck - tag

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"09d79eac-82cc-401d-8730-faf02f4fa07e","type":"any","value":"","key":"inventoryCheckID"}]}},"response":[],"_postman_id":"fe5aac52-00da-45b2-a733-b6f376e3a9a8"},{"name":"Inventory checks tags create","id":"a9237e0e-a9cd-4e3a-b616-b9b965b99a0f","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"inventory_check_id\": \"{{inventory_check_id}}\",\n \"name\": \"name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory-checks/:inventoryCheckID/tags","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryCheckID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`inventory_check_id`	integer	yes	—
`name`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryCheckID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`inventory_check_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryCheckID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`inventory_check_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryCheckID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`inventory_check_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryCheckID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`inventory_check_id`	Filter by Inventory Check Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

timeTracking
user
user.fileManager

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Inventory Check Id.

\n","type":"text/plain"},"key":"inventory_check_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - timeTracking - user - user.fileManager

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"30291452-f028-423c-9772-13ba540ade3c","type":"any","value":"","key":"inventoryCheckID"}]}},"response":[],"_postman_id":"c91d6093-7997-4e9d-aea5-7b4f6c1a075a"},{"name":"Inventory checks assigned users update","id":"abc6690c-925e-411e-a380-8071f230a431","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"inventory_check_id\": \"{{inventory_check_id}}\",\n \"user_id\": \"{{user_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory-checks/:inventoryCheckID/assigned-users","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryCheckID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`inventory_check_id`	integer	yes	—
`user_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryCheckID`	integer	yes
`userID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

timeTracking
user
user.fileManager

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - timeTracking - user - user.fileManager

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"19c5f7b2-9bc1-4175-87b4-58dedda40241","type":"any","value":"","key":"inventoryCheckID"},{"id":"07242f41-216c-41ae-a366-d971b8eea138","type":"any","value":"","key":"userID"}]}},"response":[],"_postman_id":"f5cfe5e5-6e92-4641-8a79-6c9925892ea5"},{"name":"Inventory checks time tracking start","id":"3b2f3744-bd50-4206-b404-00ded998ea7f","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"inventory_check_id\": \"{{inventory_check_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory-checks/:inventoryCheckID/time-tracking/start","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryCheckID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`inventory_check_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryCheckID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`inventory_check_id`	integer	yes	—
`stopped_at`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryCheckID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`inventory_check_id`	—
`ids[]`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryCheckID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`inventory_check_id`	—
`ids[]`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryCheckID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`company_id`	—
`is_mobile`	—
`inventory_check_id`	Filter by Inventory Check Id.
`product_name`	Filter by Product Name.
`product_code`	Filter by Product Code.
`from_zone_id`	Filter by From Zone Id.
`from_location_id`	Filter by From Location Id.
`to_zone_id`	Filter by To Zone Id.
`to_location_id`	Filter by To Location Id.
`moved_qty_from`	Filter by Moved Qty From.
`moved_qty_to`	Filter by Moved Qty To.
`status`	Filter by Status.
`query`	Filter by Query.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

inventory
inventory.meta
inventory.barcodes
inventory.stocks
inventory.stocks.location
location
inventoryCheck
batch

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Inventory Check Id.

\n","type":"text/plain"},"key":"inventory_check_id","value":""},{"disabled":true,"description":{"content":"

Filter by Product Name.

\n","type":"text/plain"},"key":"product_name","value":""},{"disabled":true,"description":{"content":"

Filter by Product Code.

\n","type":"text/plain"},"key":"product_code","value":""},{"disabled":true,"description":{"content":"

Filter by From Zone Id.

\n","type":"text/plain"},"key":"from_zone_id","value":""},{"disabled":true,"description":{"content":"

Filter by From Location Id.

\n","type":"text/plain"},"key":"from_location_id","value":""},{"disabled":true,"description":{"content":"

Filter by To Zone Id.

\n","type":"text/plain"},"key":"to_zone_id","value":""},{"disabled":true,"description":{"content":"

Filter by To Location Id.

\n","type":"text/plain"},"key":"to_location_id","value":""},{"disabled":true,"description":{"content":"

Filter by Moved Qty From.

\n","type":"text/plain"},"key":"moved_qty_from","value":""},{"disabled":true,"description":{"content":"

Filter by Moved Qty To.

\n","type":"text/plain"},"key":"moved_qty_to","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - inventory - inventory.meta - inventory.barcodes - inventory.stocks - inventory.stocks.location - location - inventoryCheck - batch

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"7c5df47f-1594-43d4-b374-5cc8c4fb12ce","type":"any","value":"","key":"inventoryCheckID"}]}},"response":[],"_postman_id":"62b6e1b2-bb38-4c60-8422-e1095bd0deb4"},{"name":"Inventory checks items create","id":"bdbf7da8-9398-400f-b501-8764e71daa5f","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"inventory_check_id\": \"{{inventory_check_id}}\",\n \"items\": [\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory-checks/:inventoryCheckID/items","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`inventoryCheckID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`inventory_check_id`	integer	yes	—
`items`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryCheckID`	integer	yes
`itemID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryCheckID`	integer	yes
`itemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`action_quantity`	string	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`company_id`	—
`search`	—
`name`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryCheckID`	integer	yes
`tagID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`inventory_check_id`	integer	yes	—
`tag_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`inventoryCheckID`	integer	yes
`tagID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`inventory_check_id`	integer	yes	—
`tag_id`	integer	yes	—

Attach an uploaded image (file_manager_id, an INVENTORY_CHECK/type-27 file owned by the company) to the given inventory-check item, and set it as the owning Location's Last Image.

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Notes
`file_manager_id`	integer	yes	An owned, uploaded `type=27` file, not already linked to another attachment.

Path params: company_id, inventory_check_id (not COMPLETED / not archived), item_id (belongs to the check).

Permission: inventory_checks.items.attachments.store · Ability: inventory_checks:write.

Responses: 201 created (see example) · 422 validation (bad/foreign/duplicate file_manager_id, completed/archived check) · 403 missing ability/permission.

Replace the image on an existing attachment. Supply the new file_manager_id. If this attachment currently backs the Location's Last Image, the Location pointer is repointed to the new file and the old file is removed.

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Notes
`file_manager_id`	integer	yes	New owned `type=27` file; not linked to a different attachment (the current attachment is ignored, so re-sending the same file is fine).

Permission: inventory_checks.items.attachments.update · Ability: inventory_checks:write.

Responses: 200 OK (updated resource) · 422 validation · 403 auth.

Delete an attachment and remove its physical file. If the deleted file was the Location's Last Image, the Location falls back to its previous remaining attachment for that location (or null if none remain).

Permission: inventory_checks.items.attachments.update (delete reuses the update key) · Ability: inventory_checks:write.

Responses: 204 No Content · 422 validation (foreign/cross-tenant ids) · 403 auth.

Inventory Checks — 24 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"23a103c8-25be-4f20-ae5f-38b71c45b110","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Inventory Families","item":[{"name":"Inventory ext families bulk create","id":"40e55963-7e34-4f8d-a4b0-6d13d67f1f5b","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"families\": [\n {\n \"name\": \"name\",\n \"parent_id\": \"{{parent_id}}\",\n \"description\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory-families/bulk-create","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`families`	array	yes	—
`families.*.name`	string	yes	—
`families.*.parent_id`	integer \| null	no	—
`families.*.description`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`families`	array	yes	—
`families.*.id`	integer \| null	no	—
`families.*.name`	string	yes	—
`families.*.parent_id`	integer \| null	no	—
`families.*.description`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`families`	array	yes	—
`families.*.id`	integer	yes	—
`families.*.name`	string	yes	—
`families.*.description`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`parent_id`	—
`filter[]`	—
`sort`	—
`includes_count`	—
`name`	Filter by Name.
`family_name`	Filter by Family Name.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

inventoryFamily

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Family Name.

\n","type":"text/plain"},"key":"family_name","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - inventoryFamily

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"b65f075c-4b8a-491c-a496-825f9551a81c"},{"name":"Inventory ext families create","id":"fa575aed-3840-48c7-8fc4-bda2d6c534c5","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"name\",\n \"parent_id\": \"{{parent_id}}\",\n \"description\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//inventory-families","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string	yes	—
`parent_id`	integer \| null	no	—
`description`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`familyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string	yes	—
`parent_id`	integer \| null	no	—
`description`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`familyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`familyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Inventory Families — 8 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"06a48c0d-39e6-41ee-a45b-667abed5a8a0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Job Reasons","item":[{"name":"Job reasons bulk create","id":"78edb5e3-106e-4a9f-bcb6-6802e9a48522","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"job_reasons\": [\n {\n \"reason_types\": [\n \"1\"\n ],\n \"reason\": \"reason\",\n \"channels\": [\n 0\n ],\n \"order_number\": 1,\n \"is_active\": false,\n \"image_status\": \"1\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//job-reasons/bulk-create","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`job_reasons`	array	yes	—
`job_reasons.*.reason_types`	array	yes	—
`job_reasons.*.reason`	string	yes	—
`job_reasons.*.channels`	array \| null	no	—
`job_reasons.*.order_number`	integer \| null	no	—
`job_reasons.*.is_active`	boolean \| null	no	—
`job_reasons.*.image_status`	string \| null	no	Allowed: `1`, `2`, `3`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`job_reasons`	array	yes	—
`job_reasons.*.id`	integer	yes	—
`job_reasons.*.reason_types`	array \| null	no	—
`job_reasons.*.reason`	string	yes	—
`job_reasons.*.channels`	array \| null	no	—
`job_reasons.*.order_number`	integer \| null	no	—
`job_reasons.*.is_active`	boolean \| null	no	—
`job_reasons.*.image_status`	string \| null	no	Allowed: `1`, `2`, `3`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`job_reason_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filter[ids][]`	—
`archived`	—
`sort`	—
`includes_count`	—
`search`	Filter by Search.
`reason`	Filter by Reason.
`channel_id`	Filter by Channel Id.
`is_active`	Filter by Is Active.
`reason_type`	Filter by Reason Type.
`image_status`	Filter by Image Status.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

channels
channels.channel
channels.channel.settings

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Search.

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

Filter by Reason.

\n","type":"text/plain"},"key":"reason","value":""},{"disabled":true,"description":{"content":"

Filter by Channel Id.

\n","type":"text/plain"},"key":"channel_id","value":""},{"disabled":true,"description":{"content":"

Filter by Is Active.

\n","type":"text/plain"},"key":"is_active","value":""},{"disabled":true,"description":{"content":"

Filter by Reason Type.

\n","type":"text/plain"},"key":"reason_type","value":""},{"disabled":true,"description":{"content":"

Filter by Image Status.

\n","type":"text/plain"},"key":"image_status","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - channels - channels.channel - channels.channel.settings

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"439f7add-d37c-4069-9c0a-e6a42b4f042d"},{"name":"Job reasons create","id":"28058d5d-9681-4fa6-9be7-ac1c2e40dee7","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"reason\",\n \"order_number\": 1,\n \"is_active\": false,\n \"image_status\": \"1\",\n \"reason_types\": [\n \"1\"\n ],\n \"channels\": [\n 0\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//job-reasons","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`reason`	string	yes	—
`order_number`	integer \| null	no	—
`is_active`	boolean \| null	no	—
`image_status`	string \| null	no	Allowed: `1`, `2`, `3`
`reason_types`	array	yes	—
`channels`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`jobReasonID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

channels
channels.channel
channels.channel.settings

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - channels - channels.channel - channels.channel.settings

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"c334e7bc-89fe-45c9-bc46-fdd519a7e2a1","type":"any","value":"","key":"jobReasonID"}]}},"response":[],"_postman_id":"0cbe8af5-a3a6-4bd8-a9f4-76c9e60d84ba"},{"name":"Job reasons update","id":"9942aef7-0d2d-4d26-ab79-92696d175aa6","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"reason\",\n \"order_number\": 1,\n \"is_active\": false,\n \"image_status\": \"1\",\n \"reason_types\": [\n \"1\"\n ],\n \"channels\": [\n 0\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//job-reasons/:jobReasonID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`jobReasonID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`reason`	string	yes	—
`order_number`	integer \| null	no	—
`is_active`	boolean \| null	no	—
`image_status`	string \| null	no	Allowed: `1`, `2`, `3`
`reason_types`	array \| null	no	—
`channels`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`jobReasonID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`jobReasonID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`job_reason_id`	integer	yes	—
`is_active`	boolean	yes	—

Job Reasons — 9 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"e0f53e95-49eb-41f1-9b9a-3df2e108de31","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Languages","item":[{"name":"Display a listing of every language","id":"ca40bb9f-6330-4117-be8f-52c20f07380a","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//languages","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"ca40bb9f-6330-4117-be8f-52c20f07380a"},{"name":"Display the specified language","id":"d0b441cf-25ee-414f-8c9a-23fe68735386","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//languages/:languageID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`languageID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Languages — 2 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"cb85e8f1-2c6d-4384-b611-485684dc40c2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Mail Account Settings","item":[{"name":"Mail account settings test","id":"b82c030e-0048-4c09-a224-e0da3f435026","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mail_provider\": \"helm\",\n \"name\": \"name\",\n \"test_sender\": \"user@example.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//mail-account-settings/test","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`mail_provider`	string	yes	Allowed: `helm`, `mailgun`, `amazon_ses`, `brevo`
`name`	string	yes	—
`test_sender`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`statuses`	Filter by Statuses.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

mailAccountSettings

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Statuses.

\n","type":"text/plain"},"key":"statuses","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - mailAccountSettings

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"32d17ef6-0f2b-4a74-8d28-aff4871e27a2"},{"name":"Mail account settings create","id":"01ef1b96-8dc8-4349-923c-7fda3723d8bc","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"mail_provider\": \"helm\",\n \"name\": \"name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//mail-account-settings","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`mail_provider`	string	yes	Allowed: `helm`, `mailgun`, `amazon_ses`, `brevo`
`name`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`mailAccountSettingID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`mailAccountSettingID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`mail_provider`	string	yes	Allowed: `helm`, `mailgun`, `amazon_ses`, `brevo`
`name`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`mailAccountSettingID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`mail_account_setting_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`mailAccountSettingID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`mail_account_setting_id`	integer	yes	—

Mail Account Settings — 7 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"c8a1bf4d-efec-4d06-b6c4-61113ea9f4bf","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Manufacturers","item":[{"name":"Manufacturers list","id":"d536a920-b793-4a3d-a8d6-54a1e59dc377","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//manufacturers","description":"

Lists the company's manufacturers: the factories products are made by, with their US Customs MID and registered address.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`query`	Search manufacturer name and MID.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.
`includes_count`	`inventory` adds `inventory_count`, the number of linked products.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

address (with its country)
inventory (linked products)
inventory.meta (adds product names)

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc. Sortable fields: id, name, mid_id, created_at.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Search manufacturer name and MID.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Comma-separated relation counts. Allowed: inventory (number of linked products, returned as inventory_count).

\n","type":"text/plain"},"key":"includes_count","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by: id, name, mid_id, created_at.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load. Allowed relations: - address - inventory - inventory.meta

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"d536a920-b793-4a3d-a8d6-54a1e59dc377"},{"name":"Manufacturers create","id":"1cf7a81b-abe0-49cf-86a5-f06760622e8c","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Acme Manufacturing Ltd\",\n \"mid_id\": \"GBACMMAN4LEE\",\n \"address\": {\n \"address_line_1\": \"Unit 4\",\n \"address_line_2\": \"Mill Lane\",\n \"address_line_3\": null,\n \"city\": \"Leeds\",\n \"county\": \"West Yorkshire\",\n \"postcode\": \"LS1 1AA\",\n \"country_id\": 232\n },\n \"company_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//manufacturers","description":"

Creates a manufacturer. name is required and unique within the company. mid_id is the US Customs Manufacturer Identification code (up to 15 letters and digits); spaces are removed and it is stored in upper case. Link it to a product with manufacturer_id on the product's customs information; the MID and address are then sent to the carrier with every item of that product.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`address`	object	no	—
`address.address_line_1`	string	yes	Conditional: - Required when `address` is present.
`address.address_line_2`	string \| null	no	—
`address.address_line_3`	string \| null	no	—
`address.city`	string	yes	Conditional: - Required when `address` is present.
`address.county`	string \| null	no	—
`address.postcode`	string \| null	no	—
`address.country_id`	integer	yes	Helm country ID (from the countries list), not the ISO code. Conditional: - Required when `address` is present.
`mid_id`	string \| null	no	US Customs Manufacturer Identification code. Spaces are removed and letters are stored in upper case; the result must be 1 to 15 letters and digits.

Shows one manufacturer with its country. Another company's id returns 404.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`manufacturerID`	integer	yes

Replaces a manufacturer (name required). The change shows on the next label of every linked product. Responds 204 No Content.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`manufacturerID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`manufacturer_id`	integer	yes	—
`name`	string	yes	—
`address`	object	no	—
`address.address_line_1`	string	yes	Conditional: - Required when `address` is present.
`address.address_line_2`	string \| null	no	—
`address.address_line_3`	string \| null	no	—
`address.city`	string	yes	Conditional: - Required when `address` is present.
`address.county`	string \| null	no	—
`address.postcode`	string \| null	no	—
`address.country_id`	integer	yes	Helm country ID (from the countries list), not the ISO code. Conditional: - Required when `address` is present.
`mid_id`	string \| null	no	US Customs Manufacturer Identification code. Spaces are removed and letters are stored in upper case; the result must be 1 to 15 letters and digits.

Updates only the fields sent: absent fields are left as they are and a null clears the field. Responds 204 No Content.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`manufacturerID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`manufacturer_id`	integer	yes	—
`name`	string	yes	—
`address`	object	no	—
`address.address_line_1`	string	yes	Conditional: - Required when `address` is present.
`address.address_line_2`	string \| null	no	—
`address.address_line_3`	string \| null	no	—
`address.city`	string	yes	Conditional: - Required when `address` is present.
`address.county`	string \| null	no	—
`address.postcode`	string \| null	no	—
`address.country_id`	integer	yes	Helm country ID (from the countries list), not the ISO code. Conditional: - Required when `address` is present.
`mid_id`	string \| null	no	US Customs Manufacturer Identification code. Spaces are removed and letters are stored in upper case; the result must be 1 to 15 letters and digits.

Deletes a manufacturer. A manufacturer still linked to a product cannot be deleted (422); remove it from the products first. Responds 204 No Content.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`manufacturerID`	integer	yes

Manufacturers — 6 endpoints.

The factory a product is made by: its US Customs MID (mid_id) and registered address. A product is linked through manufacturer_id on its customs information (PATCH /inventory/{inventoryID}/customs-information, inventory create and update). When a label is requested, every item of a linked product carries mid_id and manufacturer_address.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"0ae053b4-c7b1-424b-94c2-f5cf8eeda17b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Movements","item":[{"name":"Movements types","id":"7945bf73-e903-4f7c-b4ed-d8c5f4d43f0b","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//movements/types","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`movement_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`movement_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`movement_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`movement_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`archived`	Filter by Archived.
`movement_number`	Filter by Movement Number.
`movement_type`	Filter by Movement Type.
`status`	Filter by Status.
`item_count_from`	Filter by Item Count From.
`item_count_to`	Filter by Item Count To.
`assigned_user_id`	Filter by Assigned User Id.
`created_at_from`	Filter by Created At From.
`created_at_to`	Filter by Created At To.
`assigned_user_date_from`	Filter by Assigned User Date From.
`assigned_user_date_to`	Filter by Assigned User Date To.
`completed_at_from`	Filter by Completed At From.
`completed_at_to`	Filter by Completed At To.
`is_mobile`	Filter by Is Mobile.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

items
items.inventory
items.inventory.meta
items.inventory.stocks
items.inventory.stocks.location
items.fromLocation
delivery
delivery.supplier
delivery.supplier.contact
assignedUser
assignedUser.user
assignedUser.user.fileManager
assignedUser.timeTracking
assignedUsers
assignedUsers.user
assignedUsers.user.fileManager
assignedUsers.timeTracking
tags
tags.tag
archivedBy.user
archivedBy.user.fileManager

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Archived.

\n","type":"text/plain"},"key":"archived","value":""},{"disabled":true,"description":{"content":"

Filter by Movement Number.

\n","type":"text/plain"},"key":"movement_number","value":""},{"disabled":true,"description":{"content":"

Filter by Movement Type.

\n","type":"text/plain"},"key":"movement_type","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Item Count From.

\n","type":"text/plain"},"key":"item_count_from","value":""},{"disabled":true,"description":{"content":"

Filter by Item Count To.

\n","type":"text/plain"},"key":"item_count_to","value":""},{"disabled":true,"description":{"content":"

Filter by Assigned User Id.

\n","type":"text/plain"},"key":"assigned_user_id","value":""},{"disabled":true,"description":{"content":"

Filter by Created At From.

\n","type":"text/plain"},"key":"created_at_from","value":""},{"disabled":true,"description":{"content":"

Filter by Created At To.

\n","type":"text/plain"},"key":"created_at_to","value":""},{"disabled":true,"description":{"content":"

Filter by Assigned User Date From.

\n","type":"text/plain"},"key":"assigned_user_date_from","value":""},{"disabled":true,"description":{"content":"

Filter by Assigned User Date To.

\n","type":"text/plain"},"key":"assigned_user_date_to","value":""},{"disabled":true,"description":{"content":"

Filter by Completed At From.

\n","type":"text/plain"},"key":"completed_at_from","value":""},{"disabled":true,"description":{"content":"

Filter by Completed At To.

\n","type":"text/plain"},"key":"completed_at_to","value":""},{"disabled":true,"description":{"content":"

Filter by Is Mobile.

\n","type":"text/plain"},"key":"is_mobile","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - items - items.inventory - items.inventory.meta - items.inventory.stocks - items.inventory.stocks.location - items.fromLocation - delivery - delivery.supplier - delivery.supplier.contact - assignedUser - assignedUser.user - assignedUser.user.fileManager - assignedUser.timeTracking - assignedUsers - assignedUsers.user - assignedUsers.user.fileManager - assignedUsers.timeTracking - tags - tags.tag - archivedBy.user - archivedBy.user.fileManager

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"01207d2a-a3b3-4134-8d3e-af848509d445"},{"name":"Movements create","id":"bca5df95-6b0f-4e88-8381-bac31f4e1d8a","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": 1,\n \"is_bulk\": false,\n \"replenish_type\": 1,\n \"deliveries\": [],\n \"inventory_list\": [\n {\n \"inventory_id\": \"{{inventory_id}}\",\n \"from_location_id\": \"{{from_location_id}}\",\n \"to_location_id\": \"{{to_location_id}}\",\n \"quantity\": 1,\n \"inventory_batch_id\": null\n }\n ],\n \"split\": {\n \"per_zone\": false,\n \"set_maximum_lines\": false,\n \"maximum_lines\": 1,\n \"assigned_users\": null\n },\n \"filters\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//movements","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required
`type`	integer	yes
`is_bulk`	boolean	when `type` is `1`
`replenish_type`	integer	when `type` is `2`
`deliveries`	array of integer	when `type` is `4`
`inventory_list`	array of object	when `type` is `1` and `is_bulk` is `false`
`split`	object	every `type` except `4`
`filters`	array of array	when `type` is `2` and `replenish_type` is `2`

Field notes

type — 1 Instant, 2 Replenish, 3 Consolidate, 4 Delivery.
is_bulk — Instant only. false: the lines are listed in inventory_list. true: the lines are derived from filters.
replenish_type — Replenish only. 1 Full replenish, 2 Filter location and inventory (then filters is required).
deliveries — Flat array of delivery ids. A delivery must not be DUE_IN or archived, must have at least one item with a location, and must not already have an open movement.
inventory_list — One object per movement line: inventory_id, from_location_id, to_location_id, quantity, plus inventory_batch_id when the inventory is batch tracked.
inventory_list — from_location_id and to_location_id must differ, and the same inventory + from + to combination cannot repeat.
split — per_zone and set_maximum_lines are mandatory keys. maximum_lines is required when set_maximum_lines is true. assigned_users is optional.
filters — Rule engine groups of {field, operator, value}, e.g. [[{\"field\": 73, \"operator\": 1, \"value\": [12]}]] where field 73 is warehouse zone.
Creating a movement is asynchronous: the response is 201 with a movement TRANSACTION. Poll the movement-transactions endpoints to follow progress.
Fields that do not apply to the chosen type are ignored, so the example body runs as-is for an Instant non-bulk movement.
Every nested id is scoped to the path segment.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

items
items.inventory
items.inventory.meta
items.inventory.stocks
items.inventory.stocks.location
items.fromLocation
delivery
delivery.supplier
delivery.supplier.contact
assignedUser
assignedUser.user
assignedUser.user.fileManager
assignedUser.timeTracking
assignedUsers
assignedUsers.user
assignedUsers.user.fileManager
assignedUsers.timeTracking
tags
tags.tag
archivedBy.user
archivedBy.user.fileManager

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - items - items.inventory - items.inventory.meta - items.inventory.stocks - items.inventory.stocks.location - items.fromLocation - delivery - delivery.supplier - delivery.supplier.contact - assignedUser - assignedUser.user - assignedUser.user.fileManager - assignedUser.timeTracking - assignedUsers - assignedUsers.user - assignedUsers.user.fileManager - assignedUsers.timeTracking - tags - tags.tag - archivedBy.user - archivedBy.user.fileManager

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"f1db13d6-696b-4a1f-8d03-c2b051e442ab","type":"any","value":"","key":"movementID"}]}},"response":[],"_postman_id":"b0568bb0-6dcd-4a47-8706-eac2ba3251aa"},{"name":"Movements delete","id":"b950265c-bfdc-4b90-a907-54478eee49d4","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//movements/:movementID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`movement_id`	integer	yes	—
`is_hold`	boolean \| null	no	—
`assigned_device_name`	string \| null	no	—
`assigned_device_id`	string \| null	no	—
`notes`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`movement_id`	integer	yes	—
`assigned_user`	integer	yes	—
`filter`	array	no	—
`ids`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filter[]`	—
`sort`	—
`includes_count`	—
`movement_id`	Filter by Movement Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

timeTracking
user
user.fileManager

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Movement Id.

\n","type":"text/plain"},"key":"movement_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - timeTracking - user - user.fileManager

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"0f2258c1-7c27-4662-ad93-eccf23366dfe","type":"any","value":"","key":"movementID"}]}},"response":[],"_postman_id":"58c4fc70-070f-4e9a-8e2f-368edfa1098d"},{"name":"Movements assigned users update","id":"92c477de-7f9b-4577-8401-3dc3a528e25c","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"movement_id\": \"{{movement_id}}\",\n \"user_id\": \"{{user_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//movements/:movementID/assigned-users","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`movement_id`	integer	yes	—
`user_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`movementID`	integer	yes
`userID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

timeTracking
user
user.fileManager

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - timeTracking - user - user.fileManager

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"1b002114-be70-47f5-bfb1-f4b6b8127308","type":"any","value":"","key":"movementID"},{"id":"8e0e68af-fe13-4dd8-bd50-b4f6fe361394","type":"any","value":"","key":"userID"}]}},"response":[],"_postman_id":"34f26446-09ea-486f-b2bf-21aee473d1e8"},{"name":"Movements time tracking start","id":"20b0d7ba-5068-4c80-8c7f-f6acf5a8dd1d","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"movement_id\": \"{{movement_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//movements/:movementID/time-tracking/start","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`movement_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`movement_id`	integer	yes	—
`stopped_at`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`movement_item_ids[]`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`company_id`	string	yes
`movement_id`	string	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filter[]`	—
`sort`	—
`includes_count`	—
`movement_id`	Filter by Movement Id.
`product_name`	Filter by Product Name.
`product_code`	Filter by Product Code.
`from_zone_id`	Filter by From Zone Id.
`from_location_id`	Filter by From Location Id.
`to_zone_id`	Filter by To Zone Id.
`to_location_id`	Filter by To Location Id.
`moved_qty_from`	Filter by Moved Qty From.
`moved_qty_to`	Filter by Moved Qty To.
`status`	Filter by Status.
`query`	Filter by Query.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

inventory
inventory.meta
inventory.barcodes
inventory.stocks
inventory.stocks.location
fromLocation
fromZone
toLocation
toZone
movement
deliveryItem
batch

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Movement Id.

\n","type":"text/plain"},"key":"movement_id","value":""},{"disabled":true,"description":{"content":"

Filter by Product Name.

\n","type":"text/plain"},"key":"product_name","value":""},{"disabled":true,"description":{"content":"

Filter by Product Code.

\n","type":"text/plain"},"key":"product_code","value":""},{"disabled":true,"description":{"content":"

Filter by From Zone Id.

\n","type":"text/plain"},"key":"from_zone_id","value":""},{"disabled":true,"description":{"content":"

Filter by From Location Id.

\n","type":"text/plain"},"key":"from_location_id","value":""},{"disabled":true,"description":{"content":"

Filter by To Zone Id.

\n","type":"text/plain"},"key":"to_zone_id","value":""},{"disabled":true,"description":{"content":"

Filter by To Location Id.

\n","type":"text/plain"},"key":"to_location_id","value":""},{"disabled":true,"description":{"content":"

Filter by Moved Qty From.

\n","type":"text/plain"},"key":"moved_qty_from","value":""},{"disabled":true,"description":{"content":"

Filter by Moved Qty To.

\n","type":"text/plain"},"key":"moved_qty_to","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"75bed209-0065-4642-9314-dbfefe4baa38","type":"any","value":"","key":"movement_id"}]}},"response":[],"_postman_id":"53014774-a468-4841-a1d2-b143801e2c8f"},{"name":"Movements items create","id":"ef487b40-5590-4bf4-88f0-3be3eaba531e","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"movement_type\": 1,\n \"movement_id\": \"{{movement_id}}\",\n \"delivery_id\": \"{{delivery_id}}\",\n \"items\": [\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//movements/:movementID/items","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`movement_type`	integer	yes	MovementTypes values: - `1` = INSTANT - `2` = REPLENISH - `3` = CONSOLIDATE - `4` = DELIVERY Allowed: `1`, `2`, `3`, `4`
`movement_id`	integer	no	—
`delivery_id`	integer \| null	no	—
`items`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`movementID`	integer	yes
`itemID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`movementID`	integer	yes
`itemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`to_location_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`movementID`	integer	yes
`itemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`action_quantity`	number	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`movementID`	integer	yes
`itemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`quantity`	number	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filter[]`	—
`ids[]`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`movementID`	integer	yes
`deliveryItemID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`movementID`	integer	yes
`itemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`movement_id`	integer	yes	—
`item_id`	integer	yes	—
`to_location_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`movementID`	integer	yes
`itemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`movement_id`	integer	yes	—
`item_id`	integer	yes	—
`quantity`	number	yes	—
`location_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`movementID`	integer	yes
`itemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`movement_id`	integer	yes	—
`item_id`	integer	yes	—
`quantity`	number	yes	—
`location_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`id`	integer \| null	no	—
`inventory_id`	integer	yes	—
`from_location_id`	integer	yes	—
`inventory_batch_id`	integer \| null	no	—
`quantity`	integer	yes	—
`assigned_device_name`	string \| null	no	—
`assigned_device_id`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`movement_item_id`	integer	yes	—
`inventory_id`	integer	yes	—
`from_location_id`	integer	yes	—
`to_location_id`	integer	yes	—
`inventory_batch_id`	integer \| null	no	—
`quantity`	integer	yes	—
`assigned_device_name`	string \| null	no	—
`assigned_device_id`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filter[]`	—
`search`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`movement_ids[]`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filter[]`	—
`sort`	—
`includes_count`	—
`movement_id`	Filter by Movement Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

company
movement
tag

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Movement Id.

\n","type":"text/plain"},"key":"movement_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - company - movement - tag

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"c044d103-6e50-4b4f-8d83-b211202d0115","type":"any","value":"","key":"movementID"}]}},"response":[],"_postman_id":"029e8fec-1a0e-4def-beb6-0af123f5bd3b"},{"name":"Movements tags create","id":"d11ed16d-e25b-451c-af04-176e9adeb07a","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"movement_id\": \"{{movement_id}}\",\n \"name\": \"name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//movements/:movementID/tags","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`movement_id`	integer	yes	—
`name`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`movementID`	integer	yes
`tagID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`movement_id`	integer	yes	—
`tag_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`movementID`	integer	yes
`tagID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`movement_id`	integer	yes	—
`tag_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementTransactionID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementTransactionID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filter[]`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`movementTransactionID`	integer	yes

Movements — 46 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"203e92d9-02cf-484b-aae3-4f450fcec89e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Notifications","item":[{"name":"Notifications list","id":"2ccced49-faaf-4819-bbed-c2f1af99df69","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//notifications","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`statuses`	Filter by Statuses.
`triggers`	Filter by Triggers.
`stores`	Filter by Stores.
`channels`	Filter by Channels.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

emailTemplate
meta
meta.mailAccount
conditionGroups
otherRecipients

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Statuses.

\n","type":"text/plain"},"key":"statuses","value":""},{"disabled":true,"description":{"content":"

Filter by Triggers.

\n","type":"text/plain"},"key":"triggers","value":""},{"disabled":true,"description":{"content":"

Filter by Stores.

\n","type":"text/plain"},"key":"stores","value":""},{"disabled":true,"description":{"content":"

Filter by Channels.

\n","type":"text/plain"},"key":"channels","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - emailTemplate - meta - meta.mailAccount - conditionGroups - otherRecipients

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"2ccced49-faaf-4819-bbed-c2f1af99df69"},{"name":"Notifications create","id":"99a12704-6d61-4976-b95b-ea44aefc14f2","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"email_template_id\": \"{{email_template_id}}\",\n \"name\": \"name\",\n \"delay_time\": 0,\n \"subject\": \"subject\",\n \"mail_account_id\": \"{{mail_account_id}}\",\n \"sender_name\": \"\",\n \"sender_email\": \"user@example.com\",\n \"recipient_type\": \"1\",\n \"other_recipient_email\": [\n \"user@example.com\"\n ],\n \"store_and_channels\": [\n 0\n ],\n \"shipping_countries\": [\n 0\n ],\n \"order_statuses\": [\n 1\n ],\n \"tracking_statuses\": [\n 1\n ],\n \"conditions\": [\n [\n {\n \"field\": 6,\n \"operator\": 0,\n \"value\": [\n \"\"\n ]\n }\n ]\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//notifications","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`email_template_id`	integer	yes	—
`name`	string	yes	—
`delay_time`	integer \| null	no	—
`subject`	string	yes	—
`mail_account_id`	integer	yes	—
`sender_name`	string	no	—
`sender_email`	string \| null	no	—
`recipient_type`	string	yes	Allowed: `1`, `2`, `3`
`other_recipient_email`	array	no	—
`store_and_channels`	array	yes	—
`shipping_countries`	array	yes	—
`order_statuses`	array	yes	—
`tracking_statuses`	array \| null	no	—
`conditions`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

notification
notification.meta
order

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - notification - notification.meta - order

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"eee26aba-0fcb-40ad-b943-0c20e86d80e1"},{"name":"Notifications histories preview","id":"42f1f14f-1ac1-4fbe-9743-df40798c8c1b","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//notifications/histories/:notificationHistoryID/preview","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`notificationHistoryID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`notificationID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

emailTemplate
meta
meta.mailAccount
conditionGroups
otherRecipients

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - emailTemplate - meta - meta.mailAccount - conditionGroups - otherRecipients

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"93011840-66d6-4e1c-9548-68c54b1660bf","type":"any","value":"","key":"notificationID"}]}},"response":[],"_postman_id":"f2acd31a-a7a2-4539-85fd-b43aefe11fe0"},{"name":"Notifications update","id":"193a8a5a-b610-41a9-9f8a-cb8f75d88f7e","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"notification_id\": \"{{notification_id}}\",\n \"email_template_id\": \"{{email_template_id}}\",\n \"name\": \"name\",\n \"delay_time\": 0,\n \"subject\": \"subject\",\n \"mail_account_id\": \"{{mail_account_id}}\",\n \"sender_name\": \"\",\n \"sender_email\": \"user@example.com\",\n \"recipient_type\": \"1\",\n \"other_recipient_email\": [\n \"\"\n ],\n \"store_and_channels\": [\n 0\n ],\n \"shipping_countries\": [\n 0\n ],\n \"order_statuses\": [\n 1\n ],\n \"tracking_statuses\": [\n 1\n ],\n \"conditions\": [\n [\n {\n \"field\": 6,\n \"operator\": 0,\n \"value\": [\n \"\"\n ]\n }\n ]\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//notifications/:notificationID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`notificationID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`notification_id`	integer	yes	—
`email_template_id`	integer	yes	—
`name`	string	yes	—
`delay_time`	integer \| null	no	—
`subject`	string	yes	—
`mail_account_id`	integer	yes	—
`sender_name`	string	no	—
`sender_email`	string \| null	no	—
`recipient_type`	string	yes	Allowed: `1`, `2`, `3`
`other_recipient_email`	array	no	—
`store_and_channels`	array	yes	—
`shipping_countries`	array	yes	—
`order_statuses`	array	yes	—
`tracking_statuses`	array \| null	no	—
`conditions`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`notificationID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`notification_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`notificationID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`notification_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`notificationID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`notification_id`	integer	yes	—
`emails`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`archive`	Filter by Archive.
`statuses`	Filter by Statuses.
`mail_accounts`	Filter by Mail Accounts.
`date_from`	Filter by Date From.
`date_to`	Filter by Date To.
`time_to_archive_from`	Filter by Time To Archive From.
`time_to_archive_to`	Filter by Time To Archive To.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

notification
notification.meta
order

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Archive.

\n","type":"text/plain"},"key":"archive","value":""},{"disabled":true,"description":{"content":"

Filter by Statuses.

\n","type":"text/plain"},"key":"statuses","value":""},{"disabled":true,"description":{"content":"

Filter by Mail Accounts.

\n","type":"text/plain"},"key":"mail_accounts","value":""},{"disabled":true,"description":{"content":"

Filter by Date From.

\n","type":"text/plain"},"key":"date_from","value":""},{"disabled":true,"description":{"content":"

Filter by Date To.

\n","type":"text/plain"},"key":"date_to","value":""},{"disabled":true,"description":{"content":"

Filter by Time To Archive From.

\n","type":"text/plain"},"key":"time_to_archive_from","value":""},{"disabled":true,"description":{"content":"

Filter by Time To Archive To.

\n","type":"text/plain"},"key":"time_to_archive_to","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - notification - notification.meta - order

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"bb473a67-c403-4e3a-b746-2c707e780141"},{"name":"Notifications histories resend notification","id":"2657a50c-2e54-405d-a67e-220006105f93","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//notifications/histories/:notificationHistoryID/resend-notification?company_id=¬ification_history_id=","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`notificationHistoryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`notification_history_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`conditions`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`savedConditionID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`saved_condition_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`savedConditionID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`saved_condition_id`	integer	yes	—

Notifications — 15 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"2fd3c013-002b-441a-8ed8-6ec57d0f5437","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Order Rules","item":[{"name":"Order rules list","id":"ca4ce402-8e1a-48ae-a842-8a1b0c426f7f","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//order-rules","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`status`	Filter by Status.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

conditionGroups
actions

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - conditionGroups - actions

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"ca4ce402-8e1a-48ae-a842-8a1b0c426f7f"},{"name":"Order rules create","id":"051e1993-99eb-4405-8a79-6320f42df3bc","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"name\": \"name\",\n \"limit_run_count\": 0,\n \"trigger_events\": [\n \"1\"\n ],\n \"conditions\": [\n [\n {\n \"field\": 1,\n \"operator\": 0,\n \"value\": [\n \"\"\n ]\n }\n ]\n ],\n \"actions\": [\n {\n \"action\": 1,\n \"value\": [\n \"\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//order-rules","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`limit_run_count`	integer \| null	no	—
`trigger_events`	array	yes	—
`conditions`	array \| null	no	—
`actions`	array	yes	—
`actions.*.action`	integer	yes	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`
`actions.*.value`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderRuleID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

conditionGroups
actions

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - conditionGroups - actions

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"1b2b71f0-cc1c-4a8a-9219-7917fbd2606c","type":"any","value":"","key":"orderRuleID"}]}},"response":[],"_postman_id":"91ccff3d-94a9-455b-b470-051e73d7d767"},{"name":"Order rules update","id":"c4389cd8-ef43-4d0a-b6c9-fab9ec38eef2","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"name\": \"name\",\n \"limit_run_count\": 0,\n \"trigger_events\": [\n \"1\"\n ],\n \"conditions\": [\n [\n {\n \"field\": 1,\n \"operator\": 0,\n \"value\": [\n \"\"\n ]\n }\n ]\n ],\n \"actions\": [\n {\n \"action\": 1,\n \"value\": [\n \"\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//order-rules/:orderRuleID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderRuleID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`limit_run_count`	integer \| null	no	—
`trigger_events`	array	yes	—
`conditions`	array \| null	no	—
`actions`	array	yes	—
`actions.*.action`	integer	yes	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`
`actions.*.value`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderRuleID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderRuleID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`sorting`	array	yes	—
`sorting.*.id`	integer	yes	—
`sorting.*.order`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	no	—
`limit_run_count`	integer \| null	no	—
`trigger_events`	array	yes	—
`conditions`	array \| null	no	—
`actions`	array	yes	—
`actions.*.action`	integer	yes	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`
`actions.*.value`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderRuleID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`conditions`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`savedConditionID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`saved_condition_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`savedConditionID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`saved_condition_id`	integer	yes	—

Order Rules — 13 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"41618737-25b4-46dc-be24-eb7857494717","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Orders","item":[{"name":"Orders statuses","id":"0812c63e-8bfd-4f9d-bc3d-ace77e0aded3","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//orders/statuses","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Honors the same filter[ids] whitelist as index(): when present, the count\nis scoped to those order ids (OrderService::ordersCount reads $attributes['ids']).\nWithout it, the count is the full company total.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`filter[ids][]`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"key":"sort_direction","value":""},{"disabled":true,"key":"includes_count","value":""},{"disabled":true,"key":"page","value":""},{"disabled":true,"key":"per_page","value":""},{"disabled":true,"key":"filter[ids][]","value":""}],"variable":[]}},"response":[],"_postman_id":"f611c7db-acba-46ed-b7ed-74e29ff84ce8"},{"name":"Orders bulk create","id":"5f422126-9b26-4d70-a5bf-503b4dd58992","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"orders\": [\n {\n \"status\": \"1\",\n \"channel_id\": \"{{channel_id}}\",\n \"is_hold\": false,\n \"reference\": \"reference\",\n \"reference_alt\": \"reference_alt\",\n \"payment_method\": \"\",\n \"payment_reference\": \"\",\n \"shipping_method\": \"\",\n \"currency_id\": \"{{currency_id}}\",\n \"totals\": {\n \"total_shipping\": 0\n },\n \"courier\": {\n \"courier_service_id\": \"{{courier_service_id}}\",\n \"is_locked\": false,\n \"label_reference\": \"1\",\n \"label_secondary_reference\": \"1\"\n },\n \"items\": [\n {\n \"name\": \"\",\n \"inventory_id\": \"{{inventory_id}}\",\n \"meta\": {\n \"hs_code\": 0,\n \"country_id\": \"{{country_id}}\"\n },\n \"quantity\": 1,\n \"options\": \"\",\n \"unit_price\": 0,\n \"unit_discount\": 0\n }\n ],\n \"customer\": {\n \"id\": null,\n \"name\": \"name\",\n \"surname\": \"surname\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"is_company\": false,\n \"company_name\": \"\"\n },\n \"shipping_address\": {\n \"id\": null,\n \"name\": \"\",\n \"surname\": \"\",\n \"company_name\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country_id\": \"{{country_id}}\",\n \"postcode\": \"\",\n \"vat_number\": \"\",\n \"eori\": \"\"\n },\n \"is_invoice_same_as_shipping\": false,\n \"notes\": {\n \"delivery_note\": \"\",\n \"gift_note\": \"\",\n \"customer_note\": \"\"\n },\n \"folder_id\": \"{{folder_id}}\",\n \"tags\": [\n \"tag\"\n ],\n \"invoice_address\": {\n \"id\": null,\n \"name\": \"\",\n \"surname\": \"\",\n \"company_name\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country_id\": \"{{country_id}}\",\n \"postcode\": \"\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//orders/bulk-create","description":"

Batch size: a maximum of 10 orders per request. A request carrying more is rejected with 422 Unprocessable Entity and a validation error on orders; no orders are created. Split larger batches across several requests, or send them to POST /companies/{companyID}/orders/bulk-create-async, which takes the same payload, answers immediately and reports the result of every order.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`orders`	array	yes	—
`orders.*.status`	string	yes	Allowed: `1`, `2`
`orders.*.channel_id`	integer	yes	—
`orders.*.is_hold`	boolean \| null	no	—
`orders.*.reference`	string \| null	no	—
`orders.*.reference_alt`	string \| null	no	—
`orders.*.payment_method`	string \| null	no	—
`orders.*.payment_reference`	string \| null	no	—
`orders.*.shipping_method`	string \| null	no	—
`orders.*.currency_id`	integer \| null	no	—
`orders.*.totals`	object	yes	—
`orders.*.totals.total_shipping`	number	yes	—
`orders.*.courier`	object \| null	no	—
`orders.*.courier.courier_service_id`	integer \| null	no	—
`orders.*.courier.is_locked`	boolean	no	—
`orders.*.courier.label_reference`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`
`orders.*.courier.label_secondary_reference`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`
`orders.*.items`	array \| null	no	—
`orders..items..name`	string \| null	no	—
`orders..items..inventory_id`	integer	yes	—
`orders..items..meta`	object \| null	no	—
`orders..items..meta.hs_code`	number \| null	no	—
`orders..items..meta.country_id`	integer \| null	no	—
`orders..items..quantity`	integer	yes	—
`orders..items..options`	string \| null	no	—
`orders..items..unit_price`	number	yes	—
`orders..items..unit_discount`	number \| null	no	—
`orders.*.customer`	object \| null	no	—
`orders.*.customer.id`	integer \| null	no	—
`orders.*.customer.name`	string	yes	—
`orders.*.customer.surname`	string	yes	—
`orders.*.customer.email`	string	yes	—
`orders.*.customer.phone`	string \| null	no	—
`orders.*.customer.is_company`	boolean	yes	—
`orders.*.customer.company_name`	string	no	—
`orders.*.shipping_address`	object \| null	no	—
`orders.*.shipping_address.id`	integer \| null	no	—
`orders.*.shipping_address.name`	string	no	—
`orders.*.shipping_address.surname`	string	no	—
`orders.*.shipping_address.company_name`	string \| null	no	—
`orders.*.shipping_address.phone`	string \| null	no	—
`orders.*.shipping_address.email`	string	no	—
`orders.*.shipping_address.address_line_1`	string	no	—
`orders.*.shipping_address.address_line_2`	string \| null	no	—
`orders.*.shipping_address.city`	string	no	—
`orders.*.shipping_address.county`	string \| null	no	—
`orders.*.shipping_address.country_id`	integer	no	—
`orders.*.shipping_address.country_iso_code`	string	no	—
`orders.*.shipping_address.postcode`	string \| null	no	—
`orders.*.shipping_address.vat_number`	string \| null	no	—
`orders.*.shipping_address.eori`	string \| null	no	—
`orders.*.is_invoice_same_as_shipping`	boolean	no	—
`orders.*.notes`	object \| null	no	—
`orders.*.notes.delivery_note`	string \| null	no	—
`orders.*.notes.gift_note`	string \| null	no	—
`orders.*.notes.customer_note`	string \| null	no	—
`orders.*.folder_id`	integer \| null	no	—
`orders.*.tags`	array \| null	no	—
`orders.*.invoice_address`	object \| null	no	—
`orders.*.invoice_address.id`	integer \| null	no	—
`orders.*.invoice_address.name`	string	no	—
`orders.*.invoice_address.surname`	string	no	—
`orders.*.invoice_address.company_name`	string \| null	no	—
`orders.*.invoice_address.phone`	string \| null	no	—
`orders.*.invoice_address.email`	string	no	—
`orders.*.invoice_address.address_line_1`	string	no	—
`orders.*.invoice_address.address_line_2`	string \| null	no	—
`orders.*.invoice_address.address_line_3`	string \| null	no	—
`orders.*.invoice_address.city`	string	no	—
`orders.*.invoice_address.county`	string \| null	no	—
`orders.*.invoice_address.country_id`	integer	no	—
`orders.*.invoice_address.country_iso_code`	string	no	—
`orders.*.invoice_address.postcode`	string \| null	no	—

Move selected picked quantities of a PARTIALLY_PICKED order into a new PICKED order.

For a normal line: quantity = picked units to move (<= line's picked qty).\nFor a group/bundle line: pass the group parent line id and set quantity = number of complete picked sets to move.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}},"urlObject":{"path":["companies","","orders","{{order_id}}","split-picked"],"host":["https://app-api.helmwms.app/api/v2"],"query":[],"variable":[]}},"response":[{"id":"dc7e46ba-247a-4c62-8d4b-d9e0654efd27","name":"200 — Split order created","originalRequest":{"method":"POST","header":[{"key":"X-App-Token","value":"{{app_token}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"items\": [\n { \"id\": 1001, \"quantity\": 2 }\n ]\n}"},"url":"https://app-api.helmwms.app/api/v2/companies//orders/{{order_id}}/split-picked"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 5678,\n \"order_number\": \"OR-XXXXXXXX\",\n \"status\": 6,\n \"is_splitted\": true,\n \"split_order_id\": 1234\n }\n}"},{"id":"f76a5112-5fd9-4782-b9b5-64910d9d0551","name":"422 — Quantity exceeds picked","originalRequest":{"method":"POST","header":[{"key":"X-App-Token","value":"{{app_token}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"items\": [\n { \"id\": 1001, \"quantity\": 999 }\n ]\n}"},"url":"https://app-api.helmwms.app/api/v2/companies//orders/{{order_id}}/split-picked"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The item quantity must be less than or equal to 3.\",\n \"errors\": {\n \"items.0.quantity\": [\n \"The item quantity must be less than or equal to 3.\"\n ]\n }\n}"}],"_postman_id":"9089f14d-d683-4841-8d20-0472b205f9f6"},{"name":"Orders bulk update","id":"38ccb432-3b9c-4c17-a62e-a1a234725033","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"orders\": [\n {\n \"order_id\": \"{{order_id}}\",\n \"status\": \"2\",\n \"channel_id\": \"{{channel_id}}\",\n \"is_hold\": false,\n \"reference\": \"reference\",\n \"reference_alt\": \"reference_alt\",\n \"payment_method\": \"\",\n \"payment_reference\": \"\",\n \"shipping_method\": \"\",\n \"currency_id\": \"{{currency_id}}\",\n \"customer\": {\n \"id\": null,\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"is_company\": false,\n \"company_name\": \"\"\n },\n \"shipping_address\": {\n \"id\": null,\n \"name\": \"\",\n \"surname\": \"\",\n \"company_name\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country_id\": \"{{country_id}}\",\n \"postcode\": \"\",\n \"vat_number\": \"\",\n \"eori\": \"\"\n },\n \"is_invoice_same_as_shipping\": false,\n \"totals\": {\n \"total_shipping\": 0,\n \"discount\": 0\n },\n \"courier\": {\n \"courier_service_id\": \"{{courier_service_id}}\",\n \"is_locked\": false,\n \"label_reference\": \"1\",\n \"label_secondary_reference\": \"1\"\n },\n \"items\": [\n {\n \"id\": \"{{id}}\",\n \"name\": \"\",\n \"meta\": {\n \"hs_code\": \"\",\n \"country_id\": \"{{country_id}}\"\n },\n \"quantity\": 1,\n \"options\": \"\",\n \"unit_price\": 0,\n \"unit_discount\": 0\n }\n ],\n \"notes\": {\n \"delivery_note\": \"\",\n \"gift_note\": \"\",\n \"customer_note\": \"\"\n },\n \"folder_id\": \"{{folder_id}}\",\n \"tags\": [\n \"tag\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//orders/bulk-update","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`orders`	array	yes	—
`orders.*.order_id`	integer	yes	—
`orders.*.status`	string \| null	no	Allowed: `2`
`orders.*.channel_id`	integer \| null	no	—
`orders.*.is_hold`	boolean \| null	no	—
`orders.*.reference`	string \| null	no	—
`orders.*.reference_alt`	string \| null	no	—
`orders.*.payment_method`	string \| null	no	—
`orders.*.payment_reference`	string \| null	no	—
`orders.*.shipping_method`	string \| null	no	—
`orders.*.currency_id`	integer \| null	no	—
`orders.*.customer`	object \| null	no	—
`orders.*.customer.id`	integer \| null	no	—
`orders.*.customer.name`	string	no	—
`orders.*.customer.surname`	string	no	—
`orders.*.customer.email`	string	no	—
`orders.*.customer.phone`	string \| null	no	—
`orders.*.customer.is_company`	boolean	no	—
`orders.*.customer.company_name`	string	no	—
`orders.*.shipping_address`	object	no	—
`orders.*.shipping_address.id`	integer \| null	no	—
`orders.*.shipping_address.name`	string	no	—
`orders.*.shipping_address.surname`	string	no	—
`orders.*.shipping_address.company_name`	string \| null	no	—
`orders.*.shipping_address.phone`	string \| null	no	—
`orders.*.shipping_address.email`	string	no	—
`orders.*.shipping_address.address_line_1`	string	no	—
`orders.*.shipping_address.address_line_2`	string \| null	no	—
`orders.*.shipping_address.city`	string	no	—
`orders.*.shipping_address.county`	string \| null	no	—
`orders.*.shipping_address.country_id`	integer	no	—
`orders.*.shipping_address.postcode`	string \| null	no	—
`orders.*.shipping_address.vat_number`	string \| null	no	—
`orders.*.shipping_address.eori`	string \| null	no	—
`orders.*.is_invoice_same_as_shipping`	boolean	no	—
`orders.*.totals`	object \| null	no	—
`orders.*.totals.total_shipping`	number \| null	no	—
`orders.*.totals.discount`	number \| null	no	—
`orders.*.courier`	object \| null	no	—
`orders.*.courier.courier_service_id`	integer \| null	no	—
`orders.*.courier.is_locked`	boolean \| null	no	—
`orders.*.courier.label_reference`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`
`orders.*.courier.label_secondary_reference`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`
`orders.*.items`	array \| null	no	—
`orders..items..id`	integer	yes	—
`orders..items..name`	string \| null	no	—
`orders..items..meta`	object \| null	no	—
`orders..items..meta.hs_code`	string \| null	no	—
`orders..items..meta.country_id`	integer \| null	no	—
`orders..items..quantity`	integer	yes	—
`orders..items..options`	string \| null	no	—
`orders..items..unit_price`	number	yes	—
`orders..items..unit_discount`	number \| null	no	—
`orders.*.notes`	object \| null	no	—
`orders.*.notes.delivery_note`	string \| null	no	—
`orders.*.notes.gift_note`	string \| null	no	—
`orders.*.notes.customer_note`	string \| null	no	—
`orders.*.folder_id`	integer \| null	no	—
`orders.*.tags`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`orders`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`orders`	array	yes	—

Every filter is a flat query-string parameter - there is no filter[...]\nwrapper. They combine with AND, so narrowing on several is the supported\nway to keep a response small instead of paging the whole company.

Id-style filters (id, ids, excepted_ids, store_id, channel_id,\nstatus, folder_id, tag_id, customer_id, order_type,\ninventory_id, courier_service_id, tracking_status) take one value\n(?folder_id=3), a repeated array (?folder_id[]=3&folder_id[]=7) or a\ncomma-separated list (?folder_id=3,7).

The channel identifiers (remote_id = Channel Order ID, remote_alt_id =\nChannel Alt ID, channel_order_id) and the other free-text parameters\n(order_number, code, external_order_id, primary_reference_id) are\nmatched verbatim and are NOT comma-split, since a comma can be part of the\nvalue; use the repeated-array form to match several. customer and\npostcode match as \"starts with\".

Date ranges are <field>_from / <field>_to over created_at,\nupdated_at, order_date, despatched_at, cancelled_at, archived_at\nand despatch_target_date. Each takes YYYY-MM-DD or a full timestamp\n(UTC unless an offset is given) and both ends are inclusive, so a bare\ndate as the upper bound covers the whole day. A date that cannot be parsed\nis rejected with 422 rather than silently ignored. To mirror orders\nincrementally, poll updated_at_from with sort_by=updated_at and take\nthe next watermark from the updated_at of the last row returned.

date_received_*, date_placed_*, date_despatched_* and\ndate_cancelled_* select on the same columns as the created_at_*,\norder_date_*, despatched_at_* and cancelled_at_* ranges. They differ\nonly at the upper bound: for backwards compatibility a bare date on a\ndate_*_to parameter is still compared literally (00:00:00), so use the\nfield-named spelling when you want the whole day. Those four are also the\nonly date parameters not validated, again for backwards compatibility: a\nvalue that cannot be parsed matches nothing instead of returning 422.

For a large order book, narrow with created_at_from/created_at_to\nrather than paging from page 1 - created_at is indexed per company.

Rate limit: 300 requests/minute, per token, for this endpoint. Each endpoint has its own independent budget. Exceeding it returns 429 Too Many Requests with Retry-After and X-RateLimit-* headers.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

Parameter	Description
`includes_count`	—
`filter[ids][]`	—
`id`	One order id, or several as `?id[]=1&id[]=2` or `?id=1,2`. Synonym of `ids`.
`ids`	One order id, or several as `?ids[]=1&ids[]=2` or `?ids=1,2`.
`excepted_ids`	Every order EXCEPT these ids: `?excepted_ids[]=1&excepted_ids[]=2` or `?excepted_ids=1,2`.
`ignore_ids`	Synonym of `excepted_ids`: every order EXCEPT these ids.
`order_number`	Orders whose order number CONTAINS this term, or exactly one of `?order_number[]=A&order_number[]=B`.
`store_id`	Orders belonging to one store, or several as `?store_id[]=1&store_id[]=2` or `?store_id=1,2`.
`channel_id`	Orders belonging to one channel, or several as `?channel_id[]=1&channel_id[]=2` or `?channel_id=1,2`.
`status`	Orders in one status code, or several as `?status[]=1&status[]=5` or `?status=1,5`. The codes are listed by GET orders/statuses.
`folder_id`	Orders filed in one folder, or several as `?folder_id[]=1&folder_id[]=2` or `?folder_id=1,2`.
`tag_id`	Orders carrying one tag, or any of several as `?tag_id[]=1&tag_id[]=2` or `?tag_id=1,2`.
`customer_id`	Orders belonging to one customer, or several as `?customer_id[]=1&customer_id[]=2` or `?customer_id=1,2`.
`customer`	Orders whose customer's name or surname STARTS WITH the given term.
`order_type`	Orders of one type code, or several as `?order_type[]=1&order_type[]=2` or `?order_type=1,2`.
`is_hold`	Orders currently on hold (`?is_hold=1`) or not on hold (`?is_hold=0`).
`is_manual`	Orders keyed in by hand rather than pulled from a channel, returned as `is_manual`.
`is_fulfillable`	Orders whose items can all be allocated from stock, returned as `is_fulfillable`.
`archived`	`?archived=1` returns only archived orders, `?archived=0` only live ones. Omit the parameter to get both.
`remote_id`	Channel Order ID - the order identifier the sales channel itself issued, returned as `remote_id`. Opaque channel-supplied string, so it is matched verbatim (no comma split); use the array form (`?remote_id[]=A&remote_id[]=B`) for several.
`remote_alt_id`	Channel Alt ID - the channel's secondary order identifier, returned as `remote_alt_id`. Opaque channel-supplied string, so it is matched verbatim (no comma split); use the array form for several.
`channel_order_id`	Filter by the per-channel order id HELM assigns, returned as `channel_order_id`. Opaque string, matched verbatim (no comma split).
`external_order_id`	Filter by the caller-supplied `external_order_id` (set on create/update), matched verbatim.
`primary_reference_id`	Filter by the caller-supplied `primary_reference_id` (set on create/update), matched verbatim.
`postcode`	Orders whose shipping postcode starts with the given term, so `?postcode=SW1` matches every SW1x.
`code`	Orders containing an item with this inventory code (SKU), matched exactly. A SKU is free text and may contain a comma, so the value is matched verbatim; use `?code[]=A&code[]=B` for several.
`inventory_id`	Orders containing an item for this inventory id, or any of several as `?inventory_id[]=1&inventory_id[]=2` or `?inventory_id=1,2`.
`courier_service_id`	Orders whose preferred courier service is this one, or any of several as `?courier_service_id=1,2`.
`tracking_status`	Orders with a shipment parcel in this tracking status, or any of several as `?tracking_status=1,2`.
`date_received_from`	Orders created in HELM (imported or keyed in) on or after this date/time - same as `created_at_from`.
`date_received_to`	Orders created in HELM on or before this date/time. A date with no time is compared literally (00:00:00) - use `created_at_to` to cover the whole day.
`date_placed_from`	Orders placed by the customer on or after this date/time - same as `order_date_from`.
`date_placed_to`	Orders placed by the customer on or before this date/time. A date with no time is compared literally (00:00:00) - use `order_date_to` to cover the whole day.
`date_despatched_from`	Orders despatched on or after this date/time - same as `despatched_at_from`.
`date_despatched_to`	Orders despatched on or before this date/time. A date with no time is compared literally (00:00:00) - use `despatched_at_to` to cover the whole day.
`date_cancelled_from`	Orders cancelled on or after this date/time - same as `cancelled_at_from`.
`date_cancelled_to`	Orders cancelled on or before this date/time. A date with no time is compared literally (00:00:00) - use `cancelled_at_to` to cover the whole day.
`created_at_from`	Orders whose `created_at` (the moment the order reached HELM) is on or after this date/time. Accepts `YYYY-MM-DD` or a full `YYYY-MM-DD HH:MM:SS` / ISO 8601 timestamp; UTC unless an offset is given.
`created_at_to`	Orders whose `created_at` is on or before this date/time. A date with no time covers the whole day, so `created_at_to=2026-08-28` includes orders received at 23:59 that day.
`updated_at_from`	Orders last changed on or after this date/time - the filter to poll with when mirroring HELM into another system, paired with `sort_by=updated_at`.
`updated_at_to`	Orders last changed on or before this date/time.
`order_date_from`	Orders whose `order_date` (when the customer placed the order on the channel) is on or after this date/time.
`order_date_to`	Orders whose `order_date` is on or before this date/time.
`despatched_at_from`	Orders whose `despatched_at` is on or after this date/time. Never matches an order that has not been despatched.
`despatched_at_to`	Orders whose `despatched_at` is on or before this date/time.
`cancelled_at_from`	Orders whose `cancelled_at` is on or after this date/time. Never matches an order that has not been cancelled.
`cancelled_at_to`	Orders whose `cancelled_at` is on or before this date/time.
`archived_at_from`	Orders whose `archived_at` is on or after this date/time. Only archived orders carry one, so this narrows to the archived set on its own.
`archived_at_to`	Orders whose `archived_at` is on or before this date/time.
`despatch_target_date_from`	Orders whose `despatch_target_date` (the despatch SLA deadline) is on or after this date/time.
`despatch_target_date_to`	Orders whose `despatch_target_date` is on or before this date/time - the SLA-breach sweep, combined with `status`.

Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

One order id, or several as ?id[]=1&id[]=2 or ?id=1,2. Synonym of ids.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

One order id, or several as ?ids[]=1&ids[]=2 or ?ids=1,2.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Every order EXCEPT these ids: ?excepted_ids[]=1&excepted_ids[]=2 or ?excepted_ids=1,2.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Synonym of excepted_ids: every order EXCEPT these ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Orders whose order number CONTAINS this term, or exactly one of ?order_number[]=A&order_number[]=B.

\n","type":"text/plain"},"key":"order_number","value":""},{"disabled":true,"description":{"content":"

Orders belonging to one store, or several as ?store_id[]=1&store_id[]=2 or ?store_id=1,2.

\n","type":"text/plain"},"key":"store_id","value":""},{"disabled":true,"description":{"content":"

Orders belonging to one channel, or several as ?channel_id[]=1&channel_id[]=2 or ?channel_id=1,2.

\n","type":"text/plain"},"key":"channel_id","value":""},{"disabled":true,"description":{"content":"

Orders in one status code, or several as ?status[]=1&status[]=5 or ?status=1,5. The codes are listed by GET orders/statuses.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Orders filed in one folder, or several as ?folder_id[]=1&folder_id[]=2 or ?folder_id=1,2.

\n","type":"text/plain"},"key":"folder_id","value":""},{"disabled":true,"description":{"content":"

Orders carrying one tag, or any of several as ?tag_id[]=1&tag_id[]=2 or ?tag_id=1,2.

\n","type":"text/plain"},"key":"tag_id","value":""},{"disabled":true,"description":{"content":"

Orders belonging to one customer, or several as ?customer_id[]=1&customer_id[]=2 or ?customer_id=1,2.

\n","type":"text/plain"},"key":"customer_id","value":""},{"disabled":true,"description":{"content":"

Orders whose customer's name or surname STARTS WITH the given term.

\n","type":"text/plain"},"key":"customer","value":""},{"disabled":true,"description":{"content":"

Orders of one type code, or several as ?order_type[]=1&order_type[]=2 or ?order_type=1,2.

\n","type":"text/plain"},"key":"order_type","value":""},{"disabled":true,"description":{"content":"

Orders currently on hold (?is_hold=1) or not on hold (?is_hold=0).

\n","type":"text/plain"},"key":"is_hold","value":""},{"disabled":true,"description":{"content":"

Orders keyed in by hand rather than pulled from a channel, returned as is_manual.

\n","type":"text/plain"},"key":"is_manual","value":""},{"disabled":true,"description":{"content":"

Orders whose items can all be allocated from stock, returned as is_fulfillable.

\n","type":"text/plain"},"key":"is_fulfillable","value":""},{"disabled":true,"description":{"content":"

?archived=1 returns only archived orders, ?archived=0 only live ones. Omit the parameter to get both.

\n","type":"text/plain"},"key":"archived","value":""},{"disabled":true,"description":{"content":"

Channel Order ID - the order identifier the sales channel itself issued, returned as remote_id. Opaque channel-supplied string, so it is matched verbatim (no comma split); use the array form (?remote_id[]=A&remote_id[]=B) for several.

\n","type":"text/plain"},"key":"remote_id","value":""},{"disabled":true,"description":{"content":"

Channel Alt ID - the channel's secondary order identifier, returned as remote_alt_id. Opaque channel-supplied string, so it is matched verbatim (no comma split); use the array form for several.

\n","type":"text/plain"},"key":"remote_alt_id","value":""},{"disabled":true,"description":{"content":"

Filter by the per-channel order id HELM assigns, returned as channel_order_id. Opaque string, matched verbatim (no comma split).

\n","type":"text/plain"},"key":"channel_order_id","value":""},{"disabled":true,"description":{"content":"

Filter by the caller-supplied external_order_id (set on create/update), matched verbatim.

\n","type":"text/plain"},"key":"external_order_id","value":""},{"disabled":true,"description":{"content":"

Filter by the caller-supplied primary_reference_id (set on create/update), matched verbatim.

\n","type":"text/plain"},"key":"primary_reference_id","value":""},{"disabled":true,"description":{"content":"

Orders whose shipping postcode starts with the given term, so ?postcode=SW1 matches every SW1x.

\n","type":"text/plain"},"key":"postcode","value":""},{"disabled":true,"description":{"content":"

Orders containing an item with this inventory code (SKU), matched exactly. A SKU is free text and may contain a comma, so the value is matched verbatim; use ?code[]=A&code[]=B for several.

\n","type":"text/plain"},"key":"code","value":""},{"disabled":true,"description":{"content":"

Orders containing an item for this inventory id, or any of several as ?inventory_id[]=1&inventory_id[]=2 or ?inventory_id=1,2.

\n","type":"text/plain"},"key":"inventory_id","value":""},{"disabled":true,"description":{"content":"

Orders whose preferred courier service is this one, or any of several as ?courier_service_id=1,2.

\n","type":"text/plain"},"key":"courier_service_id","value":""},{"disabled":true,"description":{"content":"

Orders with a shipment parcel in this tracking status, or any of several as ?tracking_status=1,2.

\n","type":"text/plain"},"key":"tracking_status","value":""},{"disabled":true,"description":{"content":"

Orders created in HELM (imported or keyed in) on or after this date/time - same as created_at_from.

\n","type":"text/plain"},"key":"date_received_from","value":""},{"disabled":true,"description":{"content":"

Orders created in HELM on or before this date/time. A date with no time is compared literally (00:00:00) - use created_at_to to cover the whole day.

\n","type":"text/plain"},"key":"date_received_to","value":""},{"disabled":true,"description":{"content":"

Orders placed by the customer on or after this date/time - same as order_date_from.

\n","type":"text/plain"},"key":"date_placed_from","value":""},{"disabled":true,"description":{"content":"

Orders placed by the customer on or before this date/time. A date with no time is compared literally (00:00:00) - use order_date_to to cover the whole day.

\n","type":"text/plain"},"key":"date_placed_to","value":""},{"disabled":true,"description":{"content":"

Orders despatched on or after this date/time - same as despatched_at_from.

\n","type":"text/plain"},"key":"date_despatched_from","value":""},{"disabled":true,"description":{"content":"

Orders despatched on or before this date/time. A date with no time is compared literally (00:00:00) - use despatched_at_to to cover the whole day.

\n","type":"text/plain"},"key":"date_despatched_to","value":""},{"disabled":true,"description":{"content":"

Orders cancelled on or after this date/time - same as cancelled_at_from.

\n","type":"text/plain"},"key":"date_cancelled_from","value":""},{"disabled":true,"description":{"content":"

Orders cancelled on or before this date/time. A date with no time is compared literally (00:00:00) - use cancelled_at_to to cover the whole day.

\n","type":"text/plain"},"key":"date_cancelled_to","value":""},{"disabled":true,"description":{"content":"

Orders whose created_at (the moment the order reached HELM) is on or after this date/time. Accepts YYYY-MM-DD or a full YYYY-MM-DD HH:MM:SS / ISO 8601 timestamp; UTC unless an offset is given.

\n","type":"text/plain"},"key":"created_at_from","value":""},{"disabled":true,"description":{"content":"

Orders whose created_at is on or before this date/time. A date with no time covers the whole day, so created_at_to=2026-08-28 includes orders received at 23:59 that day.

\n","type":"text/plain"},"key":"created_at_to","value":""},{"disabled":true,"description":{"content":"

Orders last changed on or after this date/time - the filter to poll with when mirroring HELM into another system, paired with sort_by=updated_at.

\n","type":"text/plain"},"key":"updated_at_from","value":""},{"disabled":true,"description":{"content":"

Orders last changed on or before this date/time.

\n","type":"text/plain"},"key":"updated_at_to","value":""},{"disabled":true,"description":{"content":"

Orders whose order_date (when the customer placed the order on the channel) is on or after this date/time.

\n","type":"text/plain"},"key":"order_date_from","value":""},{"disabled":true,"description":{"content":"

Orders whose order_date is on or before this date/time.

\n","type":"text/plain"},"key":"order_date_to","value":""},{"disabled":true,"description":{"content":"

Orders whose despatched_at is on or after this date/time. Never matches an order that has not been despatched.

\n","type":"text/plain"},"key":"despatched_at_from","value":""},{"disabled":true,"description":{"content":"

Orders whose despatched_at is on or before this date/time.

\n","type":"text/plain"},"key":"despatched_at_to","value":""},{"disabled":true,"description":{"content":"

Orders whose cancelled_at is on or after this date/time. Never matches an order that has not been cancelled.

\n","type":"text/plain"},"key":"cancelled_at_from","value":""},{"disabled":true,"description":{"content":"

Orders whose cancelled_at is on or before this date/time.

\n","type":"text/plain"},"key":"cancelled_at_to","value":""},{"disabled":true,"description":{"content":"

Orders whose archived_at is on or after this date/time. Only archived orders carry one, so this narrows to the archived set on its own.

\n","type":"text/plain"},"key":"archived_at_from","value":""},{"disabled":true,"description":{"content":"

Orders whose archived_at is on or before this date/time.

\n","type":"text/plain"},"key":"archived_at_to","value":""},{"disabled":true,"description":{"content":"

Orders whose despatch_target_date (the despatch SLA deadline) is on or after this date/time.

\n","type":"text/plain"},"key":"despatch_target_date_from","value":""},{"disabled":true,"description":{"content":"

Orders whose despatch_target_date is on or before this date/time - the SLA-breach sweep, combined with status.

\n","type":"text/plain"},"key":"despatch_target_date_to","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\").

Allowed relations:

store
channel
totals
totals.currency
meta
notes
channel.settings
allocation
items
items.allocate
items.inventory
items.inventory.meta
items.inventory.barcodes
items.total
items.meta
items.options
mainItem
mainItem.allocate
mainItem.inventory
mainItem.inventory.meta
mainItem.inventory.barcodes
mainItem.total
mainItem.meta
mainItem.options
customer
customer.fileManager
customer.contact
customerContact
customerContact.contact
customerContact.fileManager
shippingAddress
shippingAddress.address
shippingAddress.address.country
shippingAddress.contact
invoiceAddress
invoiceAddress.address
invoiceAddress.address.country
invoiceAddress.contact
preferredCourierService
preferredCourierService.courierService
preferredCourierService.courierService.courier
preferredPackageTemplate
preferredPackageTemplate.packageTemplate
statusTimeline
shipment
shipment.meta
shipment.shipmentFile
shipment.courierService.courier
shipment.parcels.tracking
shipment.parcels.tracking.timeline
shipment.parcels.tracking.timeline.images
mergedOrderTotals
mergedOrderTotals.mergedOrder
tags.tag
folder.folder
events
user
payment
payment.latestLine
refund
refund.latestLine
resendOrder
resendOrderFrom
resendOrder.order
resendOrderFrom.order
subStatuses
items.inventory.stocks
items.inventory.stocks.location
items.inventory.stocks.location.zone
items.inventory.stocks.location.settings
items.inventory.stocks.location.storageTypes
customFields
customFields.customFieldOption

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"cfe3d0ce-a33c-4cc2-9734-98cf8b71fc87"},{"name":"Orders create","id":"9a88d55b-7e9e-4485-8227-602775bf1a8e","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"status\": \"1\",\n \"channel_id\": \"{{channel_id}}\",\n \"is_hold\": false,\n \"reference\": \"reference\",\n \"reference_alt\": \"reference_alt\",\n \"payment_method\": \"\",\n \"payment_reference\": \"\",\n \"shipping_method\": \"\",\n \"currency_id\": \"{{currency_id}}\",\n \"is_invoice_same_as_shipping\": false,\n \"folder_id\": \"{{folder_id}}\",\n \"totals\": {\n \"total_shipping\": 0,\n \"discount\": 0\n },\n \"courier\": {\n \"courier_service_id\": \"{{courier_service_id}}\",\n \"is_locked\": false,\n \"label_reference\": \"1\",\n \"label_secondary_reference\": \"1\"\n },\n \"customer\": {\n \"id\": null,\n \"name\": \"name\",\n \"surname\": \"surname\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"is_company\": false,\n \"company_name\": \"\"\n },\n \"shipping_address\": {\n \"id\": null,\n \"name\": \"\",\n \"surname\": \"\",\n \"company_name\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country_id\": \"{{country_id}}\",\n \"postcode\": \"\",\n \"vat_number\": \"\",\n \"eori\": \"\"\n },\n \"notes\": {\n \"delivery_note\": \"\",\n \"gift_note\": \"\",\n \"customer_note\": \"\"\n },\n \"tags\": [\n \"tag\"\n ],\n \"invoice_address\": {\n \"id\": null,\n \"name\": \"\",\n \"surname\": \"\",\n \"company_name\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country_id\": \"{{country_id}}\",\n \"postcode\": \"\"\n },\n \"items\": [\n {\n \"name\": \"\",\n \"inventory_id\": \"{{inventory_id}}\",\n \"meta\": {\n \"hs_code\": 0,\n \"country_id\": \"{{country_id}}\"\n },\n \"quantity\": 1,\n \"options\": \"\",\n \"unit_price\": 0,\n \"unit_discount\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//orders","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`status`	string	yes	Allowed: `1`, `2`
`channel_id`	integer	yes	—
`is_hold`	boolean \| null	no	—
`reference`	string \| null	no	—
`reference_alt`	string \| null	no	—
`payment_method`	string \| null	no	—
`payment_reference`	string \| null	no	—
`shipping_method`	string \| null	no	—
`currency_id`	integer \| null	no	—
`is_invoice_same_as_shipping`	boolean	no	—
`folder_id`	integer \| null	no	—
`totals`	object	yes	—
`totals.total_shipping`	number	yes	—
`totals.discount`	number	yes	—
`courier`	object	no	—
`courier.courier_service_id`	integer \| null	no	—
`courier.is_locked`	boolean	no	—
`courier.label_reference`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`
`courier.label_secondary_reference`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`
`customer`	object	yes	—
`customer.id`	integer \| null	no	—
`customer.name`	string	yes	—
`customer.surname`	string	yes	—
`customer.email`	string	yes	—
`customer.phone`	string \| null	no	—
`customer.is_company`	boolean	yes	—
`customer.company_name`	string	no	—
`shipping_address`	object	no	—
`shipping_address.id`	integer \| null	no	—
`shipping_address.name`	string	no	—
`shipping_address.surname`	string	no	—
`shipping_address.company_name`	string \| null	no	—
`shipping_address.phone`	string \| null	no	—
`shipping_address.email`	string	no	—
`shipping_address.address_line_1`	string	no	—
`shipping_address.address_line_2`	string \| null	no	—
`shipping_address.city`	string	no	—
`shipping_address.county`	string \| null	no	—
`shipping_address.country_id`	integer	no	—
`shipping_address.country_iso_code`	string	no	—
`shipping_address.postcode`	string \| null	no	—
`shipping_address.vat_number`	string \| null	no	—
`shipping_address.eori`	string \| null	no	—
`notes`	object	no	—
`notes.delivery_note`	string \| null	no	—
`notes.gift_note`	string \| null	no	—
`notes.customer_note`	string \| null	no	—
`tags`	array \| null	no	—
`invoice_address`	object	no	—
`invoice_address.id`	integer \| null	no	—
`invoice_address.name`	string	no	—
`invoice_address.surname`	string	no	—
`invoice_address.company_name`	string \| null	no	—
`invoice_address.phone`	string \| null	no	—
`invoice_address.email`	string	no	—
`invoice_address.address_line_1`	string	no	—
`invoice_address.address_line_2`	string \| null	no	—
`invoice_address.address_line_3`	string \| null	no	—
`invoice_address.city`	string	no	—
`invoice_address.county`	string \| null	no	—
`invoice_address.country_id`	integer	no	—
`invoice_address.country_iso_code`	string	no	—
`invoice_address.postcode`	string \| null	no	—
`items`	array \| null	no	—
`items.*.name`	string \| null	no	—
`items.*.inventory_id`	integer	yes	—
`items.*.meta`	object \| null	no	—
`items.*.meta.hs_code`	number \| null	no	—
`items.*.meta.country_id`	integer \| null	no	—
`items.*.quantity`	integer	yes	—
`items.*.options`	string \| null	no	—
`items.*.unit_price`	number	yes	—
`items.*.unit_discount`	number \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

store
channel
totals
totals.currency
meta
notes
channel.settings
allocation
items
items.allocate
items.inventory
items.inventory.meta
items.inventory.barcodes
items.total
items.meta
items.options
mainItem
mainItem.allocate
mainItem.inventory
mainItem.inventory.meta
mainItem.inventory.barcodes
mainItem.total
mainItem.meta
mainItem.options
customer
customer.fileManager
customer.contact
customerContact
customerContact.contact
customerContact.fileManager
shippingAddress
shippingAddress.address
shippingAddress.address.country
shippingAddress.contact
invoiceAddress
invoiceAddress.address
invoiceAddress.address.country
invoiceAddress.contact
preferredCourierService
preferredCourierService.courierService
preferredCourierService.courierService.courier
preferredPackageTemplate
preferredPackageTemplate.packageTemplate
statusTimeline
shipment
shipment.meta
shipment.shipmentFile
shipment.courierService.courier
shipment.parcels.tracking
shipment.parcels.tracking.timeline
shipment.parcels.tracking.timeline.images
mergedOrderTotals
mergedOrderTotals.mergedOrder
tags.tag
folder.folder
events
user
payment
payment.latestLine
refund
refund.latestLine
resendOrder
resendOrderFrom
resendOrder.order
resendOrderFrom.order
subStatuses
items.inventory.stocks
items.inventory.stocks.location
items.inventory.stocks.location.zone
items.inventory.stocks.location.settings
items.inventory.stocks.location.storageTypes
customFields
customFields.customFieldOption

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - store - channel - totals - totals.currency - meta - notes - channel.settings - allocation - items - items.allocate - items.inventory - items.inventory.meta - items.inventory.barcodes - items.total - items.meta - items.options - mainItem - mainItem.allocate - mainItem.inventory - mainItem.inventory.meta - mainItem.inventory.barcodes - mainItem.total - mainItem.meta - mainItem.options - customer - customer.fileManager - customer.contact - customerContact - customerContact.contact - customerContact.fileManager - shippingAddress - shippingAddress.address - shippingAddress.address.country - shippingAddress.contact - invoiceAddress - invoiceAddress.address - invoiceAddress.address.country - invoiceAddress.contact - preferredCourierService - preferredCourierService.courierService - preferredCourierService.courierService.courier - preferredPackageTemplate - preferredPackageTemplate.packageTemplate - statusTimeline - shipment - shipment.meta - shipment.shipmentFile - shipment.courierService.courier - shipment.parcels.tracking - shipment.parcels.tracking.timeline - shipment.parcels.tracking.timeline.images - mergedOrderTotals - mergedOrderTotals.mergedOrder - tags.tag - folder.folder - events - user - payment - payment.latestLine - refund - refund.latestLine - resendOrder - resendOrderFrom - resendOrder.order - resendOrderFrom.order - subStatuses - items.inventory.stocks - items.inventory.stocks.location - items.inventory.stocks.location.zone - items.inventory.stocks.location.settings - items.inventory.stocks.location.storageTypes - customFields - customFields.customFieldOption

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"f9daf2bf-6e00-4927-bb3e-5fbba8755d7c","type":"any","value":"","key":"orderID"}]}},"response":[],"_postman_id":"cf564c1a-6449-4c9f-b5e4-a4c0a64b72ad"},{"name":"Orders update","id":"4ba9dc46-38ef-4fcc-a5fb-7747705e13de","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"order_id\": \"{{order_id}}\",\n \"status\": \"2\",\n \"channel_id\": \"{{channel_id}}\",\n \"is_hold\": false,\n \"reference\": \"reference\",\n \"reference_alt\": \"reference_alt\",\n \"payment_method\": \"\",\n \"payment_reference\": \"\",\n \"shipping_method\": \"\",\n \"currency_id\": \"{{currency_id}}\",\n \"is_invoice_same_as_shipping\": false,\n \"folder_id\": \"{{folder_id}}\",\n \"customer\": {\n \"id\": null,\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"is_company\": false,\n \"company_name\": \"\"\n },\n \"shipping_address\": {\n \"id\": null,\n \"name\": \"\",\n \"surname\": \"\",\n \"company_name\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country_id\": \"{{country_id}}\",\n \"postcode\": \"\",\n \"vat_number\": \"\",\n \"eori\": \"\"\n },\n \"totals\": {\n \"total_shipping\": 0,\n \"discount\": 0\n },\n \"courier\": {\n \"courier_service_id\": \"{{courier_service_id}}\",\n \"is_locked\": false,\n \"label_reference\": \"1\",\n \"label_secondary_reference\": \"1\"\n },\n \"notes\": {\n \"delivery_note\": \"\",\n \"gift_note\": \"\",\n \"customer_note\": \"\"\n },\n \"tags\": [\n \"tag\"\n ],\n \"items\": [\n {\n \"id\": \"{{id}}\",\n \"name\": \"\",\n \"meta\": {\n \"hs_code\": 0,\n \"country_id\": \"{{country_id}}\"\n },\n \"quantity\": 1,\n \"options\": \"\",\n \"unit_price\": 0,\n \"unit_discount\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//orders/:orderID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`status`	string \| null	no	Allowed: `2`
`channel_id`	integer \| null	no	—
`is_hold`	boolean \| null	no	—
`reference`	string \| null	no	—
`reference_alt`	string \| null	no	—
`payment_method`	string \| null	no	—
`payment_reference`	string \| null	no	—
`shipping_method`	string \| null	no	—
`currency_id`	integer \| null	no	—
`is_invoice_same_as_shipping`	boolean	no	—
`folder_id`	integer \| null	no	—
`customer`	object	no	—
`customer.id`	integer \| null	no	—
`customer.name`	string	no	—
`customer.surname`	string	no	—
`customer.email`	string	no	—
`customer.phone`	string \| null	no	—
`customer.is_company`	boolean	no	—
`customer.company_name`	string	no	required_if (not required_with): required_with fires on presence, and a boolean false counts as present, so it would force company_name for individuals (is_company=false). Only require it when is_company is true.
`shipping_address`	object	no	—
`shipping_address.id`	integer \| null	no	—
`shipping_address.name`	string	no	—
`shipping_address.surname`	string	no	—
`shipping_address.company_name`	string \| null	no	—
`shipping_address.phone`	string \| null	no	—
`shipping_address.email`	string	no	—
`shipping_address.address_line_1`	string	no	—
`shipping_address.address_line_2`	string \| null	no	—
`shipping_address.city`	string	no	—
`shipping_address.county`	string \| null	no	—
`shipping_address.country_id`	integer	no	—
`shipping_address.postcode`	string \| null	no	—
`shipping_address.vat_number`	string \| null	no	—
`shipping_address.eori`	string \| null	no	—
`totals`	object	no	—
`totals.total_shipping`	number \| null	no	—
`totals.discount`	number \| null	no	—
`courier`	object	no	—
`courier.courier_service_id`	integer \| null	no	—
`courier.is_locked`	boolean \| null	no	—
`courier.label_reference`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`
`courier.label_secondary_reference`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`
`notes`	object	no	—
`notes.delivery_note`	string \| null	no	—
`notes.gift_note`	string \| null	no	—
`notes.customer_note`	string \| null	no	—
`tags`	array \| null	no	—
`items`	array \| null	no	—
`items.*.id`	integer	yes	—
`items.*.name`	string \| null	no	—
`items.*.meta`	object \| null	no	—
`items.*.meta.hs_code`	number \| null	no	—
`items.*.meta.country_id`	integer \| null	no	—
`items.*.quantity`	integer	yes	—
`items.*.options`	string \| null	no	—
`items.*.unit_price`	number	yes	—
`items.*.unit_discount`	number \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`status`	string \| null	no	Allowed: `2`
`channel_id`	integer \| null	no	—
`is_hold`	boolean \| null	no	—
`reference`	string \| null	no	—
`reference_alt`	string \| null	no	—
`payment_method`	string \| null	no	—
`payment_reference`	string \| null	no	—
`shipping_method`	string \| null	no	—
`currency_id`	integer \| null	no	—
`is_invoice_same_as_shipping`	boolean	no	—
`folder_id`	integer \| null	no	—
`customer`	object	no	—
`customer.id`	integer \| null	no	—
`customer.name`	string	no	—
`customer.surname`	string	no	—
`customer.email`	string	no	—
`customer.phone`	string \| null	no	—
`customer.is_company`	boolean	no	—
`customer.company_name`	string	no	required_if (not required_with): required_with fires on presence, and a boolean false counts as present, so it would force company_name for individuals (is_company=false). Only require it when is_company is true.
`shipping_address`	object	no	—
`shipping_address.id`	integer \| null	no	—
`shipping_address.name`	string	no	—
`shipping_address.surname`	string	no	—
`shipping_address.company_name`	string \| null	no	—
`shipping_address.phone`	string \| null	no	—
`shipping_address.email`	string	no	—
`shipping_address.address_line_1`	string	no	—
`shipping_address.address_line_2`	string \| null	no	—
`shipping_address.city`	string	no	—
`shipping_address.county`	string \| null	no	—
`shipping_address.country_id`	integer	no	—
`shipping_address.postcode`	string \| null	no	—
`shipping_address.vat_number`	string \| null	no	—
`shipping_address.eori`	string \| null	no	—
`totals`	object	no	—
`totals.total_shipping`	number \| null	no	—
`totals.discount`	number \| null	no	—
`courier`	object	no	—
`courier.courier_service_id`	integer \| null	no	—
`courier.is_locked`	boolean \| null	no	—
`courier.label_reference`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`
`courier.label_secondary_reference`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`
`notes`	object	no	—
`notes.delivery_note`	string \| null	no	—
`notes.gift_note`	string \| null	no	—
`notes.customer_note`	string \| null	no	—
`tags`	array \| null	no	—
`items`	array \| null	no	—
`items.*.id`	integer	yes	—
`items.*.name`	string \| null	no	—
`items.*.meta`	object \| null	no	—
`items.*.meta.hs_code`	number \| null	no	—
`items.*.meta.country_id`	integer \| null	no	—
`items.*.quantity`	integer	yes	—
`items.*.options`	string \| null	no	—
`items.*.unit_price`	number	yes	—
`items.*.unit_discount`	number \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`filters`	—
`ignore_ids[]`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`customer_id`	integer	yes	—
`contact_id`	integer \| null	no	—
`address_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`order_id`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations vary per endpoint.

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"1ff7c501-eda2-4819-8c53-177161062f54","type":"any","value":"","key":"orderID"}]}},"response":[],"_postman_id":"109a3885-362f-4425-8aba-8c31e32c4462"},{"name":"Orders merged orders","id":"ac78864f-4ac9-4736-b58d-7ed2cf7f0776","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//orders/:orderID/merged-orders?company_id=&order_id=","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`order_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`order_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`order_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	string	yes	—
`total_shipping`	number	yes	—
`discount`	number	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`order_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`order_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`order_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`payment_method`	string \| null	no	—
`payment_reference`	string \| null	no	—
`currency_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`order_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`status`	string	yes	Allowed: `1`, `2`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`reference`	string \| null	no	—
`reference_alt`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`is_hold`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`mergedTotalID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	string	yes	—
`merged_total_id`	string	yes	—
`total_shipping`	number	yes	—
`discount`	number	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	string	yes	—
`courier_service_id`	integer \| null	no	—
`warning_caused_by`	string \| null	no	Allowed: `1`, `2`, `3`
`is_locked`	boolean	no	—
`label_reference`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`
`label_secondary_reference`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`channel_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`shipping_address`	array \| null	no	—
`invoice_address`	array \| null	no	—
`customer`	object	yes	—
`customer.id`	integer \| null	no	—
`customer.name`	string	yes	—
`customer.surname`	string	yes	—
`customer.email`	string	yes	—
`customer.phone`	string \| null	no	—
`customer.is_company`	boolean	yes	—
`customer.company_name`	string	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`order_id`	—
`order_item_ids[]`	—
`service_charge_ids[]`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`filter[ids][]`	—
`order_id`	Filter by Order Id.
`order_item_parent_id`	Filter by Order Item Parent Id.
`without_child_items`	Filter by Without Child Items.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

order
previousOrder
allocate
children
children.options
children.total
children.inventory
children.inventory.meta
children.pickOrderItem
children.pickOrderItem.pickItem
children.pickOrderItem.pickItem.location
children.pickOrderItem.pickItem.pick
children.pickOrderItem.pickItem.pick.settings
total
meta
inventory
inventory.stocks.location
inventory.stocks.location.zone
inventory.stocks.location.settings
channelProduct
inventory.meta
pickOrderItem
pickOrderItem.pickItem
pickOrderItem.pickItem.location
pickOrderItem.pickItem.pick
pickOrderItem.pickItem.pick.settings
options
inventory.linkedChannelProduct.channelProduct
children.inventory.linkedChannelProduct.channelProduct
resendItems
resendItems.orderItem
resendItems.order
resendItems.previousOrder
resendItems.previousOrderItem
inventory.shelf
inventory.shelf.shelf
splitOrigin.previousOrder

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Order Id.

\n","type":"text/plain"},"key":"order_id","value":""},{"disabled":true,"description":{"content":"

Filter by Order Item Parent Id.

\n","type":"text/plain"},"key":"order_item_parent_id","value":""},{"disabled":true,"description":{"content":"

Filter by Without Child Items.

\n","type":"text/plain"},"key":"without_child_items","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - order - previousOrder - allocate - children - children.options - children.total - children.inventory - children.inventory.meta - children.pickOrderItem - children.pickOrderItem.pickItem - children.pickOrderItem.pickItem.location - children.pickOrderItem.pickItem.pick - children.pickOrderItem.pickItem.pick.settings - total - meta - inventory - inventory.stocks.location - inventory.stocks.location.zone - inventory.stocks.location.settings - channelProduct - inventory.meta - pickOrderItem - pickOrderItem.pickItem - pickOrderItem.pickItem.location - pickOrderItem.pickItem.pick - pickOrderItem.pickItem.pick.settings - options - inventory.linkedChannelProduct.channelProduct - children.inventory.linkedChannelProduct.channelProduct - resendItems - resendItems.orderItem - resendItems.order - resendItems.previousOrder - resendItems.previousOrderItem - inventory.shelf - inventory.shelf.shelf - splitOrigin.previousOrder

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"a9011c4c-b5d2-485b-ac09-5f2f436b2909","type":"any","value":"","key":"orderID"}]}},"response":[],"_postman_id":"0d5b9c38-dddc-430e-85b3-4490d9a2a2e6"},{"name":"Orders items create","id":"e86c90f3-f0a4-4239-b786-898ff79595f7","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"order_id\": \"{{order_id}}\",\n \"name\": \"\",\n \"inventory_id\": \"{{inventory_id}}\",\n \"quantity\": 1,\n \"options\": \"\",\n \"unit_price\": 0,\n \"unit_discount\": 0,\n \"meta\": {\n \"hs_code\": 0,\n \"country_id\": \"{{country_id}}\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//orders/:orderID/items","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`name`	string \| null	no	—
`inventory_id`	integer	yes	—
`quantity`	integer	yes	—
`options`	string \| null	no	—
`unit_price`	number	yes	—
`unit_discount`	number \| null	no	—
`meta`	object	no	—
`meta.hs_code`	number \| null	no	—
`meta.country_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`mergedOrderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`merged_order_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`items`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`order_id`	Filter by Order Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Order Id.

\n","type":"text/plain"},"key":"order_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations vary per endpoint.

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"58abcb81-296a-4b8b-9403-90b1e99276e7","type":"any","value":"","key":"orderID"}]}},"response":[],"_postman_id":"ea9f0e85-737f-4193-b332-ca34d89e2c11"},{"name":"Orders attachments create","id":"c9952a83-ddcb-4e44-a6fb-d1888cf73121","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"file_manager_id\": 123,\n \"company_id\": \"\",\n \"order_id\": \"{{order_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//orders/:orderID/attachments","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Attaches an already uploaded file to the order. Upload it first with\nPOST /companies/{companyID}/file-manager/upload using type = 7 (ORDER) and pass the returned id here.\nResponds 204 No Content; the attachment then appears in GET .../attachments, where path is a\ntime-limited download URL. One file can be attached to one order only.

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`file_manager_id`	integer	yes	Id of a file uploaded through POST /file-manager/upload with `type` = 7 (ORDER). A file can be attached to one order only.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`orderAttachmentID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`order_id`	—
`order_attachment_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[{"id":"78781f4c-2fcb-4656-b332-15559322b7ac","type":"any","value":"","key":"orderID"}]}},"response":[],"_postman_id":"94ed7d38-1c29-42b3-9a13-7a1bd2bf41e5"},{"name":"Orders comments create","id":"4ea544ae-a465-4b5b-b29e-0372aec9f3f7","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"order_id\": \"{{order_id}}\",\n \"content\": \"content\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//orders/:orderID/comments","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`content`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`orderCommentID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`order_comment_id`	integer	yes	—
`content`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`orderCommentID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`order_comment_id`	integer	yes	—
`content`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`orderCommentID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`order_id`	—
`order_comment_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`search`	Filter by Search.
`order_id`	Filter by Order Id.
`is_active`	Filter by Is Active.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

orders

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Search.

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

Filter by Order Id.

\n","type":"text/plain"},"key":"order_id","value":""},{"disabled":true,"description":{"content":"

Filter by Is Active.

\n","type":"text/plain"},"key":"is_active","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - orders

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"546f58ca-bbe9-41ed-80ac-0c88c2c02d6e"},{"name":"Orders folders create","id":"30b3ac56-6622-43d3-b876-d79bbbc0afb2","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"name\": \"name\",\n \"colour\": \"1\",\n \"icon_class\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//orders/folders","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`colour`	string	yes	JobTypeColour values: - `1` = BLACK - `2` = BLUE - `3` = RED - `4` = GREEN - `5` = YELLOW - `6` = NAVY - `7` = ORANGE - `8` = PURPLE - `9` = PINK - `10` = BROWN - `11` = MINT - `12` = BEIGE - `13` = CYAN - `14` = MAROON - `15` = GRAY Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`
`icon_class`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`all`	boolean	yes	—
`folder_ids`	array	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`folderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`folder_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`folderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`folder_id`	integer	yes	—
`is_active`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`folderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`folder_id`	integer	yes	—
`name`	string	yes	—
`colour`	string	yes	JobTypeColour values: - `1` = BLACK - `2` = BLUE - `3` = RED - `4` = GREEN - `5` = YELLOW - `6` = NAVY - `7` = ORANGE - `8` = PURPLE - `9` = PINK - `10` = BROWN - `11` = MINT - `12` = BEIGE - `13` = CYAN - `14` = MAROON - `15` = GRAY Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`
`icon_class`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`folderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`folder_id`	integer	yes	—
`name`	string	yes	—
`colour`	string	yes	JobTypeColour values: - `1` = BLACK - `2` = BLUE - `3` = RED - `4` = GREEN - `5` = YELLOW - `6` = NAVY - `7` = ORANGE - `8` = PURPLE - `9` = PINK - `10` = BROWN - `11` = MINT - `12` = BEIGE - `13` = CYAN - `14` = MAROON - `15` = GRAY Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`
`icon_class`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`folderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`folder_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`folderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`folder_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`folderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`folder_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`items`	array	yes	—
`items.*.name`	string \| null	no	—
`items.*.quantity`	integer	yes	—
`items.*.options`	string \| null	no	—
`items.*.meta`	object \| null	no	—
`items.*.meta.hs_code`	number \| null	no	—
`items.*.meta.country_id`	integer \| null	no	—
`items.*.inventory_id`	integer	yes	—
`items.*.unit_price`	number	yes	—
`items.*.unit_discount`	number \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`items`	array	yes	—
`items.*.order_item_id`	integer	yes	—
`items.*.name`	string \| null	no	—
`items.*.quantity`	integer	yes	—
`items.*.options`	string \| null	no	—
`items.*.meta`	object \| null	no	—
`items.*.meta.hs_code`	string \| null	no	—
`items.*.meta.country_id`	integer \| null	no	—
`items.*.unit_price`	number	yes	—
`items.*.unit_discount`	number \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`order_item_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`orderItemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`order_item_id`	integer	yes	—
`name`	string \| null	no	—
`quantity`	integer	yes	—
`options`	string \| null	no	—
`unit_price`	number	yes	—
`unit_discount`	number \| null	no	—
`meta`	object	no	—
`meta.hs_code`	string \| null	no	—
`meta.country_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`orderItemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`order_item_id`	integer	yes	—
`name`	string \| null	no	—
`quantity`	integer	yes	—
`options`	string \| null	no	—
`unit_price`	number	yes	—
`unit_discount`	number \| null	no	—
`meta`	object	no	—
`meta.hs_code`	string \| null	no	—
`meta.country_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`orderItemID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`removed_order_item_ids`	array \| null	no	—
`items`	array	yes	—
`items.*.name`	string \| null	no	—
`items.*.quantity`	integer	yes	—
`items.*.unit_price`	number	yes	—
`items.*.options`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`order_item_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`orderItemID`	integer	yes
`orderChildItemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`order_item_id`	integer	yes	—
`order_child_item_id`	integer	yes	—
`name`	string	yes	—
`quantity`	integer	yes	—
`options`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`orderItemID`	integer	yes
`orderChildItemID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`order_id`	—
`order_item_id`	—
`order_child_item_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[{"id":"fdf3a539-7682-454a-9047-230f76be9054","type":"any","value":"","key":"orderID"}]}},"response":[],"_postman_id":"e5075277-a44f-4da7-97bd-9f4f24beb6b0"},{"name":"Orders notes create","id":"4715bf7f-9ae8-43de-8330-d68f7bdb0a81","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"order_id\": \"{{order_id}}\",\n \"type\": \"1\",\n \"content\": \"content\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//orders/:orderID/notes","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`type`	string	yes	Allowed: `1`, `2`, `3`
`content`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`orderNoteID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`order_note_id`	integer	yes	—
`type`	string	yes	Allowed: `1`, `2`, `3`
`content`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`orderNoteID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`order_note_id`	integer	yes	—
`type`	string	yes	Allowed: `1`, `2`, `3`
`content`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`orderNoteID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`order_id`	—
`order_note_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`order_id`	Filter by Order Id.
`payment_id`	Filter by Payment Id.
`status`	Filter by Status.
`payment_method_type`	Filter by Payment Method Type.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Order Id.

\n","type":"text/plain"},"key":"order_id","value":""},{"disabled":true,"description":{"content":"

Filter by Payment Id.

\n","type":"text/plain"},"key":"payment_id","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Payment Method Type.

\n","type":"text/plain"},"key":"payment_method_type","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations vary per endpoint.

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"545e348e-c388-4229-88eb-76e99166b7f9","type":"any","value":"","key":"orderID"}]}},"response":[],"_postman_id":"23ee9780-e44a-47a9-b6f7-4e9cc0862a16"},{"name":"Orders payments pay","id":"695ae52b-6878-4ae6-b512-7d7da12304a6","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"order_id\": \"{{order_id}}\",\n \"payment_id\": \"{{payment_id}}\",\n \"payment_method\": \"1\",\n \"payment_method_id\": \"{{payment_method_id}}\",\n \"price\": 0,\n \"payment_reference\": \"\",\n \"recipient_emails\": [\n \"user@example.com\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//orders/:orderID/payments/:paymentID/pay","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`paymentID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	string	yes	—
`payment_id`	string	yes	—
`payment_method`	string	yes	ReturnsMethod values: - `1` = DIRECT_TO_LOCATION - `2` = ADD_SINGLE_MOVEMENT - `3` = ADD_MULTIPLE_MOVEMENT Allowed: `1`, `2`, `3`
`payment_method_id`	string \| null	no	—
`price`	number	yes	—
`payment_reference`	string \| null	no	—
`recipient_emails`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`refundID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	string	yes	—
`refund_id`	string	yes	—
`refund_method`	string	yes	Allowed: `1`
`price`	number	yes	—
`refund_reference`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`order_id`	Filter by Order Id.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

order
items
items.location
items.jobReason
items.orderReturn
items.orderItem
items.previousOrderItem
items.files
items.files.fileManager
user

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Order Id.

\n","type":"text/plain"},"key":"order_id","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - order - items - items.location - items.jobReason - items.orderReturn - items.orderItem - items.previousOrderItem - items.files - items.files.fileManager - user

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"4d413146-3b3c-4c3c-9ae8-0c5178340935","type":"any","value":"","key":"orderID"}]}},"response":[],"_postman_id":"879c2a86-1c8a-4696-a632-11c4a0360b97"},{"name":"Orders returns create","id":"bc1c483f-0ac4-40a9-a5c9-306c4e59f2ad","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"order_id\": \"{{order_id}}\",\n \"returns_method\": \"1\",\n \"movement_maximum_lines\": 0,\n \"movement_jobs\": [\n \"\"\n ],\n \"items\": [\n {\n \"order_item_id\": \"{{order_item_id}}\",\n \"return_quantity\": 1,\n \"job_reason_id\": \"{{job_reason_id}}\",\n \"restockable\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//orders/:orderID/returns","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`returns_method`	string \| null	no	ReturnsMethod values: - `1` = DIRECT_TO_LOCATION - `2` = ADD_SINGLE_MOVEMENT - `3` = ADD_MULTIPLE_MOVEMENT Allowed: `1`, `2`, `3`
`movement_maximum_lines`	integer \| null	no	—
`movement_jobs`	array \| null	no	—
`items`	array	yes	—
`items.*.order_item_id`	integer	yes	—
`items.*.return_quantity`	integer	yes	—
`items.*.job_reason_id`	integer	yes	—
`items.*.restockable`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`orderReturnID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

order
items
items.location
items.jobReason
items.orderReturn
items.orderItem
items.previousOrderItem
items.files
items.files.fileManager
user

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"13f066cb-1b69-4857-85aa-c4dceaeebe6d","type":"any","value":"","key":"orderID"},{"id":"b0469691-dd9c-42da-9f92-f7511ce7070f","type":"any","value":"","key":"orderReturnID"}]}},"response":[],"_postman_id":"0a098a09-958c-4722-bdb3-7853e66c9dce"},{"name":"Orders tags suggestions","id":"00576ebf-3935-48a0-b605-c5cd53d34deb","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//orders/tags","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`search`	Filter by Search.
`order_id`	Filter by Order Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Search.

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

Filter by Order Id.

\n","type":"text/plain"},"key":"order_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"00576ebf-3935-48a0-b605-c5cd53d34deb"},{"name":"Orders tags attached tags","id":"0c3848dd-e104-488b-aa75-e7d03b76be62","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//orders/attached-tags","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`name`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`tagID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`tag_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`tagID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`tag_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`order_return_id`	integer \| null	no	—
`shipping_price`	number \| null	no	—
`refund_action_type`	string	yes	Allowed: `1`, `2`, `3`
`items`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`order_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`order_id`	Filter by Order Id.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

user
user.fileManager
items
total

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Order Id.

\n","type":"text/plain"},"key":"order_id","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - user - user.fileManager - items - total

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"4c4c3533-7a0c-40e0-98e9-de9865362872","type":"any","value":"","key":"orderID"}]}},"response":[],"_postman_id":"b559ac50-eaff-4f53-a5eb-af572423c10a"},{"name":"Orders refund orders create","id":"9e141fa1-ef69-4f0f-be81-0ffa03bef51b","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"order_id\": \"{{order_id}}\",\n \"order_return_id\": \"{{order_return_id}}\",\n \"shipping_price\": 0,\n \"refund_action_type\": \"1\",\n \"items\": [\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//orders/:orderID/refunds","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`order_return_id`	integer \| null	no	—
`shipping_price`	number \| null	no	—
`refund_action_type`	string	yes	Allowed: `1`, `2`, `3`
`items`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`refundOrderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

user
user.fileManager
items
total

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - user - user.fileManager - items - total

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"ad08b466-7663-4e23-9dd2-16459ed335e8","type":"any","value":"","key":"orderID"},{"id":"f7430223-080f-441a-a1ba-6ae401179bc5","type":"any","value":"","key":"refundOrderID"}]}},"response":[],"_postman_id":"b953bfd8-5e30-4711-9a87-d19fe3db94bf"},{"name":"Orders List Splittable Picked Items","id":"63c75652-9852-4a29-979b-4ad583c45ccf","request":{"method":"GET","header":[{"key":"X-App-Token","value":"{{app_token}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://app-api.helmwms.app/api/v2/companies//orders/{{order_id}}/split-picked-items","description":"

Returns the splittable lines of a PARTIALLY_PICKED order (no pagination): top-level lines (normal + group parent) with picked qty > 0.

Per line:

id — order_item_id (the id to send to POST /split-picked)
name, sku, image, sizes — for the dialog
is_group
picked_quantity — normal line: total picked units; group line: number of complete picked sets.

Only PARTIALLY_PICKED orders are eligible (otherwise 422).

Orders — 96 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"e793559d-9cbd-485a-9393-f11106a31dc1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Package Template","item":[{"name":"Package template list","id":"b1e3f9e9-49ae-4400-b5a7-15401728a7ee","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//package-template","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`name`	Filter by Name.
`is_active`	Filter by Is Active.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

items
items.inventory
items.inventory.meta
items.inventory.dimension

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Is Active.

\n","type":"text/plain"},"key":"is_active","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - items - items.inventory - items.inventory.meta - items.inventory.dimension

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"b1e3f9e9-49ae-4400-b5a7-15401728a7ee"},{"name":"Package template create","id":"e5c8dc5d-c2bf-46c3-8808-f78844e13828","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"name\": \"name\",\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"weight_type\": \"1\",\n \"weight\": 0,\n \"is_active\": false,\n \"items\": [\n {\n \"inventory_id\": \"{{inventory_id}}\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//package-template","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`length`	number	yes	—
`width`	number	yes	—
`height`	number	yes	—
`weight_type`	string	yes	ShipmentPackageTemplateWeightType values: - `1` = FIXED - `2` = VARIABLE Allowed: `1`, `2`
`weight`	number \| null	no	—
`is_active`	boolean \| null	no	—
`items`	array \| null	no	—
`items.*.inventory_id`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`package_templates`	array	yes	—
`package_templates.*.template_id`	integer	yes	—
`sort_number`	array	no	—
`sort_number.*.sort_number`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`packageTemplateID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

items
items.inventory
items.inventory.meta
items.inventory.dimension

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - items - items.inventory - items.inventory.meta - items.inventory.dimension

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"e0e443da-36e4-4cea-985e-23ad3add1a2e","type":"any","value":"","key":"packageTemplateID"}]}},"response":[],"_postman_id":"f2bc9298-b14b-49f4-93e4-6d2b520795e4"},{"name":"Package template update","id":"8e49eed8-5e21-45c0-83e3-33dcf51de86e","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"package_template_id\": \"{{package_template_id}}\",\n \"name\": \"name\",\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"weight_type\": \"1\",\n \"weight\": 0,\n \"items\": [\n {\n \"inventory_id\": \"{{inventory_id}}\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//package-template/:packageTemplateID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`packageTemplateID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`package_template_id`	integer	yes	—
`name`	string	yes	—
`length`	number	yes	—
`width`	number	yes	—
`height`	number	yes	—
`weight_type`	string	yes	ShipmentPackageTemplateWeightType values: - `1` = FIXED - `2` = VARIABLE Allowed: `1`, `2`
`weight`	number \| null	no	—
`items`	array \| null	no	—
`items.*.inventory_id`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`packageTemplateID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`package_template_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`packageTemplateID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`package_template_id`	integer	yes	—
`is_active`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`packageTemplateID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`package_template_id`	—

Package Template — 8 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"22a5afdf-dfc3-4f95-8f48-8b38293550fd","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Payment Methods","item":[{"name":"Payment methods available providers","id":"f625cfcb-50b2-4051-824e-7d16ae01a608","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//payment-methods/available-providers","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`paymentMethodType`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`payment_method_type`	Options: `3`, `2`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`payment_method_type`	string	yes	Allowed: `3`, `2`
`is_active`	boolean	yes	—
`credentials`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`search`	Filter by Search.
`query`	Filter by Query.
`is_active`	Filter by Is Active.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

credentials

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Search.

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Is Active.

\n","type":"text/plain"},"key":"is_active","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - credentials

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"2496e405-5cab-4306-8670-e46e4167179b"},{"name":"Payment methods create","id":"33de68f5-9083-460a-afb8-21eb04e19b29","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"name\": \"name\",\n \"payment_method_type\": \"3\",\n \"is_active\": false,\n \"credentials\": [\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//payment-methods","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`payment_method_type`	string	yes	Allowed: `3`, `2`
`is_active`	boolean	yes	—
`credentials`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`paymentMethodID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

credentials

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - credentials

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"0e80a1b4-921d-4558-9b34-89066eeb7265","type":"any","value":"","key":"paymentMethodID"}]}},"response":[],"_postman_id":"71015d83-5ffd-48ab-9e06-4871683e7d09"},{"name":"Payment methods update","id":"d2295860-2f20-47d7-b41a-bf29f2075014","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"payment_method_type\": \"3\",\n \"payment_method_id\": \"{{payment_method_id}}\",\n \"name\": \"name\",\n \"is_active\": false,\n \"credentials\": [\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//payment-methods/:paymentMethodID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`paymentMethodID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`payment_method_type`	string	yes	Allowed: `3`, `2`
`payment_method_id`	integer	yes	—
`name`	string	yes	—
`is_active`	boolean	yes	—
`credentials`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`paymentMethodID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`payment_method_type`	string	yes	Allowed: `3`, `2`
`payment_method_id`	integer	yes	—
`name`	string	yes	—
`is_active`	boolean	yes	—
`credentials`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`paymentMethodID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`payment_method_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`paymentMethodID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`payment_method_id`	integer	yes	—
`is_active`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`paymentMethodID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`payment_method_id`	integer	yes	—

Payment Methods — 12 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"e4361be6-1247-4da5-8fdf-cafa763361ce","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Pick Routines","item":[{"name":"Pick routines list","id":"97d9a383-e95e-4016-afa3-755fc9bd3e9b","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//pick-routines","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filter[]`	—
`sort`	—
`includes_count`	—
`query`	Filter by Query.
`name`	Filter by Name.
`status`	Filter by Status.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

settings
templates
templates.assignedUsers
templates.assignedUsers.user
templates.assignedUsers.user.fileManager
templates.filterGroups
templates.filterGroups.filters
filterGroups
filterGroups.filters
tags.tag

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - settings - templates - templates.assignedUsers - templates.assignedUsers.user - templates.assignedUsers.user.fileManager - templates.filterGroups - templates.filterGroups.filters - filterGroups - filterGroups.filters - tags.tag

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"97d9a383-e95e-4016-afa3-755fc9bd3e9b"},{"name":"Pick routines create","id":"c834c80a-91a6-4b63-9f36-c573a72b893f","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"name\",\n \"pick_type\": \"1\",\n \"order_filters\": [\n \"\"\n ],\n \"settings\": {\n \"multi_location_pick_type\": \"1\",\n \"order_status_filter\": [\n \"\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//pick-routines","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string	yes	—
`pick_type`	string	yes	Allowed: `1`, `2`, `3`
`order_filters`	array \| null	no	—
`settings`	object	yes	—
`settings.multi_location_pick_type`	string	yes	Allowed: `1`, `2`, `3`
`settings.order_status_filter`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickRoutineID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`status`	boolean \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickRoutineID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`order_filters`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickRoutineID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`order_filters`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickRoutineID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

settings
templates
templates.assignedUsers
templates.assignedUsers.user
templates.assignedUsers.user.fileManager
templates.filterGroups
templates.filterGroups.filters
filterGroups
filterGroups.filters
tags.tag

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"f2faf4bc-d124-4e2e-8013-b117c996266f","type":"any","value":"","key":"pickRoutineID"}]}},"response":[],"_postman_id":"ddc29c00-400d-4ee9-85ee-1aab6e58a80a"},{"name":"Pick routines update","id":"9c49913f-4cbb-451e-b8d9-2da2312138e8","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"settings\": [\n \"\"\n ],\n \"order_filters\": [\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//pick-routines/:pickRoutineID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickRoutineID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string \| null	no	—
`settings`	array \| null	no	—
`order_filters`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickRoutineID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filter[]`	—
`search`	Filter by Search.
`pick_id`	Filter by Pick Id.

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Search.

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

Filter by Pick Id.

\n","type":"text/plain"},"key":"pick_id","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"bb59ea05-001b-4ab4-9731-9c47764c2ec0"},{"name":"Pick routines tags attached index","id":"0bd84bea-6240-4966-81f6-df71fc7301de","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//pick-routines/attached-tags","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`pick_routine_ids[]`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickRoutineID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickRoutineID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickRoutineID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`tag_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickRoutineID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`tag_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickRoutineID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`sort`	string	no	—
`templates`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickRoutineID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`templates`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickRoutineID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filter[]`	—
`sort`	—
`includes_count`	—
`pick_routine_id`	Filter by Pick Routine Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

assignedUsers
assignedUsers.user
assignedUsers.user.fileManager
filterGroups
filterGroups.filters

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Pick Routine Id.

\n","type":"text/plain"},"key":"pick_routine_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - assignedUsers - assignedUsers.user - assignedUsers.user.fileManager - filterGroups - filterGroups.filters

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"4b3269d7-e093-4ae3-b60d-a6826aca12b8","type":"any","value":"","key":"pickRoutineID"}]}},"response":[],"_postman_id":"82b5c0e4-1652-4395-97bd-c06b51a3e9d3"},{"name":"Pick routines templates create","id":"abc01752-5c6d-48e7-a0f7-294767ab5b7d","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"name\",\n \"split_picks\": false,\n \"split_per_zone\": false,\n \"maximum_lines\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//pick-routines/:pickRoutineID/templates","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickRoutineID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string	yes	—
`split_picks`	boolean \| null	no	—
`split_per_zone`	boolean \| null	no	—
`maximum_lines`	integer \| null	no	Mutually exclusive with maximum_units and maximum_orders.
`maximum_units`	integer \| null	no	Mutually exclusive with maximum_lines and maximum_orders.
`maximum_orders`	integer \| null	no	Mutually exclusive with maximum_lines and maximum_units.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`pickRoutineID`	integer	yes
`pickRoutineTemplateID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

assignedUsers
assignedUsers.user
assignedUsers.user.fileManager
filterGroups
filterGroups.filters

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"c4a5c8cc-a62f-49df-a60d-d88eb3ab6c81","type":"any","value":"","key":"pickRoutineID"},{"id":"238a7dcd-d149-4bb6-9564-d3f6df67adde","type":"any","value":"","key":"pickRoutineTemplateID"}]}},"response":[],"_postman_id":"3bf9afff-fef3-4c66-b8a6-cc5fbfce24ed"},{"name":"Pick routines templates update","id":"48b2b90e-e2d4-4631-a6f9-fddbe6edc4a2","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"split_picks\": false,\n \"split_per_zone\": false,\n \"maximum_lines\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//pick-routines/:pickRoutineID/templates/:pickRoutineTemplateID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`pickRoutineID`	integer	yes
`pickRoutineTemplateID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string \| null	no	—
`split_picks`	boolean \| null	no	—
`split_per_zone`	boolean \| null	no	—
`maximum_lines`	integer \| null	no	Mutually exclusive with maximum_units and maximum_orders.
`maximum_units`	integer \| null	no	Mutually exclusive with maximum_lines and maximum_orders.
`maximum_orders`	integer \| null	no	Mutually exclusive with maximum_lines and maximum_units.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`pickRoutineID`	integer	yes
`pickRoutineTemplateID`	integer	yes

Pick Routines — 21 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"d11d59a0-fa82-4618-b4da-30eab357e909","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Pick Tags","item":[{"name":"Pick tags list","id":"0640e354-597a-4d78-a969-8afc5e9d535d","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//pick-tags","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`search`	Filter by Search.
`pick_id`	Filter by Pick Id.

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Search.

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

Filter by Pick Id.

\n","type":"text/plain"},"key":"pick_id","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"0640e354-597a-4d78-a969-8afc5e9d535d"},{"name":"Pick tags bulk attach","id":"aab4f082-e737-4b46-ade8-02e4a7fef455","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"items\": [\n {\n \"pick_id\": \"{{pick_id}}\",\n \"tag_name\": \"tag_name\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//pick-tags/bulk-attach","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`items`	array	yes	—
`items.*.pick_id`	integer	yes	—
`items.*.tag_name`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`items`	array	yes	—
`items.*.pick_id`	integer	yes	—
`items.*.tag_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`pick_ids[]`	—

Pick Tags — 4 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"35f4f892-266b-4b22-bbb9-148bfca3e7d4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Pick Transactions","item":[{"name":"Pick transactions list","id":"fd0a278c-5f30-4fb5-bd08-331d69c1df79","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//pick-transactions","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filter[]`	—
`sort`	—
`includes_count`	—
`status`	Filter by Status.
`skipped`	Filter by Skipped.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

logs

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Skipped.

\n","type":"text/plain"},"key":"skipped","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - logs

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"fd0a278c-5f30-4fb5-bd08-331d69c1df79"},{"name":"Pick transactions show","id":"35ff905c-616f-40a2-816b-c1f8c9a2cf6f","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//pick-transactions/:pickTransactionID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickTransactionID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickTransactionID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filter[]`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickTransactionID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickTransactionID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickTransactionID`	integer	yes

Pick Transactions — 6 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"1ea9af7b-9127-42e7-aba0-6a2ab90f286d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Picks","item":[{"name":"Picks bulk update","id":"c7ca769e-7f35-4333-978f-737f77cac3c9","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"picks\": [\n {\n \"id\": \"{{id}}\",\n \"name\": \"\",\n \"is_hold\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//picks/bulk-update","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`picks`	array	yes	—
`picks.*.id`	integer	yes	—
`picks.*.name`	string \| null	no	—
`picks.*.is_hold`	boolean \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`pick_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`pick_ids`	array	yes	—

Unlike POST /picks — which selects orders by filter and queues the work,\nreporting only a pick transaction — this creates the pick inline for a\nsingle order and returns it, so a terminal can go straight on to\ncompleting it. Every line you list is allocated from the location you name\n(422 if that location cannot cover it); any remaining line of the order is\nallocated by the normal stock-selection rules. The pick comes back in\nREADY_FOR_PICK with its items, whose ids drive completion — either\nPATCH /picks/{pick_id}/items/bulk-update-picked-quantity to send it to the\nwarehouse's configured Picked location in one call, or\nbulk-update-action-quantity followed by POST /picks/{pick_id}/publish to\nchoose a different goods-out location.

Use GET /picks/for-order/available-locations first to discover which\nlocations each line can be picked from.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`order_id`	integer	yes	—
`name`	string \| null	no	—
`tags`	array \| null	no	—
`settings`	object	no	Same shape as POST /picks (Pick\\StoreRequest), minus the members that only describe how to FIND orders. Both are optional here because the caller already named the order and its locations.
`settings.multi_location_pick_type`	string \| null	no	Allowed: `1`, `2`, `3`
`settings.assigned_users`	array \| null	no	—
`items`	array	yes	—
`items.*.order_item_id`	integer	yes	—
`items.*.location_id`	integer	yes	—

The companion lookup for POST /picks/for-order, which requires a\nlocation_id per line: this applies the same eligibility rules the create\nenforces (pickable storage type, enough stock net of other picks'\nreservations, staging locations excluded), so a location listed here is\none the create accepts. Unlike the per-pick-item available-locations\naction it needs no existing pick.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`order_id`	—
`search`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

Parameter	Description
`filter[]`	—
`sort`	—
`includes_count`	—
`query`	Filter by Query.
`inventory_name`	Filter by Inventory Name.
`tag_id`	Filter by Tag Id.
`inventory_code`	Filter by Inventory Code.
`pick_type`	Filter by Pick Type.
`order_number`	Filter by Order Number.
`tote`	Filter by Tote.
`location_id`	Filter by Location Id.
`zone_id`	Filter by Zone Id.
`status`	Filter by Status.
`assigned_user_id`	Filter by Assigned User Id.
`assigned_user_date_from`	Filter by Assigned User Date From.
`assigned_user_date_to`	Filter by Assigned User Date To.
`created_at_from`	Filter by Created At From.
`created_at_to`	Filter by Created At To.
`archived`	Filter by Archived.
`items_count_from`	Filter by Items Count From.
`items_count_to`	Filter by Items Count To.
`lines_count_from`	Filter by Lines Count From.
`lines_count_to`	Filter by Lines Count To.
`completed_at_from`	Filter by Completed At From.
`completed_at_to`	Filter by Completed At To.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

user
assignedUser
assignedUser.timeTracking
assignedUser.user
assignedUser.user.fileManager
assignedUsers
assignedUsers.timeTracking
assignedUsers.user
assignedUsers.user.fileManager
settings
tags.tag
items.order.channel.settings
inventory.meta
inventory.barcodes
items.orderItem
items.orderItem.options
items.location.zone
items.tote
items.items.order.pregeneratedShipment
items.items.order.pregeneratedShipment.shipmentFile
items.items.order.pregeneratedShipment.parcels
items.items.order.pregeneratedShipment.parcels.parcelFile
items.items.order.pregeneratedShipment.parcels.items
meta
inventory.batches

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Inventory Name.

\n","type":"text/plain"},"key":"inventory_name","value":""},{"disabled":true,"description":{"content":"

Filter by Tag Id.

\n","type":"text/plain"},"key":"tag_id","value":""},{"disabled":true,"description":{"content":"

Filter by Inventory Code.

\n","type":"text/plain"},"key":"inventory_code","value":""},{"disabled":true,"description":{"content":"

Filter by Pick Type.

\n","type":"text/plain"},"key":"pick_type","value":""},{"disabled":true,"description":{"content":"

Filter by Order Number.

\n","type":"text/plain"},"key":"order_number","value":""},{"disabled":true,"description":{"content":"

Filter by Tote.

\n","type":"text/plain"},"key":"tote","value":""},{"disabled":true,"description":{"content":"

Filter by Location Id.

\n","type":"text/plain"},"key":"location_id","value":""},{"disabled":true,"description":{"content":"

Filter by Zone Id.

\n","type":"text/plain"},"key":"zone_id","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Assigned User Id.

\n","type":"text/plain"},"key":"assigned_user_id","value":""},{"disabled":true,"description":{"content":"

Filter by Assigned User Date From.

\n","type":"text/plain"},"key":"assigned_user_date_from","value":""},{"disabled":true,"description":{"content":"

Filter by Assigned User Date To.

\n","type":"text/plain"},"key":"assigned_user_date_to","value":""},{"disabled":true,"description":{"content":"

Filter by Created At From.

\n","type":"text/plain"},"key":"created_at_from","value":""},{"disabled":true,"description":{"content":"

Filter by Created At To.

\n","type":"text/plain"},"key":"created_at_to","value":""},{"disabled":true,"description":{"content":"

Filter by Archived.

\n","type":"text/plain"},"key":"archived","value":""},{"disabled":true,"description":{"content":"

Filter by Items Count From.

\n","type":"text/plain"},"key":"items_count_from","value":""},{"disabled":true,"description":{"content":"

Filter by Items Count To.

\n","type":"text/plain"},"key":"items_count_to","value":""},{"disabled":true,"description":{"content":"

Filter by Lines Count From.

\n","type":"text/plain"},"key":"lines_count_from","value":""},{"disabled":true,"description":{"content":"

Filter by Lines Count To.

\n","type":"text/plain"},"key":"lines_count_to","value":""},{"disabled":true,"description":{"content":"

Filter by Completed At From.

\n","type":"text/plain"},"key":"completed_at_from","value":""},{"disabled":true,"description":{"content":"

Filter by Completed At To.

\n","type":"text/plain"},"key":"completed_at_to","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - user - assignedUser - assignedUser.timeTracking - assignedUser.user - assignedUser.user.fileManager - assignedUsers - assignedUsers.timeTracking - assignedUsers.user - assignedUsers.user.fileManager - settings - tags.tag - items.order.channel.settings - inventory.meta - inventory.barcodes - items.orderItem - items.orderItem.options - items.location.zone - items.tote - items.items.order.pregeneratedShipment - items.items.order.pregeneratedShipment.shipmentFile - items.items.order.pregeneratedShipment.parcels - items.items.order.pregeneratedShipment.parcels.parcelFile - items.items.order.pregeneratedShipment.parcels.items - meta - inventory.batches

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"c7bc65f6-1ca7-4707-a3f3-f04455fdf49c"},{"name":"Picks create","id":"51509c59-7b18-44ba-9aa1-868742be394e","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"pick_type\": \"1\",\n \"wait_for_pick\": false,\n \"filter_selection_type\": \"1\",\n \"order_filters\": [\n \"\"\n ],\n \"elastic_filters\": \"\",\n \"settings\": {\n \"multi_location_pick_type\": \"1\",\n \"assigned_users\": [\n 0\n ]\n },\n \"tags\": [\n \"\"\n ],\n \"elastic_ignore_ids\": [\n \"{{elastic_ignore_id}}\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//picks","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string \| null	no	—
`pick_type`	string	yes	Allowed: `1`, `2`, `3`
`wait_for_pick`	boolean \| null	no	—
`filter_selection_type`	string	yes	Allowed: `1`, `2`
`order_filters`	array \| null	no	—
`elastic_filters`	string \| null	no	—
`settings`	object	yes	—
`settings.multi_location_pick_type`	string	yes	Allowed: `1`, `2`, `3`
`settings.assigned_users`	array \| null	no	—
`tags`	array \| null	no	—
`elastic_ignore_ids`	array	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`picked_location_id`	integer	yes	—
`completion_status`	string \| null	no	CompletionStatus values: - `1` = PICKED - `2` = SORTING Allowed: `1`, `2`
`pick_item_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`pickID`	integer	yes
`orderID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

user
assignedUser
assignedUser.timeTracking
assignedUser.user
assignedUser.user.fileManager
assignedUsers
assignedUsers.timeTracking
assignedUsers.user
assignedUsers.user.fileManager
settings
tags.tag
items.order.channel.settings
inventory.meta
inventory.barcodes
items.orderItem
items.orderItem.options
items.location.zone
items.tote
items.items.order.pregeneratedShipment
items.items.order.pregeneratedShipment.shipmentFile
items.items.order.pregeneratedShipment.parcels
items.items.order.pregeneratedShipment.parcels.parcelFile
items.items.order.pregeneratedShipment.parcels.items
meta
inventory.batches

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"a39a6fff-3e28-4dfb-ad0d-af8fa4efaeff","type":"any","value":"","key":"pickID"}]}},"response":[],"_postman_id":"1d5b0dc5-fa13-48d2-b37c-60c00bf87ca8"},{"name":"Picks update","id":"8be3d217-56d7-43b4-954b-38f9fec6874a","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"is_hold\": false,\n \"assigned_device_name\": \"\",\n \"assigned_device_id\": \"{{assigned_device_id}}\",\n \"items\": [\n {\n \"id\": \"{{id}}\",\n \"location_id\": \"{{location_id}}\",\n \"quantity\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//picks/:pickID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string \| null	no	—
`is_hold`	boolean \| null	no	—
`assigned_device_name`	string \| null	no	—
`assigned_device_id`	string \| null	no	—
`items`	array \| null	no	—
`items.*.id`	integer	yes	—
`items.*.location_id`	integer \| null	no	—
`items.*.quantity`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filter[]`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`picked_location_id`	integer	yes	—
`completion_status`	string \| null	no	CompletionStatus values: - `1` = PICKED - `2` = SORTING Allowed: `1`, `2`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`items`	array	yes	—
`items.*.id`	integer	yes	—
`items.*.quantity`	integer \| null	no	—
`items.*.location_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`picked_location_id`	integer \| null	no	—
`items`	array	yes	—
`items.*.pick_item_id`	integer	yes	—
`items.*.picked_quantity`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`items`	array	yes	—
`items.*.id`	integer	yes	—
`items.*.action_quantity`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`items`	array	yes	—
`items.*.id`	integer	yes	—
`items.*.location_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filter[]`	—
`sort`	—
`includes_count`	—
`pick_id`	Filter by Pick Id.
`events`	Filter by Events.
`inventory_name`	Filter by Inventory Name.
`inventory_code`	Filter by Inventory Code.
`tote`	Filter by Tote.
`tote_barcode`	Filter by Tote Barcode.
`location_id`	Filter by Location Id.
`zone_id`	Filter by Zone Id.
`order_number`	Filter by Order Number.
`picked_quantity_to`	Filter by Picked Quantity To.
`pickable`	Filter by Pickable.
`assigned_user`	Filter by Assigned User.
`picked_quantity_from`	Filter by Picked Quantity From.
`status`	Filter by Status.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

location
location.zone
zone
tote
items
items.order
items.order.channel
items.order.channel.settings
items.orderItem
inventory
inventory.meta
inventory.settings
events
events.user
inventory.barcodes
inventory.batches
items.orderItem.options
items.order.pregeneratedShipment
items.order.pregeneratedShipment.shipmentFile
items.order.pregeneratedShipment.parcels
items.order.pregeneratedShipment.parcels.parcelFile
items.order.pregeneratedShipment.parcels.items
batch

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Pick Id.

\n","type":"text/plain"},"key":"pick_id","value":""},{"disabled":true,"description":{"content":"

Filter by Events.

\n","type":"text/plain"},"key":"events","value":""},{"disabled":true,"description":{"content":"

Filter by Inventory Name.

\n","type":"text/plain"},"key":"inventory_name","value":""},{"disabled":true,"description":{"content":"

Filter by Inventory Code.

\n","type":"text/plain"},"key":"inventory_code","value":""},{"disabled":true,"description":{"content":"

Filter by Tote.

\n","type":"text/plain"},"key":"tote","value":""},{"disabled":true,"description":{"content":"

Filter by Tote Barcode.

\n","type":"text/plain"},"key":"tote_barcode","value":""},{"disabled":true,"description":{"content":"

Filter by Location Id.

\n","type":"text/plain"},"key":"location_id","value":""},{"disabled":true,"description":{"content":"

Filter by Zone Id.

\n","type":"text/plain"},"key":"zone_id","value":""},{"disabled":true,"description":{"content":"

Filter by Order Number.

\n","type":"text/plain"},"key":"order_number","value":""},{"disabled":true,"description":{"content":"

Filter by Picked Quantity To.

\n","type":"text/plain"},"key":"picked_quantity_to","value":""},{"disabled":true,"description":{"content":"

Filter by Pickable.

\n","type":"text/plain"},"key":"pickable","value":""},{"disabled":true,"description":{"content":"

Filter by Assigned User.

\n","type":"text/plain"},"key":"assigned_user","value":""},{"disabled":true,"description":{"content":"

Filter by Picked Quantity From.

\n","type":"text/plain"},"key":"picked_quantity_from","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - location - location.zone - zone - tote - items - items.order - items.order.channel - items.order.channel.settings - items.orderItem - inventory - inventory.meta - inventory.settings - events - events.user - inventory.barcodes - inventory.batches - items.orderItem.options - items.order.pregeneratedShipment - items.order.pregeneratedShipment.shipmentFile - items.order.pregeneratedShipment.parcels - items.order.pregeneratedShipment.parcels.parcelFile - items.order.pregeneratedShipment.parcels.items - batch

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"15bc27d5-1654-481e-8d1b-a6ec408bcdfa","type":"any","value":"","key":"pickID"}]}},"response":[],"_postman_id":"f6473dc9-8ad0-4a5d-a12c-97da4fbf4aa3"},{"name":"Picks items update","id":"498dbc2c-7a1f-49c1-bc65-9c79c85d457c","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"quantity\": 0,\n \"location_id\": \"{{location_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//picks/:pickID/items/:pickItemID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`pickID`	integer	yes
`pickItemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`quantity`	integer \| null	no	—
`location_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`pickID`	integer	yes
`pickItemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`quantity`	integer	yes	—
`location_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`pickID`	integer	yes
`pickItemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`action_quantity`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`pickID`	integer	yes
`pickItemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`location_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`ids[]`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`assigned_users`	array \| null	no	—
`items`	array	yes	—
`items.*.pick_order_item_id`	integer	yes	—
`items.*.quantity`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`pickID`	integer	yes
`pickItemID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`pickID`	integer	yes
`pickItemID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`search`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`pickID`	integer	yes
`pickItemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`quantity`	number	yes	—
`location_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`pickID`	integer	yes
`pickItemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`skip_type`	string	yes	Allowed: `1`, `2`
`set_zero_quantity`	boolean \| null	no	—
`reason`	string \| null	no	Allowed: `1`, `2`
`is_skipped_before`	boolean \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`pickID`	integer	yes
`pickItemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`reason`	string \| null	no	Allowed: `1`, `2`
`location_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`tag_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`tag_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filter[]`	—
`sort`	—
`includes_count`	—
`pick_id`	Filter by Pick Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

timeTracking
user
user.fileManager

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Pick Id.

\n","type":"text/plain"},"key":"pick_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - timeTracking - user - user.fileManager

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"7e328d7c-65cc-495a-ad16-224123d55fac","type":"any","value":"","key":"pickID"}]}},"response":[],"_postman_id":"1e75365f-b0d0-4fad-bd19-07a16ce85a18"},{"name":"Picks users update","id":"376e63e5-5066-4d29-8f4e-af2c60fd41c4","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"{{user_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//picks/:pickID/users","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`user_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`pickID`	integer	yes
`userID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

timeTracking
user
user.fileManager

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - timeTracking - user - user.fileManager

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"2efd41f9-3ea5-49ef-bc64-5b11ba1510bd","type":"any","value":"","key":"pickID"},{"id":"70cbf26e-ab51-4c92-afc9-049681af4476","type":"any","value":"","key":"userID"}]}},"response":[],"_postman_id":"dd2ac0de-107b-4435-b799-e8cb8e844260"},{"name":"Picks time tracking start","id":"b9c955f7-a0a8-4239-b6ca-001c0afd10f4","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//picks/:pickID/time-tracking/start","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`barcode`	—
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations vary per endpoint.

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"d0f6660e-d6c8-4a5f-a083-1c9ac9cc2724"},{"name":"Picks totes list","id":"1cf1622d-9cc4-4572-8e82-cfa36ef7516e","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//picks/:pickID/totes","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`pickID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`filter[]`	—
`sort`	—
`includes_count`	—
`pick_id`	Filter by Pick Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Pick Id.

\n","type":"text/plain"},"key":"pick_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations vary per endpoint.

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"bdf55e73-e93c-4628-b336-863e7c7a13c6","type":"any","value":"","key":"pickID"}]}},"response":[],"_postman_id":"1cf1622d-9cc4-4572-8e82-cfa36ef7516e"},{"name":"Picks totes update","id":"fb7115bb-1646-492b-9b0a-d4d5a672cff5","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"barcode\": \"barcode\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//picks/:pickID/totes/:toteID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`pickID`	integer	yes
`toteID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`barcode`	string	yes	—

Picks — 45 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"bfdb6dbf-6c91-4c00-8c0e-bc8b148b61d4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Ping","item":[{"name":"Ping","id":"b7dcbc71-4851-404f-aa93-9ccaa76cd65c","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/ping","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`company_id`	string	yes

Ping — 2 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"65747a95-b35e-4819-937a-ab0199b4e36f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Print Templates","item":[{"name":"Print templates list","id":"9c7e91e5-c5cd-4ecd-a469-38b8bc564b61","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//print-templates","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`name`	Filter by Name.
`type`	Filter by Type.
`size`	Filter by Size.
`format`	Filter by Format.
`status`	Filter by Status.
`tags`	Filter by Tags.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Type.

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

Filter by Size.

\n","type":"text/plain"},"key":"size","value":""},{"disabled":true,"description":{"content":"

Filter by Format.

\n","type":"text/plain"},"key":"format","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Tags.

\n","type":"text/plain"},"key":"tags","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"9c7e91e5-c5cd-4ecd-a469-38b8bc564b61"},{"name":"Print templates create","id":"48041d36-1d4d-4a33-957f-9fe8e0bc8baf","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"name\": \"name\",\n \"format\": \"1\",\n \"type\": \"1\",\n \"size\": \"1\",\n \"url\": \"url\",\n \"is_default\": false,\n \"auto_print_gift_note\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//print-templates","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`format`	string	yes	EMailTemplateFormats values: - `1` = HTML - `2` = EDITOR Allowed: `1`, `2`
`type`	string	yes	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`
`size`	string	yes	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`
`url`	string	yes	—
`is_default`	boolean \| null	no	—
`auto_print_gift_note`	boolean	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`printTemplateID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`printTemplateID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`print_template_id`	integer	yes	—
`name`	string	yes	—
`format`	string	yes	EMailTemplateFormats values: - `1` = HTML - `2` = EDITOR Allowed: `1`, `2`
`type`	string	yes	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`
`size`	string	yes	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`
`file_manager_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`printTemplateID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`print_template_id`	integer	yes	—
`name`	string	yes	—
`format`	string	yes	EMailTemplateFormats values: - `1` = HTML - `2` = EDITOR Allowed: `1`, `2`
`type`	string	yes	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`
`size`	string	yes	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`
`file_manager_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`printTemplateID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`print_template_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`print_template_id`	string	yes	—
`data_id`	string	yes	—
`data_type`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`
`is_download`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	string	yes	—
`is_download`	boolean \| null	no	—
`document_types`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`printTemplateID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`print_template_id`	integer	yes	—
`saveUrl`	string	yes	—
`templateUrl`	string	no	—
`width`	number	yes	—
`height`	number	yes	—
`previewUrl`	string	no	—
`isDraft`	boolean \| null	no	—
`dontSave`	boolean \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`printTemplateID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`print_template_id`	string	yes	—
`company_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`printTemplateID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`print_template_id`	—
`company_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`printTemplateID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`print_template_id`	string	yes	—
`name`	string	yes	—
`company_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`printTemplateID`	integer	yes
`tagID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`tag_id`	integer	yes	—
`company_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`printTemplateID`	integer	yes
`tagID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`tag_id`	integer	yes	—
`company_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`printTemplateID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`print_template_id`	—
`company_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`printTemplateID`	integer	yes
`recordID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`print_template_id`	—
`is_pdf`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`printTemplateID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`print_template_id`	—
`company_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`printTemplateID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`print_template_id`	string	yes	—
`type`	string	yes	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`
`is_auto_print_gift_note`	boolean	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`printTemplateID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`print_template_id`	string	yes	—

Print Templates — 22 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"88a5cdf6-cf42-4267-9666-a669737d511a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Printing Queues","item":[{"name":"Printing queues printed order documents","id":"0b11bbfb-5dad-43ad-878e-d15337d2b221","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//printing-queues/printed-order-documents/:orderID?company_id=&order_id=","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`orderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`order_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`id`	Filter by Id.
`name`	Filter by Name.
`user_id`	Filter by User Id.
`order_id`	Filter by Order Id.
`date_from`	Filter by Date From.
`date_to`	Filter by Date To.
`pages_from`	Filter by Pages From.
`pages_to`	Filter by Pages To.
`status`	Filter by Status.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

user
printTemplate
fileManager

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by User Id.

\n","type":"text/plain"},"key":"user_id","value":""},{"disabled":true,"description":{"content":"

Filter by Order Id.

\n","type":"text/plain"},"key":"order_id","value":""},{"disabled":true,"description":{"content":"

Filter by Date From.

\n","type":"text/plain"},"key":"date_from","value":""},{"disabled":true,"description":{"content":"

Filter by Date To.

\n","type":"text/plain"},"key":"date_to","value":""},{"disabled":true,"description":{"content":"

Filter by Pages From.

\n","type":"text/plain"},"key":"pages_from","value":""},{"disabled":true,"description":{"content":"

Filter by Pages To.

\n","type":"text/plain"},"key":"pages_to","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - user - printTemplate - fileManager

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"1865569d-9903-44b4-a9c7-3299c914fe9f"},{"name":"Printing queues create","id":"6e003edc-e855-4c37-8f73-a1d7dfe95558","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"name\": \"name\",\n \"pages\": 1,\n \"print_template_id\": \"{{print_template_id}}\",\n \"print_reference\": \"\",\n \"record_id\": \"{{record_id}}\",\n \"bulk_action_id\": \"{{bulk_action_id}}\",\n \"type\": \"1\",\n \"file_manager_id\": \"{{file_manager_id}}\",\n \"printed_pdf_url\": \"\",\n \"document_type\": \"1\",\n \"document_size\": \"1\",\n \"attributes\": [\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//printing-queues","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`pages`	number	yes	—
`print_template_id`	integer \| null	no	—
`print_reference`	string \| null	no	—
`record_id`	string \| null	no	—
`bulk_action_id`	integer \| null	no	—
`type`	string	yes	Allowed: `1`, `2`, `3`
`file_manager_id`	integer \| null	no	—
`printed_pdf_url`	string	no	—
`document_type`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`
`document_size`	string \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`
`attributes`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`printingQueueID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`printing_queue_id`	integer	yes	—
`status`	string	yes	Allowed: `0`, `1`, `2`, `3`, `4`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`printingQueueID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`printing_queue_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`printingQueueID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`printing_queue_id`	—

Printing Queues — 6 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"290cb39b-c57f-4c95-9061-74298cde9321","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Profile","item":[{"name":"Profile show","id":"f85c1c05-fb8f-4ed1-8a4a-a527b1d00257","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/profile/:user_id","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`user_id`	string	yes	Optional

Profile — 1 endpoint.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"1852a027-159b-4ff8-a097-b2665dba93ee","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Purchase Orders","item":[{"name":"Purchase orders types","id":"1d36b011-f20a-45d0-b744-116f3cd7471a","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//purchase-orders/types","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Marks a Purchase Order as Sent (the v2 public equivalent of the UI \"Mark as Sent\" / v1 send-to-supplier action).

Requires the purchase-orders:write ability and the purchase_order.send_to_supplier role permission. Auth is a bearer token; the X-App-Token header is also accepted (same handling as v1).

With send_email = false the endpoint only flips the status (fulfillment case — the email was already sent externally). With send_email = true v7 also emails the supplier (template + PO PDF + optional CC). Success returns 204 No Content; validation/tenant errors return application/problem+json (422).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes	Must belong to the company; must be a sendable status (DRAFT when `send_email=false`; DRAFT or SENT when `send_email=true`) and have at least one item

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—
`send_email`	boolean	yes	`false` = mark as sent only; `true` = also email the supplier
`email_template_id`	integer	required if `send_email=true`	Company email template id (ignored when `send_email=false`)
`import_excel`	boolean	required if `send_email=true`	Attach the PO items Excel export (ignored when `send_email=false`)
`subject`	string	required if `send_email=true`	Max 255 chars (ignored when `send_email=false`)
`emails`	string[]	required if `send_email=true`	Recipient emails; min 1 (ignored when `send_email=false`)
`cc`	string[]	no	CC emails (ignored when `send_email=false`)

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`archived`	Filter by Archived.
`import_ids`	Filter by Import Ids.
`query`	Filter by Query.
`id`	Filter by Id.
`purchase_order_number`	Filter by Purchase Order Number.
`supplier_id`	Filter by Supplier Id.
`status`	Filter by Status.
`delivery_status`	Filter by Delivery Status.
`delivery_reference`	Filter by Delivery Reference.
`expected_delivery_date_from`	Filter by Expected Delivery Date From.
`expected_delivery_date_to`	Filter by Expected Delivery Date To.
`tags`	Filter by Tags.
`product_code`	Filter by Product Code.
`inventory_id`	Filter by Inventory Id.
`order_value_from`	Filter by Order Value From.
`order_value_to`	Filter by Order Value To.
`item_qty_from`	Filter by Item Qty From.
`item_qty_to`	Filter by Item Qty To.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

owner
items
deliveries
items.deliveryItems
items.inventory
items.inventory.meta
items.inventory.containers
items.inventory.barcodes
shippingAddress
shippingAddress.address
invoiceAddress
invoiceAddress.address
supplier
supplier.contact
supplier.fileManager
supplier.registrationDetails
supplier.purchasingSettings
supplier.purchasingSettings.currency
tags.tag
currency
payment
refund
timeline
customFields
customFields.customFieldOption

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Archived.

\n","type":"text/plain"},"key":"archived","value":""},{"disabled":true,"description":{"content":"

Filter by Import Ids.

\n","type":"text/plain"},"key":"import_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Purchase Order Number.

\n","type":"text/plain"},"key":"purchase_order_number","value":""},{"disabled":true,"description":{"content":"

Filter by Supplier Id.

\n","type":"text/plain"},"key":"supplier_id","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Delivery Status.

\n","type":"text/plain"},"key":"delivery_status","value":""},{"disabled":true,"description":{"content":"

Filter by Delivery Reference.

\n","type":"text/plain"},"key":"delivery_reference","value":""},{"disabled":true,"description":{"content":"

Filter by Expected Delivery Date From.

\n","type":"text/plain"},"key":"expected_delivery_date_from","value":""},{"disabled":true,"description":{"content":"

Filter by Expected Delivery Date To.

\n","type":"text/plain"},"key":"expected_delivery_date_to","value":""},{"disabled":true,"description":{"content":"

Filter by Tags.

\n","type":"text/plain"},"key":"tags","value":""},{"disabled":true,"description":{"content":"

Filter by Product Code.

\n","type":"text/plain"},"key":"product_code","value":""},{"disabled":true,"description":{"content":"

Filter by Inventory Id.

\n","type":"text/plain"},"key":"inventory_id","value":""},{"disabled":true,"description":{"content":"

Filter by Order Value From.

\n","type":"text/plain"},"key":"order_value_from","value":""},{"disabled":true,"description":{"content":"

Filter by Order Value To.

\n","type":"text/plain"},"key":"order_value_to","value":""},{"disabled":true,"description":{"content":"

Filter by Item Qty From.

\n","type":"text/plain"},"key":"item_qty_from","value":""},{"disabled":true,"description":{"content":"

Filter by Item Qty To.

\n","type":"text/plain"},"key":"item_qty_to","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - owner - items - deliveries - items.deliveryItems - items.inventory - items.inventory.meta - items.inventory.containers - items.inventory.barcodes - shippingAddress - shippingAddress.address - invoiceAddress - invoiceAddress.address - supplier - supplier.contact - supplier.fileManager - supplier.registrationDetails - supplier.purchasingSettings - supplier.purchasingSettings.currency - tags.tag - currency - payment - refund - timeline - customFields - customFields.customFieldOption

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"5ebb559a-56fb-4cc0-bdb2-af4209b5348e"},{"name":"Create a purchase order","id":"49fb9a19-0976-4e85-ab5e-afe78f1172f6","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"1\",\n \"priority_supplier_only\": false,\n \"supplier_id\": \"{{supplier_id}}\",\n \"delivery_note\": \"\",\n \"expected_delivery_date\": \"expected_delivery_date\",\n \"vendor_invoice_number\": \"\",\n \"vendor_shipment_number\": \"\",\n \"totals\": {\n \"discount\": 0\n },\n \"shipping_address\": {\n \"use_in_for_invoice\": false,\n \"address_line_1\": \"\",\n \"city\": \"\",\n \"country_id\": \"{{country_id}}\"\n },\n \"invoice_address\": {\n \"address_line_1\": \"\",\n \"city\": \"\",\n \"country_id\": \"{{country_id}}\"\n },\n \"items\": [\n {\n \"inventory_id\": \"{{inventory_id}}\",\n \"discount\": 0,\n \"unit_price\": 1,\n \"item_qty\": 1,\n \"tax_rate\": 0,\n \"note\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//purchase-orders","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`type`	string	yes	Allowed: `1`, `2`, `3`
`priority_supplier_only`	boolean	no	—
`supplier_id`	integer	yes	—
`delivery_note`	string \| null	no	—
`excepted_delivery_date`	string	yes	—
`vendor_invoice_number`	string \| null	no	—
`vendor_shipment_number`	string \| null	no	—
`totals`	object	no	—
`totals.discount`	number \| null	no	—
`shipping_address`	object	no	—
`shipping_address.use_in_for_invoice`	boolean	no	—
`shipping_address.address_line_1`	string	no	—
`shipping_address.city`	string	no	—
`shipping_address.country_id`	integer	no	—
`invoice_address`	object	no	—
`invoice_address.address_line_1`	string	no	—
`invoice_address.city`	string	no	—
`invoice_address.country_id`	integer	no	—
`items`	array	no	—
`items.*.inventory_id`	string	yes	—
`items.*.discount`	number	yes	—
`items.*.unit_price`	number	yes	—
`items.*.item_qty`	number	yes	—
`items.*.tax_rate`	number \| null	no	—
`items.*.note`	string \| null	no	—

The delivery date may be sent as expected_delivery_date, which matches\nthe purchase_orders column it is stored in, or as the misspelt\nexcepted_delivery_date this endpoint originally required. At least one is\nneeded. Existing integrations need no change: the misspelling is unchanged\nin every respect, and it is the one used if both are sent.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`type`	string	yes	Allowed: `1`, `2`, `3`
`priority_supplier_only`	boolean	no	—
`supplier_id`	integer	yes	—
`delivery_note`	string \| null	no	—
`expected_delivery_date`	string	no	The date the order is expected to be delivered, matching the `purchase_orders` column it is stored in. Alias for the misspelt `excepted_delivery_date`; send at least one of the two. If both are sent, `excepted_delivery_date` is the one used.
`excepted_delivery_date`	string	no	The original, misspelt name for the delivery date, and still the canonical one: it is what validation reports against, and it wins if `expected_delivery_date` is also sent. Send at least one of the two.
`vendor_invoice_number`	string \| null	no	—
`vendor_shipment_number`	string \| null	no	—
`totals`	object	no	—
`shipping_address`	object	no	—
`invoice_address`	object	no	—
`items`	array	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

owner
items
deliveries
items.deliveryItems
items.inventory
items.inventory.meta
items.inventory.containers
items.inventory.barcodes
shippingAddress
shippingAddress.address
invoiceAddress
invoiceAddress.address
supplier
supplier.contact
supplier.fileManager
supplier.registrationDetails
supplier.purchasingSettings
supplier.purchasingSettings.currency
tags.tag
currency
payment
refund
timeline
customFields
customFields.customFieldOption

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"7f90bec2-3d46-4d14-8395-1425e92cf982","type":"any","value":"","key":"purchaseOrderID"}]}},"response":[],"_postman_id":"629c898c-b80c-44f3-9799-81fc54a65497"},{"name":"Purchase orders delete","id":"b7d7cc65-17e4-4fc2-9a98-8e568f06d903","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//purchase-orders/:purchaseOrderID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`type`	Options: `1`, `2`, `3`
`priority_supplier_only`	—
`supplier_name`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`supplierID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`supplier_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`purchase_order_id`	—
`types[]`	Options: `1`, `2`, `3`, `4`
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

user
purchase_order

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - user - purchase_order

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"251254d0-7eae-43c2-881f-358c73399539","type":"any","value":"","key":"purchaseOrderID"}]}},"response":[],"_postman_id":"c11578ba-a8c2-4567-8cb4-9038196cfd35"},{"name":"Purchase orders un received delivery items","id":"d5d2f86c-3967-4ddc-893c-e4bef64d2b67","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//purchase-orders/:purchaseOrderID/un-received-delivery-items","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`includes`	string	no	—
`includes_count`	string	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—
`address_type`	integer	yes	Allowed: `1`, `2`
`use_in_for_invoice`	boolean	no	—
`address_id`	integer \| null	no	—
`company_name`	string \| null	no	—
`firstname`	string \| null	no	—
`lastname`	string \| null	no	—
`phone`	string \| null	no	—
`email`	string \| null	no	—
`address_line_1`	string	yes	—
`address_line_2`	string \| null	no	—
`address_line_3`	string \| null	no	—
`city`	string	yes	—
`county`	string \| null	no	—
`country_id`	integer	yes	—
`postcode`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—
`discount`	number	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—
`note`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—
`owner_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—
`date`	string	yes	—
`update_all_lines`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—
`vendor_invoice_number`	string \| null	no	—
`vendor_shipment_number`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—
`supplier_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[{"id":"0d4df0f1-2576-42d0-8f7f-8cff72bca3ff","type":"any","value":"","key":"purchaseOrderID"}]}},"response":[],"_postman_id":"6de748f7-527c-4f5c-b2f8-9b41204e5bf1"},{"name":"Purchase orders comments create","id":"9c07b509-9dd2-4c6c-bed4-56b28c3bcd73","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"purchase_order_id\": \"{{purchase_order_id}}\",\n \"content\": \"content\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//purchase-orders/:purchaseOrderID/comments","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—
`content`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`purchaseOrderID`	integer	yes
`purchaseOrderCommentID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—
`purchase_order_comment_id`	integer	yes	—
`content`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`purchaseOrderID`	integer	yes
`purchaseOrderCommentID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`purchase_order_id`	—
`purchase_order_comment_id`	—

NOT a supplier catalogue: it searches lines already committed to this\nsupplier's purchase orders, so it cannot say what is orderable from the\nsupplier in the first place. A line is returned only when its purchase\norder belongs to this company and supplier, has been sent (status = 2)\nand is not archived, and the line still expects stock (expected_qty > 0).

A search beginning PO- or po- is tried as an exact purchase-order\nnumber first; any other term, or one whose exact match found nothing, is\nmatched partially against the item code and item name. An empty data\narray therefore means no outstanding line matched, not that the supplier\nhas nothing to offer: a supplier with no sent purchase orders returns an\nempty list for every possible term.

The response is a plain list; it is not paginated.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`supplierID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?search=SKU-123).

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`search`	Optional. Filters by inventory code/name; a value starting with `PO-` matches the purchase-order number. Omit to list every open item for the supplier.

Optional. Filters by inventory code/name; a value starting with PO- matches the purchase-order number. Omit to list every open item for the supplier.

\n","type":"text/plain"},"key":"search","value":""}],"variable":[{"id":"c9645d95-a522-4dd8-8704-2595e6056cd9","type":"any","value":"","key":"supplierID"}]}},"response":[],"_postman_id":"cdae1bef-6478-4744-9cd0-fe8edefea90b"},{"name":"Purchase orders items get un received items","id":"4a8edb0d-3188-4355-8cdc-c466c1601a8e","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//purchase-orders/:purchaseOrderID/items/get-un-received-items","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`purchase_order_id`	Filter by Purchase Order Id.
`item_code`	Filter by Item Code.
`supplier_code`	Filter by Supplier Code.
`item_name`	Filter by Item Name.
`item_qty_from`	Filter by Item Qty From.
`item_qty_to`	Filter by Item Qty To.
`line_price_from`	Filter by Line Price From.
`line_price_to`	Filter by Line Price To.
`unit_price_from`	Filter by Unit Price From.
`unit_price_to`	Filter by Unit Price To.
`tax_group`	Filter by Tax Group.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Purchase Order Id.

\n","type":"text/plain"},"key":"purchase_order_id","value":""},{"disabled":true,"description":{"content":"

Filter by Item Code.

\n","type":"text/plain"},"key":"item_code","value":""},{"disabled":true,"description":{"content":"

Filter by Supplier Code.

\n","type":"text/plain"},"key":"supplier_code","value":""},{"disabled":true,"description":{"content":"

Filter by Item Name.

\n","type":"text/plain"},"key":"item_name","value":""},{"disabled":true,"description":{"content":"

Filter by Item Qty From.

\n","type":"text/plain"},"key":"item_qty_from","value":""},{"disabled":true,"description":{"content":"

Filter by Item Qty To.

\n","type":"text/plain"},"key":"item_qty_to","value":""},{"disabled":true,"description":{"content":"

Filter by Line Price From.

\n","type":"text/plain"},"key":"line_price_from","value":""},{"disabled":true,"description":{"content":"

Filter by Line Price To.

\n","type":"text/plain"},"key":"line_price_to","value":""},{"disabled":true,"description":{"content":"

Filter by Unit Price From.

\n","type":"text/plain"},"key":"unit_price_from","value":""},{"disabled":true,"description":{"content":"

Filter by Unit Price To.

\n","type":"text/plain"},"key":"unit_price_to","value":""},{"disabled":true,"description":{"content":"

Filter by Tax Group.

\n","type":"text/plain"},"key":"tax_group","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations vary per endpoint.

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"b6c6235b-d65e-4e10-88b4-f7577e7596c5","type":"any","value":"","key":"purchaseOrderID"}]}},"response":[],"_postman_id":"a0a4fe3f-506e-43ef-a645-d288093b2c17"},{"name":"Purchase orders items create","id":"f9c510f7-664c-4a50-9fc7-ce2e241b4a01","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"purchase_order_id\": \"{{purchase_order_id}}\",\n \"supplier_id\": \"{{supplier_id}}\",\n \"items\": [\n {\n \"inventory_id\": \"{{inventory_id}}\",\n \"item_qty\": 1,\n \"unit_price\": 0,\n \"discount\": 0,\n \"tax_rate\": 0,\n \"note\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//purchase-orders/:purchaseOrderID/items","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—
`supplier_id`	integer	yes	—
`items`	array	yes	—
`items.*.inventory_id`	integer	yes	—
`items.*.item_qty`	number	yes	—
`items.*.unit_price`	number \| null	no	—
`items.*.discount`	number \| null	no	—
`items.*.tax_rate`	number \| null	no	—
`items.*.note`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`purchaseOrderID`	integer	yes
`purchaseOrderItemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—
`purchase_order_item_id`	integer	yes	—
`item_qty`	number	yes	—
`tax_rate`	number \| null	no	—
`discount`	number \| null	no	—
`unit_price`	number \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`purchaseOrderID`	integer	yes
`purchaseOrderItemID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`purchase_order_id`	—
`purchase_order_item_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`purchaseOrderID`	integer	yes
`purchaseOrderItemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—
`purchase_order_item_id`	integer	yes	—
`note`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`purchaseOrderID`	integer	yes
`purchaseOrderItemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—
`purchase_order_item_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`purchaseOrderID`	integer	yes
`purchaseOrderItemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—
`purchase_order_item_id`	integer	yes	—
`quantity`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`purchase_order_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`purchaseOrderID`	integer	yes
`paymentID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—
`payment_id`	integer	yes	—
`price`	number	yes	—
`invoice_number`	string \| null	no	—
`payment_reference`	string \| null	no	—
`additional_note`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`purchase_order_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`purchaseOrderID`	integer	yes
`refundID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—
`refund_id`	integer	yes	—
`price`	number	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`purchase_order_ids[]`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`purchase_order_id`	Filter by Purchase Order Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

company
purchaseOrder
tag

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Purchase Order Id.

\n","type":"text/plain"},"key":"purchase_order_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - company - purchaseOrder - tag

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"d95d2dbc-95ff-49df-843d-fcef45d39d26","type":"any","value":"","key":"purchaseOrderID"}]}},"response":[],"_postman_id":"689bed99-21af-4810-b6f5-ee2415e9fd3e"},{"name":"Purchase orders tags create","id":"a731d380-b4b7-44aa-9ba8-72af9fb52a4c","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"purchase_order_id\": \"{{purchase_order_id}}\",\n \"name\": \"name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//purchase-orders/:purchaseOrderID/tags","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`purchaseOrderID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—
`name`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`purchaseOrderID`	integer	yes
`tagID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—
`tag_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`purchaseOrderID`	integer	yes
`tagID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`purchase_order_id`	integer	yes	—
`tag_id`	integer	yes	—

Purchase Orders — 46 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"a00a664e-62bf-468b-bec6-943cc3c2be1c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Reporting","item":[{"name":"Reporting types","id":"901a21b8-bfc7-42a1-bc0b-7dff747ad7a7","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//reporting/types","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`reportType`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`report_type`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`report_type`	integer	yes	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`
`grouping`	array \| null	no	—
`columns`	array \| null	no	—
`columns.*.field`	integer	yes	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`, `18`, `19`, `20`, `21`, `22`, `23`, `24`, `25`, `26`, `27`, `28`, `29`, `30`, `31`, `32`, `33`, `34`, `35`, `36`, `37`, `38`, `39`, `40`, `41`, `42`, `43`, `44`, `45`, `46`, `47`, `48`, `49`, `50`, `51`, `53`, `54`, `55`, `56`, `57`, `58`, `65`, `66`, `68`, `69`, `70`, `71`, `72`, `73`, `74`, `75`, `76`, `77`, `78`, `79`, `80`, `81`, `82`, `83`, `84`, `85`, `86`, `87`, `88`, `93`, `94`, `95`, `96`, `97`, `98`, `99`, `100`, `101`, `102`, `103`, `104`, `105`, `106`, `107`, `108`, `109`, `110`, `111`, `112`, `113`, `114`, `115`, `116`, `117`, `118`, `119`, `120`, `121`, `122`, `123`, `124`, `125`, `126`, `127`, `128`, `129`, `130`, `131`, `132`, `133`, `134`, `135`, `136`, `137`, `138`, `139`, `140`, `141`, `142`, `143`, `144`, `145`, `146`, `147`, `148`, `149`, `150`, `151`, `152`, `153`, `154`, `155`, `156`, `157`, `158`, `159`, `160`, `161`, `162`, `163`, `164`, `165`, `242`, `166`, `167`, `168`, `169`, `170`, `171`, `172`, `173`, `174`, `175`, `176`, `177`, `178`, `179`, `180`, `181`, `182`, `183`, `184`, `185`, `186`, `187`, `188`, `189`, `190`, `191`, `192`, `193`, `194`, `195`, `196`, `197`, `198`, `199`, `200`, `201`, `202`, `203`, `205`, `206`, `207`, `208`, `209`, `210`, `211`, `212`, `213`, `214`, `215`, `216`, `217`, `218`, `219`, `220`, `221`, `222`, `223`, `224`, `225`, `226`, `227`, `228`, `229`, `230`, `231`, `232`, `233`, `234`, `235`, `236`, `237`, `238`, `239`, `240`, `241`, `243`, `244`, `245`, `246`, `247`, `248`, `249`, `250`, `251`, `252`, `253`, `254`, `255`, `256`, `257`, `258`, `259`, `260`, `261`, `262`, `263`, `264`, `265`, `266`, `267`, `268`, `269`, `270`, `271`, `272`
`columns.*.calculations`	array	no	—
`columns.*.label`	string	no	—
`filters`	array \| null	no	—
`filters.*.field`	string	yes	—
`filters.*.operator`	integer	yes	A Mapper For OperatorTypes Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`
`filters.*.value`	string \| null	no	—
`sorting`	object	no	—
`sorting.field`	integer \| null	no	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`, `18`, `19`, `20`, `21`, `22`, `23`, `24`, `25`, `26`, `27`, `28`, `29`, `30`, `31`, `32`, `33`, `34`, `35`, `36`, `37`, `38`, `39`, `40`, `41`, `42`, `43`, `44`, `45`, `46`, `47`, `48`, `49`, `50`, `51`, `53`, `54`, `55`, `56`, `57`, `58`, `65`, `66`, `68`, `69`, `70`, `71`, `72`, `73`, `74`, `75`, `76`, `77`, `78`, `79`, `80`, `81`, `82`, `83`, `84`, `85`, `86`, `87`, `88`, `93`, `94`, `95`, `96`, `97`, `98`, `99`, `100`, `101`, `102`, `103`, `104`, `105`, `106`, `107`, `108`, `109`, `110`, `111`, `112`, `113`, `114`, `115`, `116`, `117`, `118`, `119`, `120`, `121`, `122`, `123`, `124`, `125`, `126`, `127`, `128`, `129`, `130`, `131`, `132`, `133`, `134`, `135`, `136`, `137`, `138`, `139`, `140`, `141`, `142`, `143`, `144`, `145`, `146`, `147`, `148`, `149`, `150`, `151`, `152`, `153`, `154`, `155`, `156`, `157`, `158`, `159`, `160`, `161`, `162`, `163`, `164`, `165`, `242`, `166`, `167`, `168`, `169`, `170`, `171`, `172`, `173`, `174`, `175`, `176`, `177`, `178`, `179`, `180`, `181`, `182`, `183`, `184`, `185`, `186`, `187`, `188`, `189`, `190`, `191`, `192`, `193`, `194`, `195`, `196`, `197`, `198`, `199`, `200`, `201`, `202`, `203`, `205`, `206`, `207`, `208`, `209`, `210`, `211`, `212`, `213`, `214`, `215`, `216`, `217`, `218`, `219`, `220`, `221`, `222`, `223`, `224`, `225`, `226`, `227`, `228`, `229`, `230`, `231`, `232`, `233`, `234`, `235`, `236`, `237`, `238`, `239`, `240`, `241`, `243`, `244`, `245`, `246`, `247`, `248`, `249`, `250`, `251`, `252`, `253`, `254`, `255`, `256`, `257`, `258`, `259`, `260`, `261`, `262`, `263`, `264`, `265`, `266`, `267`, `268`, `269`, `270`, `271`, `272`
`sorting.direction`	string \| null	no	Allowed: `asc`, `desc`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`user_scheduled`	Filter by User Scheduled.
`query`	Filter by Query.
`name`	Filter by Name.
`report_type`	Filter by Report Type.
`exclude_report_types`	Filter by Exclude Report Types.
`is_active`	Filter by Is Active.
`is_scheduled`	Filter by Is Scheduled.
`is_default`	Filter by Is Default.
`default_only`	Show only default reports (available to all companies)
`user_only`	Show only current user's own reports (exclude defaults)
`scheduled_only`	Show scheduled reports only
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

company
user
user.fileManager
histories
histories.count
latest_history

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by User Scheduled.

\n","type":"text/plain"},"key":"user_scheduled","value":""},{"disabled":true,"description":{"content":"

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Report Type.

\n","type":"text/plain"},"key":"report_type","value":""},{"disabled":true,"description":{"content":"

Filter by Exclude Report Types.

\n","type":"text/plain"},"key":"exclude_report_types","value":""},{"disabled":true,"description":{"content":"

Filter by Is Active.

\n","type":"text/plain"},"key":"is_active","value":""},{"disabled":true,"description":{"content":"

Filter by Is Scheduled.

\n","type":"text/plain"},"key":"is_scheduled","value":""},{"disabled":true,"description":{"content":"

Filter by Is Default.

\n","type":"text/plain"},"key":"is_default","value":""},{"disabled":true,"description":{"content":"

Show only default reports (available to all companies)

\n","type":"text/plain"},"key":"default_only","value":""},{"disabled":true,"description":{"content":"

Show only current user's own reports (exclude defaults)

\n","type":"text/plain"},"key":"user_only","value":""},{"disabled":true,"description":{"content":"

Show scheduled reports only

\n","type":"text/plain"},"key":"scheduled_only","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - company - user - user.fileManager - histories - histories.count - latest_history

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"4264c21b-b403-4f5a-a1d7-4d7b5c227828"},{"name":"Reporting saved reports create","id":"06c9592f-25fd-45d5-9d56-88c298e22628","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"name\": \"name\",\n \"report_type\": 1,\n \"subtype\": 1,\n \"is_template\": false,\n \"is_active\": false,\n \"format\": \"csv\",\n \"generate_csv\": false,\n \"configuration\": {\n \"date_range\": {\n \"type\": \"today\",\n \"from\": \"\",\n \"to\": \"\"\n },\n \"filters\": [\n {\n \"field\": \"field\",\n \"operator\": 1,\n \"value\": \"value\"\n }\n ],\n \"grouping\": [\n 0\n ],\n \"sorting\": [\n {\n \"field\": 0,\n \"direction\": \"asc\"\n }\n ],\n \"columns\": [\n {\n \"field\": 0,\n \"calculations\": [\n \"\"\n ],\n \"label\": \"\"\n }\n ],\n \"limit\": 1,\n \"compare_to\": {\n \"type\": 1\n },\n \"generate_now\": false\n },\n \"schedule\": {\n \"frequency\": \"daily\",\n \"time\": \"\",\n \"days\": [\n 1\n ],\n \"day_of_week\": 1,\n \"day_of_month\": 1,\n \"delay\": \"one_day\",\n \"timezone\": \"\",\n \"recipients\": [\n \"user@example.com\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//reporting/saved-reports","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`report_type`	integer	yes	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`
`subtype`	integer	no	Types values: - `1` = INVENTORY - `2` = GROUP - `3` = SERVICE_CHARGE Allowed: `1`, `2`, `3`
`is_template`	boolean	no	—
`is_active`	boolean	no	—
`format`	string	yes	Allowed: `csv`, `xlsx`
`generate_csv`	boolean	no	—
`configuration`	object	yes	—
`configuration.date_range`	object	yes	—
`configuration.date_range.type`	string	yes	Allowed: `today`, `yesterday`, `last_7_days`, `last_30_days`, `last_90_days`, `this_week`, `last_week`, `this_month`, `last_month`, `last_3_months`, `last_6_months`, `this_year`, `last_year`, `custom`
`configuration.date_range.from`	string \| null	no	—
`configuration.date_range.to`	string \| null	no	—
`configuration.filters`	array	no	—
`configuration.filters.*.field`	string	yes	—
`configuration.filters.*.operator`	integer	yes	A Mapper For OperatorTypes Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`
`configuration.filters.*.value`	string	yes	—
`configuration.grouping`	array	no	—
`configuration.sorting`	array	no	—
`configuration.sorting.*.field`	integer	yes	—
`configuration.sorting.*.direction`	string	yes	Allowed: `asc`, `desc`
`configuration.columns`	array	no	—
`configuration.columns.*.field`	integer	yes	—
`configuration.columns.*.calculations`	array	no	—
`configuration.columns.*.label`	string	no	—
`configuration.limit`	integer	no	—
`configuration.compare_to`	object	no	—
`configuration.compare_to.type`	integer	no	Types of period comparisons for reports Allowed: `1`, `2`, `3`
`configuration.generate_now`	boolean \| null	no	—
`schedule`	object	no	—
`schedule.frequency`	string	no	Schedule frequency for report automation Allowed: `daily`, `weekly`, `monthly`, `quarterly`
`schedule.time`	string	no	—
`schedule.days`	array	no	—
`schedule.day_of_week`	integer \| null	no	—
`schedule.day_of_month`	integer	no	—
`schedule.delay`	string	no	Allowed: `one_day`, `one_week`, `two_weeks`, `one_month`
`schedule.timezone`	string	no	—
`schedule.recipients`	array	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`reportID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`reportID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	no	—
`is_active`	boolean	no	—
`format`	string	yes	Allowed: `csv`, `xlsx`
`generate_csv`	boolean	no	—
`configuration`	object	yes	—
`configuration.date_range`	object	yes	—
`configuration.date_range.type`	string	yes	Allowed: `today`, `yesterday`, `last_7_days`, `last_30_days`, `last_90_days`, `this_week`, `last_week`, `this_month`, `last_month`, `last_3_months`, `last_6_months`, `this_year`, `last_year`, `custom`
`configuration.date_range.from`	string \| null	no	—
`configuration.date_range.to`	string \| null	no	—
`configuration.filters`	array	no	—
`configuration.filters.*.field`	string	yes	—
`configuration.filters.*.operator`	integer	yes	A Mapper For OperatorTypes Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`
`configuration.filters.*.value`	string	yes	—
`configuration.grouping`	array	no	—
`configuration.sorting`	array	no	—
`configuration.sorting.*.field`	integer	yes	—
`configuration.sorting.*.direction`	string	yes	Allowed: `asc`, `desc`
`configuration.columns`	array	no	—
`configuration.columns.*.field`	integer	yes	—
`configuration.columns.*.calculations`	array	no	—
`configuration.columns.*.label`	string	no	—
`configuration.limit`	integer	no	—
`configuration.compare_to`	object	no	—
`configuration.compare_to.type`	integer	no	Types of period comparisons for reports Allowed: `1`, `2`, `3`
`schedule`	object	no	—
`schedule.frequency`	string	no	Schedule frequency for report automation Allowed: `daily`, `weekly`, `monthly`, `quarterly`
`schedule.time`	string	no	—
`schedule.days`	array	no	—
`schedule.day_of_week`	integer \| null	no	—
`schedule.day_of_month`	integer	no	—
`schedule.delay`	string	no	Allowed: `one_day`, `one_week`, `two_weeks`, `one_month`
`schedule.timezone`	string	no	—
`schedule.recipients`	array	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`reportID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`reportID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`reportID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`saved_report_id`	integer \| null	no	—
`name`	string	yes	—
`report_type`	integer	yes	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`
`subtype`	integer	no	Types values: - `1` = INVENTORY - `2` = GROUP - `3` = SERVICE_CHARGE Allowed: `1`, `2`, `3`
`is_template`	boolean	no	—
`is_active`	boolean	no	—
`format`	string	yes	Allowed: `csv`, `xlsx`
`generate_csv`	boolean	no	—
`configuration`	object	yes	—
`configuration.date_range`	object	yes	—
`configuration.date_range.type`	string	yes	Allowed: `today`, `yesterday`, `last_7_days`, `last_30_days`, `last_90_days`, `this_week`, `last_week`, `this_month`, `last_month`, `last_3_months`, `last_6_months`, `this_year`, `last_year`, `custom`
`configuration.date_range.from`	string \| null	no	—
`configuration.date_range.to`	string \| null	no	—
`configuration.filters`	array	no	—
`configuration.filters.*.field`	string	yes	—
`configuration.filters.*.operator`	integer	yes	A Mapper For OperatorTypes Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`
`configuration.filters.*.value`	string	yes	—
`configuration.grouping`	array	no	—
`configuration.sorting`	array	no	—
`configuration.sorting.*.field`	integer	yes	—
`configuration.sorting.*.direction`	string	yes	Allowed: `asc`, `desc`
`configuration.columns`	array	no	—
`configuration.columns.*.field`	integer	yes	—
`configuration.columns.*.calculations`	array	no	—
`configuration.columns.*.label`	string	no	—
`configuration.limit`	integer	no	—
`configuration.compare_to`	object	no	—
`configuration.compare_to.type`	integer	no	Types of period comparisons for reports Allowed: `1`, `2`, `3`
`recipients`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`name`	Filter by Name.
`saved_report_id`	Filter by Saved Report Id.
`status`	Filter by Status.
`exclude_report_types`	Filter by Exclude Report Types.
`report_type`	Filter by Report Type.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

company
user
user.fileManager
savedReport

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Saved Report Id.

\n","type":"text/plain"},"key":"saved_report_id","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Exclude Report Types.

\n","type":"text/plain"},"key":"exclude_report_types","value":""},{"disabled":true,"description":{"content":"

Filter by Report Type.

\n","type":"text/plain"},"key":"report_type","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - company - user - user.fileManager - savedReport

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"1eefc492-ee19-4c3e-ae66-0f5d8593c07f"},{"name":"Reporting history show","id":"3a973333-fa5f-42c7-acbe-adeb1f4face6","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//reporting/history/:historyID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`historyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`historyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`history_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`historyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`historyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`historyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`chatId`	string	yes	—
`name`	string \| null	no	—
`recipients`	array	yes	—
`insights`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`chatId`	string	yes	—
`insight`	integer	yes	—
`report_id`	integer \| null	no	—
`rowlimit`	integer \| null	no	—
`format`	string \| null	no	—
`bucket`	string \| null	no	—
`name`	string \| null	no	—
`recipients`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`historyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`history_id`	integer	yes	—

Reporting — 21 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"657f2aaa-7d9a-436f-be4a-1eb135923af2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Shipments","item":[{"name":"Shipments batch files renew","id":"d05079e7-1ef3-4e16-9bfb-dbd3d8beec36","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//shipments/batch/:batchID/files/:batchFileID/renew","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`batchID`	integer	yes
`batchFileID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`shipmentID`	integer	yes
`shipmentFileID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`store_id`	integer	yes	—
`channel_id`	integer	yes	—
`courier_id`	integer \| null	no	—
`courier_service_id`	integer \| null	no	—
`order_id`	integer \| null	no	—
`customer_id`	integer \| null	no	—
`include_packaging_slip`	boolean \| null	no	—
`include_collection_list`	boolean \| null	no	—
`pregenerate_only`	boolean \| null	no	Generate the label ahead of picking without despatching. The shipment is stored as a pregenerated label: no stock is deducted, the order status is unchanged and no despatch webhook fires. Requires `order_id`; `order_status` is ignored. Calling this endpoint again for the same `order_id` without the flag finalises the label: the order is despatched and stock is deducted at that point (the pick rules of a normal despatch apply then). If an active pregenerated label already exists for the order it is returned instead of creating a second one.
`tags`	array \| null	no	—
`parcels`	array	yes	—
`parcels.*.weight`	number	yes	—
`parcels.*.items`	array \| null	no	—
`shipping_address.name`	string ≤100	yes*	*not needed when `full_name` is sent
`shipping_address.surname`	string ≤100	yes*	*not needed when `full_name` is sent
`shipping_address.full_name`	string ≤255	no	alternative to `name`+`surname`; must contain first+last name
`shipping_address.email`	email ≤255	yes
`shipping_address.address_line_1`	string	yes
`shipping_address.city`	string	yes
`shipping_address.country_id`	integer	yes	global countries table id
`shipping_address.postcode`	string	yes
`shipping_address.company_name`	string	no
`shipping_address.phone`	string	no
`shipping_address.address_line_2`	string	no
`shipping_address.address_line_3`	string	no
`shipping_address.county`	string	no

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`shipmentID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`shipment_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`shipmentID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`shipment_id`	—
`file_name`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`shipmentID`	integer	yes
`shipmentParcelFileID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`shipment_id`	integer	yes	—
`shipment_parcel_file_id`	integer	yes	—
`is_download`	boolean	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

Parameter	Description
`filter[ids][]`	—
`sort`	—
`includes_count`	—
`query`	Filter by Query.
`full_name`	Filter by Full Name.
`order_id`	Filter by Order Id.
`user_id`	Filter by User Id.
`reference`	Filter by Reference.
`courier_service`	Filter by Courier Service.
`postcode`	Filter by Postcode.
`status`	Filter by Status.
`tracking_status`	Filter by Tracking Status.
`archived`	Filter by Archived.
`manifested`	Filter by Manifested.
`is_cancelled`	Filter by Is Cancelled.
`parcel_weight_from`	Filter by Parcel Weight From.
`batch_reference`	Filter by Batch Reference.
`parcel_weight_to`	Filter by Parcel Weight To.
`parcel_count_from`	Filter by Parcel Count From.
`parcel_count_to`	Filter by Parcel Count To.
`created_at_from`	Filter by Created At From.
`created_at_to`	Filter by Created At To.
`customer_id`	Filter by Customer Id.
`is_late`	Filter by Is Late.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

shipmentManifest
courierService
courierService.courier
tranckingCodes
reference
order
error
store
store.meta
channel
channel.settings
shipmentFile
shipmentFile.shipmentFileUrl
parcels
parcels.tracking
parcels.tracking.timeline
parcels.tracking.timeline.images
parcels.items
parcels.items.location
parcels.items.location.settings
parcels.items.location.zone
parcels.items.inventory
parcels.items.inventory.meta
parcels.items.orderItem.inventory
parcels.items.orderItem.inventory.meta
parcels.items.orderItem.meta
parcels.items.orderItem.children.inventory.meta
parcels.items.inventory.groupItems.inventoryItem.meta
shippingAddress
shippingAddress.address
shippingAddress.address.country
shippingAddress.contact
meta
meta.senderAddress
meta.currency
user
shippingAddress.customer.contact
shippingAddress.customer.fileManager
returnCourier
returnCourierService
returnCourierService.courier
parcels.items.itemSerials

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Full Name.

\n","type":"text/plain"},"key":"full_name","value":""},{"disabled":true,"description":{"content":"

Filter by Order Id.

\n","type":"text/plain"},"key":"order_id","value":""},{"disabled":true,"description":{"content":"

Filter by User Id.

\n","type":"text/plain"},"key":"user_id","value":""},{"disabled":true,"description":{"content":"

Filter by Reference.

\n","type":"text/plain"},"key":"reference","value":""},{"disabled":true,"description":{"content":"

Filter by Courier Service.

\n","type":"text/plain"},"key":"courier_service","value":""},{"disabled":true,"description":{"content":"

Filter by Postcode.

\n","type":"text/plain"},"key":"postcode","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Tracking Status.

\n","type":"text/plain"},"key":"tracking_status","value":""},{"disabled":true,"description":{"content":"

Filter by Archived.

\n","type":"text/plain"},"key":"archived","value":""},{"disabled":true,"description":{"content":"

Filter by Manifested.

\n","type":"text/plain"},"key":"manifested","value":""},{"disabled":true,"description":{"content":"

Filter by Is Cancelled.

\n","type":"text/plain"},"key":"is_cancelled","value":""},{"disabled":true,"description":{"content":"

Filter by Parcel Weight From.

\n","type":"text/plain"},"key":"parcel_weight_from","value":""},{"disabled":true,"description":{"content":"

Filter by Batch Reference.

\n","type":"text/plain"},"key":"batch_reference","value":""},{"disabled":true,"description":{"content":"

Filter by Parcel Weight To.

\n","type":"text/plain"},"key":"parcel_weight_to","value":""},{"disabled":true,"description":{"content":"

Filter by Parcel Count From.

\n","type":"text/plain"},"key":"parcel_count_from","value":""},{"disabled":true,"description":{"content":"

Filter by Parcel Count To.

\n","type":"text/plain"},"key":"parcel_count_to","value":""},{"disabled":true,"description":{"content":"

Filter by Created At From.

\n","type":"text/plain"},"key":"created_at_from","value":""},{"disabled":true,"description":{"content":"

Filter by Created At To.

\n","type":"text/plain"},"key":"created_at_to","value":""},{"disabled":true,"description":{"content":"

Filter by Customer Id.

\n","type":"text/plain"},"key":"customer_id","value":""},{"disabled":true,"description":{"content":"

Filter by Is Late.

\n","type":"text/plain"},"key":"is_late","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - shipmentManifest - courierService - courierService.courier - tranckingCodes - reference - order - error - store - store.meta - channel - channel.settings - shipmentFile - shipmentFile.shipmentFileUrl - parcels - parcels.tracking - parcels.tracking.timeline - parcels.tracking.timeline.images - parcels.items - parcels.items.location - parcels.items.location.settings - parcels.items.location.zone - parcels.items.inventory - parcels.items.inventory.meta - parcels.items.orderItem.inventory - parcels.items.orderItem.inventory.meta - parcels.items.orderItem.meta - parcels.items.orderItem.children.inventory.meta - parcels.items.inventory.groupItems.inventoryItem.meta - shippingAddress - shippingAddress.address - shippingAddress.address.country - shippingAddress.contact - meta - meta.senderAddress - meta.currency - user - shippingAddress.customer.contact - shippingAddress.customer.fileManager - returnCourier - returnCourierService - returnCourierService.courier - parcels.items.itemSerials

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"70609aac-02ea-4472-9e79-d383ebd66a8e"},{"name":"Shipments create","id":"1accc8f5-bf32-4ad1-9fe0-d7c93c7454d2","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"store_id\": \"{{store_id}}\",\n \"channel_id\": \"{{channel_id}}\",\n \"courier_id\": \"{{courier_id}}\",\n \"courier_service_id\": \"{{courier_service_id}}\",\n \"order_id\": \"{{order_id}}\",\n \"order_status\": 3,\n \"customer_id\": \"{{customer_id}}\",\n \"include_packaging_slip\": false,\n \"include_collection_list\": false,\n \"tags\": [\n \"\"\n ],\n \"parcels\": [\n {\n \"weight\": 0,\n \"items\": [\n \"\"\n ]\n }\n ],\n \"pregenerate_only\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//shipments","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`store_id`	integer	yes	—
`channel_id`	integer	yes	—
`courier_id`	integer	yes	Required. Must be a courier belonging to this company and currently active. It also scopes courier_service_id, so send the two together.
`courier_service_id`	integer	yes	Required. Must be an active service of the courier sent in courier_id; a service belonging to another courier is rejected.
`order_id`	integer \| null	no	—
`customer_id`	integer \| null	no	—
`include_packaging_slip`	boolean \| null	no	—
`include_collection_list`	boolean \| null	no	—
`tags`	array \| null	no	—
`parcels`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`label_size`	string	yes	Allowed: `2`, `3`, `4`, `5`
`apply_product_changes`	boolean	yes	—
`include_packaging_slip`	boolean \| null	no	—
`include_collection_list`	boolean \| null	no	—
`pregenerate_only`	boolean \| null	no	Generate the labels ahead of picking without despatching. Every shipment row is stored as a pregenerated label: no stock is deducted, the order statuses are unchanged and no despatch webhooks fire. Each row requires `order_id`, one row per order; `order_status` is ignored. Labels are produced asynchronously by the courier, so poll the batch. A later single or batch create for the same orders without the flag finalises the labels: the orders are despatched and stock is deducted at that point. Orders that already have an active pregenerated label are rejected.
`auto_print`	boolean \| null	no	—
`tags`	array \| null	no	—
`shipments`	array	yes	—
`shipments.*.store_id`	integer	yes	—
`shipments.*.channel_id`	integer	yes	—
`shipments.*.courier_id`	integer	yes	—
`shipments.*.courier_service_id`	integer	yes	—
`shipments.*.parcels`	array	yes	—
`shipments..parcels..weight`	number	yes	—
`shipments..parcels..items`	array	yes	—
`shipments..parcels..items.*.quantity`	number	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`shipmentID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

shipmentManifest
courierService
courierService.courier
tranckingCodes
reference
order
error
store
store.meta
channel
channel.settings
shipmentFile
shipmentFile.shipmentFileUrl
parcels
parcels.tracking
parcels.tracking.timeline
parcels.tracking.timeline.images
parcels.items
parcels.items.location
parcels.items.location.settings
parcels.items.location.zone
parcels.items.inventory
parcels.items.inventory.meta
parcels.items.orderItem.inventory
parcels.items.orderItem.inventory.meta
parcels.items.orderItem.meta
parcels.items.orderItem.children.inventory.meta
parcels.items.inventory.groupItems.inventoryItem.meta
shippingAddress
shippingAddress.address
shippingAddress.address.country
shippingAddress.contact
meta
meta.senderAddress
meta.currency
user
shippingAddress.customer.contact
shippingAddress.customer.fileManager
returnCourier
returnCourierService
returnCourierService.courier
parcels.items.itemSerials

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"3d191667-b003-414a-ad36-902db3427356","type":"any","value":"","key":"shipmentID"}]}},"response":[],"_postman_id":"ce0c750a-f6eb-4a4c-aa87-ce585d980dec"},{"name":"Shipments update","id":"0c2c97c1-3940-46a4-b406-4a53eca5f814","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"shipment_id\": \"{{shipment_id}}\",\n \"order_id\": \"{{order_id}}\",\n \"store_id\": \"{{store_id}}\",\n \"channel_id\": \"{{channel_id}}\",\n \"parcels\": [\n {\n \"weight\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//shipments/:shipmentID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`shipmentID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`shipment_id`	integer	yes	—
`order_id`	integer	yes	Required. The order this shipment is for, which must belong to this company; it is copied onto the shipment along with the store and channel.
`store_id`	integer	yes	—
`channel_id`	integer	yes	—
`courier_id`	integer	yes	Required. Must be a courier belonging to this company and currently active. It also scopes courier_service_id, so send the two together.
`courier_service_id`	integer	yes	Required. Must be an active service of the courier sent in courier_id; a service belonging to another courier is rejected.
`parcels`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`shipmentID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`shipment_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`shipmentID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`all`	boolean	no	—
`selection_token`	string \| null	no	—
`elastic_filters`	string \| null	no	—
`elastic_sortable`	string \| null	no	—
`batch_shipment_id`	integer \| null	no	—
`pick_id`	integer \| null	no	—
`elastic_ignore_ids`	array \| null	no	—
`order_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`country_id`	integer \| null	no	—
`discount`	number \| null	no	—
`items`	array	yes	—
`items.*.inventory_id`	integer	yes	—
`items.*.price`	number	yes	—
`items.*.quantity`	integer	yes	—
`items.*.discount`	number \| null	no	—
`items.*.is_group`	boolean \| null	no	—
`items.*.children`	array	no	—
`items..children..inventory_id`	integer	yes	—
`items..children..quantity`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`order_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`order_id`	string	yes	—
`warning_caused_by`	string \| null	no	Allowed: `1`, `2`, `3`
`is_locked`	boolean	yes	—
`courier_service_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`orders`	array	yes	—
`orders.*.order_id`	string	yes	—
`orders.*.warning_caused_by`	string \| null	no	Allowed: `1`, `2`, `3`
`orders.*.is_locked`	boolean	yes	—
`orders.*.courier_service_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`selection_token`	string \| null	no	—
`label_size`	string	yes	Allowed: `2`, `3`, `4`, `5`
`apply_product_changes`	boolean	yes	—
`order_status`	string \| null	no	Allowed: `3`, `8`. Status the despatched orders are set to; defaults to Despatched.
`include_packaging_slip`	boolean \| null	no	—
`include_collection_list`	boolean \| null	no	—
`auto_print`	boolean \| null	no	—
`pregenerate_only`	boolean \| null	no	Not supported here: this endpoint always despatches, so sending `true` is rejected with 422. Use POST shipments/batch to pregenerate labels.
`tags`	array \| null	no	—
`shipments`	array	yes	—
`shipments.*.store_id`	integer	yes	—
`shipments.*.channel_id`	integer	yes	—
`shipments.*.courier_id`	integer	yes	—
`shipments.*.courier_service_id`	integer	yes	—
`shipments.*.order_id`	integer \| null	no	—
`shipments.*.parcels`	array	yes	—
`shipments..parcels..weight`	number	yes	—
`shipments..parcels..package_template_id`	integer \| null	no	—
`shipments..parcels..dim_width`	number \| null	no	Required unless `package_template_id` is sent.
`shipments..parcels..dim_height`	number \| null	no	Required unless `package_template_id` is sent.
`shipments..parcels..dim_length`	number \| null	no	Required unless `package_template_id` is sent.
`shipments..parcels..items`	array	yes	—
`shipments..parcels..items.*.quantity`	number	yes	—
`shipments..parcels..items.*.value`	number	yes	—
`shipments..parcels..items.*.order_item_id`	integer \| null	no	Required when the row has an `order_id`.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`courier_name`	string	yes	—
`courier_service`	string \| null	no	—
`tracking_code`	string \| null	no	—
`send_channels`	boolean \| null	no	—
`package_template_id`	integer \| null	no	—
`order_id`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`shipmentID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`shipment_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`shipmentID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`shipment_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`shipmentID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`shipment_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`shipmentID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`shipment_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`shipmentID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`shipment_id`	integer	yes	—
`order_id`	integer \| null	no	—
`is_manual`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`courier_key`	Filter by Courier Key.
`shipments_from`	Filter by Shipments From.
`shipments_to`	Filter by Shipments To.
`consignments_from`	Filter by Consignments From.
`consignments_to`	Filter by Consignments To.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

courier

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Courier Key.

\n","type":"text/plain"},"key":"courier_key","value":""},{"disabled":true,"description":{"content":"

Filter by Shipments From.

\n","type":"text/plain"},"key":"shipments_from","value":""},{"disabled":true,"description":{"content":"

Filter by Shipments To.

\n","type":"text/plain"},"key":"shipments_to","value":""},{"disabled":true,"description":{"content":"

Filter by Consignments From.

\n","type":"text/plain"},"key":"consignments_from","value":""},{"disabled":true,"description":{"content":"

Filter by Consignments To.

\n","type":"text/plain"},"key":"consignments_to","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - courier

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"ce55bf41-ed91-4d53-b048-f929402f6616"},{"name":"Calculate shipments","id":"537437ae-df55-4248-841b-ca1e909ee01f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"include_courier_service\": true,\n \"data\": [\n {\n \"order_id\": 57,\n \"store_id\": 1,\n \"channel_id\": 1,\n \"shipping_address\": { \"country_id\": 232, \"postcode\": \"EC1A 1BB\" },\n \"parcels\": [\n {\n \"package_template_id\": 1,\n \"items\": [\n { \"order_item_id\": 64, \"inventory_id\": 43, \"quantity\": 2, \"value\": 60 }\n ]\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//shipments/calculate","description":"

Example request. data[] is a batch — add more elements to calculate multiple shipments in one call. include_courier_service: false skips courier resolution (parcel/price only). A parcel with package_template_id: null lets the backend auto-resolve the template. Omit order_id and send shipping_address + items for a manual (no-order) calculation. Set respect_submitted_parcels: true on a data[] element to have its parcels calculated exactly as sent: units of a Single Parcel Per Item product are not split into separate parcels, and the response returns the same parcels in the same order.

Moves an order that ALREADY has a generated label to Despatched.

This is the second step of the two-step despatch flow: create the shipment with order_status: 3 (the label is generated and the order stays in Processing), then call this when the parcel actually goes out.

Because the shipment already exists, only the order status changes: no second shipment is created, no stock is deducted again and no channel sync is triggered - all of that happened when the label was made.

For recording a despatch that happened entirely outside the system (typing in a courier name and tracking number by hand) use /shipments/create-manual instead.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`order_id`	integer	yes	Must belong to the company in the path and be in a despatchable status (Processing / New / Sorted / Packing), not on hold and not archived.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Description
`204`	Despatched. No response body.
`422`	The order has no generated label to despatch, is already Despatched, or the `order_id` is invalid for this company.

Shipments — 27 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"da862a26-9cc3-49b9-832f-3a91bc7dd2ca","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Shipping Rules","item":[{"name":"Shipping rules shipment calculation","id":"4005050a-2d6c-4f36-a0df-4fe36ec76ff7","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"store_id\": \"{{store_id}}\",\n \"channel_id\": \"{{channel_id}}\",\n \"order_id\": \"{{order_id}}\",\n \"shipping_cost\": 0,\n \"total_price\": 0,\n \"is_failed_before\": false,\n \"shipping_address\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"company_name\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country_id\": \"{{country_id}}\",\n \"postcode\": \"\"\n },\n \"parcels\": [\n {\n \"items\": [\n {\n \"quantity\": \"quantity\",\n \"value\": \"value\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//shipping-rules/shipment-calculation","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`store_id`	integer \| null	no	—
`channel_id`	integer \| null	no	—
`order_id`	integer	no	—
`shipping_cost`	number \| null	no	—
`total_price`	number \| null	no	—
`is_failed_before`	boolean \| null	no	—
`shipping_address`	object	no	—
`shipping_address.name`	string \| null	no	—
`shipping_address.surname`	string \| null	no	—
`shipping_address.company_name`	string \| null	no	—
`shipping_address.email`	string \| null	no	—
`shipping_address.phone`	string \| null	no	—
`shipping_address.address_line_1`	string \| null	no	—
`shipping_address.address_line_2`	string \| null	no	—
`shipping_address.address_line_3`	string \| null	no	—
`shipping_address.city`	string \| null	no	—
`shipping_address.county`	string \| null	no	—
`shipping_address.country_id`	integer \| null	no	—
`shipping_address.postcode`	string \| null	no	—
`parcels`	array	yes	—
`parcels.*.items`	array \| null	no	—
`parcels..items..quantity`	string	yes	—
`parcels..items..value`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`data`	array	yes	—
`data.*.store_id`	integer \| null	no	—
`data.*.shipping_address`	object	no	—
`data.*.shipping_address.name`	string \| null	no	—
`data.*.shipping_address.surname`	string \| null	no	—
`data.*.shipping_address.company_name`	string \| null	no	—
`data.*.shipping_address.email`	string \| null	no	—
`data.*.shipping_address.phone`	string \| null	no	—
`data.*.shipping_address.address_line_1`	string \| null	no	—
`data.*.shipping_address.address_line_2`	string \| null	no	—
`data.*.shipping_address.address_line_3`	string \| null	no	—
`data.*.shipping_address.city`	string \| null	no	—
`data.*.shipping_address.county`	string \| null	no	—
`data.*.shipping_address.country_id`	integer \| null	no	—
`data.*.shipping_address.postcode`	string \| null	no	—
`data.*.shipping_cost`	number \| null	no	—
`data.*.total_price`	number \| null	no	—
`data.*.parcels`	array	yes	—
`data..parcels..items`	array	yes	—
`data..parcels..items.*.quantity`	string	yes	—
`data..parcels..items.*.value`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

restrictions
rules
rules.outputCourierService
rules.outputCourierService.courier
rules.outputFailOverService
rules.outputFailOverService.courier
rules.outputReturnService
rules.outputReturnService.courier

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - restrictions - rules - rules.outputCourierService - rules.outputCourierService.courier - rules.outputFailOverService - rules.outputFailOverService.courier - rules.outputReturnService - rules.outputReturnService.courier

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"acad1877-efed-4fda-ba69-d5b760e65fad"},{"name":"Shipping rules groups create","id":"3c181114-7057-40cd-9215-46438b4943f0","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"name\": \"name\",\n \"restrictions\": {\n \"store_and_channels\": [\n 0\n ],\n \"warehouses\": [\n 0\n ],\n \"selected_countries\": [\n 0\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//shipping-rules/groups","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`restrictions`	object	no	—
`restrictions.store_and_channels`	array \| null	no	—
`restrictions.warehouses`	array \| null	no	—
`restrictions.selected_countries`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`groupID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

restrictions
rules
rules.outputCourierService
rules.outputCourierService.courier
rules.outputFailOverService
rules.outputFailOverService.courier
rules.outputReturnService
rules.outputReturnService.courier

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"7c239293-d181-449d-b3f1-c45207a16aa1","type":"any","value":"","key":"groupID"}]}},"response":[],"_postman_id":"88546498-e0e7-4f1a-89c9-ca91f1564711"},{"name":"Shipping rules groups update","id":"bd8f1533-d980-4b7b-99bb-ae77cf9f7fe9","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"name\": \"name\",\n \"restrictions\": {\n \"store_and_channels\": [\n 0\n ],\n \"warehouses\": [\n 0\n ],\n \"selected_countries\": [\n 0\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//shipping-rules/groups/:groupID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`groupID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`restrictions`	object	no	—
`restrictions.store_and_channels`	array \| null	no	—
`restrictions.warehouses`	array \| null	no	—
`restrictions.selected_countries`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`groupID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`groupID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

shippingRuleGroup
outputCourierService
outputCourierService.courier
outputFailOverService
outputFailOverService.courier
outputReturnService
outputReturnService.courier
conditionGroups

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - shippingRuleGroup - outputCourierService - outputCourierService.courier - outputFailOverService - outputFailOverService.courier - outputReturnService - outputReturnService.courier - conditionGroups

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"f25da02b-6128-45e5-a5c9-00eef88fb92e","type":"any","value":"","key":"groupID"}]}},"response":[],"_postman_id":"9548cc88-b255-4fc1-b8f3-0b04fe0a1955"},{"name":"Shipping rules groups rules create","id":"86601e9a-36ec-4206-b13c-4000cb9e242f","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"rules\": [\n {\n \"name\": \"name\",\n \"output_courier_service_id\": \"{{output_courier_service_id}}\",\n \"output_failover_service_id\": \"{{output_failover_service_id}}\",\n \"output_return_service_id\": \"{{output_return_service_id}}\",\n \"output_return_label_creation\": \"1\",\n \"conditions\": [\n [\n {\n \"field\": 1,\n \"operator\": 0,\n \"value\": [\n \"\"\n ]\n }\n ]\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//shipping-rules/groups/:groupID/rules","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`groupID`	integer	yes

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

shippingRuleGroup
outputCourierService
outputCourierService.courier
outputFailOverService
outputFailOverService.courier
outputReturnService
outputReturnService.courier
conditionGroups

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`rules`	array	yes	—
`rules.*.name`	string	yes	—
`rules.*.output_courier_service_id`	integer	yes	—
`rules.*.output_failover_service_id`	integer \| null	no	—
`rules.*.output_return_service_id`	integer \| null	no	—
`rules.*.output_return_label_creation`	string \| null	no	Allowed: `1`, `2`
`rules.*.conditions`	array \| null	no	—

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"4ba4bbc0-b18f-48ee-b83f-0f25870c1ca4","type":"any","value":"","key":"groupID"}]}},"response":[],"_postman_id":"86601e9a-36ec-4206-b13c-4000cb9e242f"},{"name":"Shipping rules groups rules show","id":"40e327de-8d79-45c1-ad5b-1d129739bfb4","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//shipping-rules/groups/:groupID/rules/:ruleID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`groupID`	integer	yes
`ruleID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

shippingRuleGroup
outputCourierService
outputCourierService.courier
outputFailOverService
outputFailOverService.courier
outputReturnService
outputReturnService.courier
conditionGroups

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"576e1118-5790-46e7-9c50-608a5eb077fe","type":"any","value":"","key":"groupID"},{"id":"7d5085ed-238d-45c5-b194-b4e183c9580e","type":"any","value":"","key":"ruleID"}]}},"response":[],"_postman_id":"40e327de-8d79-45c1-ad5b-1d129739bfb4"},{"name":"Shipping rules shipment calculation all rules","id":"8e6c6dbf-e663-4e70-bba9-554bee7c7b25","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"store_id\": \"{{store_id}}\",\n \"channel_id\": \"{{channel_id}}\",\n \"order_id\": \"{{order_id}}\",\n \"shipping_cost\": 0,\n \"shipping_address\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"company_name\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country_id\": \"{{country_id}}\",\n \"postcode\": \"\"\n },\n \"parcels\": [\n {\n \"items\": [\n {\n \"quantity\": \"quantity\",\n \"value\": \"value\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//shipping-rules/shipment-calculation-all-rules","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`store_id`	integer \| null	no	—
`channel_id`	integer \| null	no	—
`order_id`	integer	no	—
`shipping_cost`	number \| null	no	—
`shipping_address`	object	no	—
`shipping_address.first_name`	string \| null	no	—
`shipping_address.last_name`	string \| null	no	—
`shipping_address.company_name`	string \| null	no	—
`shipping_address.email`	string \| null	no	—
`shipping_address.phone`	string \| null	no	—
`shipping_address.address_line_1`	string \| null	no	—
`shipping_address.address_line_2`	string \| null	no	—
`shipping_address.address_line_3`	string \| null	no	—
`shipping_address.city`	string \| null	no	—
`shipping_address.county`	string \| null	no	—
`shipping_address.country_id`	integer \| null	no	—
`shipping_address.postcode`	string \| null	no	—
`parcels`	array	no	—
`parcels.*.items`	array \| null	no	—
`parcels..items..quantity`	string	yes	—
`parcels..items..value`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`order_id`	integer	yes	—
`items`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`groupID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`group_id`	integer	yes	—
`sorting`	array	yes	—
`sorting.*.id`	integer	yes	—
`sorting.*.order`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`groupID`	integer	yes
`ruleID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`group_id`	integer	yes	—
`rule_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`conditions`	array \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`savedConditionID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`saved_condition_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`savedConditionID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`saved_condition_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`sorting`	array	yes	—
`sorting.*.id`	integer	yes	—
`sorting.*.order`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`groupID`	integer	yes

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

restrictions
rules
rules.outputCourierService
rules.outputCourierService.courier
rules.outputFailOverService
rules.outputFailOverService.courier
rules.outputReturnService
rules.outputReturnService.courier

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`includes`	string	no	—
`includes_count`	string	no	—

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"3c3ecf4a-7b40-4cb6-9b17-c517f11608ca","type":"any","value":"","key":"groupID"}]}},"response":[],"_postman_id":"ffefbec4-f565-4ed4-b831-7ec31a2f651f"},{"name":"Shipping rules groups duplicate","id":"6b085f33-6cb6-4dc6-8de7-0a2e71633d14","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//shipping-rules/groups/:groupID/duplicate","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`groupID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

restrictions
rules
rules.outputCourierService
rules.outputCourierService.courier
rules.outputFailOverService
rules.outputFailOverService.courier
rules.outputReturnService
rules.outputReturnService.courier

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"0bd7ba89-2eae-42c4-9a89-7bcbd924cdf2","type":"any","value":"","key":"groupID"}]}},"response":[],"_postman_id":"6b085f33-6cb6-4dc6-8de7-0a2e71633d14"}],"id":"2338b4e0-bfb1-47f7-b3a0-1a9d46515898","description":"

Shipping Rules — 23 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"2338b4e0-bfb1-47f7-b3a0-1a9d46515898","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Sorting","item":[{"name":"Sorting list","id":"2e5e35ba-eee8-4594-80a4-462e67efdf91","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//sorting","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`pick_reference_number`	Filter by Pick Reference Number.
`pick_id`	Filter by Pick Id.
`user_id`	Filter by User Id.
`pick_created_at_from`	Filter by Pick Created At From.
`pick_created_at_to`	Filter by Pick Created At To.
`tag_id`	Filter by Tag Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

order
items
items.inventory
items.inventory.meta
tote
originLocation
location

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Pick Reference Number.

\n","type":"text/plain"},"key":"pick_reference_number","value":""},{"disabled":true,"description":{"content":"

Filter by Pick Id.

\n","type":"text/plain"},"key":"pick_id","value":""},{"disabled":true,"description":{"content":"

Filter by User Id.

\n","type":"text/plain"},"key":"user_id","value":""},{"disabled":true,"description":{"content":"

Filter by Pick Created At From.

\n","type":"text/plain"},"key":"pick_created_at_from","value":""},{"disabled":true,"description":{"content":"

Filter by Pick Created At To.

\n","type":"text/plain"},"key":"pick_created_at_to","value":""},{"disabled":true,"description":{"content":"

Filter by Tag Id.

\n","type":"text/plain"},"key":"tag_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - order - items - items.inventory - items.inventory.meta - tote - originLocation - location

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"2e5e35ba-eee8-4594-80a4-462e67efdf91"},{"name":"Sorting set as sorted","id":"43419e5f-2aa0-4cfb-a107-ae6df4aebcc9","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sorting_ids\": [\n \"{{sorting_id}}\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//sorting/set-as-sorted","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`sorting_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`sortingID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`notes`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`inventory`	Filter by Inventory.
`inventory_name`	Filter by Inventory Name.
`inventory_code`	Filter by Inventory Code.
`pick_reference_number`	Filter by Pick Reference Number.
`origin_location_id`	Filter by Origin Location Id.
`location_id`	Filter by Location Id.
`pick_id`	Filter by Pick Id.
`sorting_status`	Filter by Sorting Status.
`hide_completed_items`	Filter by Hide Completed Items.
`user_id`	Filter by User Id.
`pick_created_at_from`	Filter by Pick Created At From.
`pick_created_at_to`	Filter by Pick Created At To.
`tag_id`	Filter by Tag Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Inventory.

\n","type":"text/plain"},"key":"inventory","value":""},{"disabled":true,"description":{"content":"

Filter by Inventory Name.

\n","type":"text/plain"},"key":"inventory_name","value":""},{"disabled":true,"description":{"content":"

Filter by Inventory Code.

\n","type":"text/plain"},"key":"inventory_code","value":""},{"disabled":true,"description":{"content":"

Filter by Pick Reference Number.

\n","type":"text/plain"},"key":"pick_reference_number","value":""},{"disabled":true,"description":{"content":"

Filter by Origin Location Id.

\n","type":"text/plain"},"key":"origin_location_id","value":""},{"disabled":true,"description":{"content":"

Filter by Location Id.

\n","type":"text/plain"},"key":"location_id","value":""},{"disabled":true,"description":{"content":"

Filter by Pick Id.

\n","type":"text/plain"},"key":"pick_id","value":""},{"disabled":true,"description":{"content":"

Filter by Sorting Status.

\n","type":"text/plain"},"key":"sorting_status","value":""},{"disabled":true,"description":{"content":"

Filter by Hide Completed Items.

\n","type":"text/plain"},"key":"hide_completed_items","value":""},{"disabled":true,"description":{"content":"

Filter by User Id.

\n","type":"text/plain"},"key":"user_id","value":""},{"disabled":true,"description":{"content":"

Filter by Pick Created At From.

\n","type":"text/plain"},"key":"pick_created_at_from","value":""},{"disabled":true,"description":{"content":"

Filter by Pick Created At To.

\n","type":"text/plain"},"key":"pick_created_at_to","value":""},{"disabled":true,"description":{"content":"

Filter by Tag Id.

\n","type":"text/plain"},"key":"tag_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations vary per endpoint.

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"152d761f-8c8f-4179-9666-3af5cac4d462"},{"name":"Sorting items sort","id":"3ce3bd64-c054-45e9-97ae-b628865b26d6","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"quantity\": 1,\n \"location_id\": \"{{location_id}}\",\n \"tote_id\": \"{{tote_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//sorting/:sortingID/items/:sortingItemID/sort","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`sortingID`	integer	yes
`sortingItemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`quantity`	integer	yes	—
`location_id`	integer	no	—
`tote_id`	integer	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`sortingID`	integer	yes
`sortingItemID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`quantity`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`slotID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`warehouse_id`	integer	yes	—
`zone_id`	integer \| null	no	—
`code`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

location
location.settings
location.zone
tote
assignedSortingByTote
assignedSortingByTote.order
assignedSortingByTote.items
assignedSortingByTote.items.inventory
assignedSortingByTote.items.inventory.meta
assignedSortingByTote.pickedItem
assignedSortingByTote.pickedItem.location
assignedSortingByLocation
assignedSortingByLocation.order
assignedSortingByLocation.items
assignedSortingByLocation.items.inventory
assignedSortingByLocation.items.inventory.meta
assignedSortingByLocation.pickedItem
assignedSortingByLocation.pickedItem.location

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - location - location.settings - location.zone - tote - assignedSortingByTote - assignedSortingByTote.order - assignedSortingByTote.items - assignedSortingByTote.items.inventory - assignedSortingByTote.items.inventory.meta - assignedSortingByTote.pickedItem - assignedSortingByTote.pickedItem.location - assignedSortingByLocation - assignedSortingByLocation.order - assignedSortingByLocation.items - assignedSortingByLocation.items.inventory - assignedSortingByLocation.items.inventory.meta - assignedSortingByLocation.pickedItem - assignedSortingByLocation.pickedItem.location

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"f380b8a0-6459-433c-8915-111b74defa41"},{"name":"Sorting unassign order","id":"105bd2fc-1db2-4a58-8506-1892774c1718","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//sorting/slots/:slotID/unassign-order","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`slotID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations vary per endpoint.

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"14a48823-f4b2-474d-b9e8-37a8fff69576"},{"name":"Sorting totes create","id":"bbcf5c50-525d-46ce-9602-83ec0df47cde","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"code\": \"code\",\n \"location_id\": \"{{location_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//sorting/locations/totes","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`code`	string	yes	—
`location_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`toteID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`code`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`toteID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`locationID`	integer	yes

Sorting — 18 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"e08326f8-b2de-4b0a-a0b0-8d9b73a98ffe","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Storage Cost Groups","item":[{"name":"Storage cost groups list","id":"61721cd4-bbea-4da0-9bc3-d6df05ffcf36","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//storage-cost-groups","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`is_active`	Filter by Is Active.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

locations

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Is Active.

\n","type":"text/plain"},"key":"is_active","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - locations

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"61721cd4-bbea-4da0-9bc3-d6df05ffcf36"},{"name":"Storage cost groups create","id":"0a87a9e7-e81e-4a67-a224-ef5832de769c","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"name\": \"name\",\n \"fixed_cost_daily\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//storage-cost-groups","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`fixed_cost_daily`	number	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storageCostGroupID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

locations

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - locations

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"2e0f09bc-4cbd-4406-8fd1-49294f838fc4","type":"any","value":"","key":"storageCostGroupID"}]}},"response":[],"_postman_id":"6f69a3e4-b521-4229-b44d-882fc718d185"},{"name":"Storage cost groups update","id":"0e3ee75e-9d79-4c5b-84b2-d5a5f4a265a1","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"storage_cost_group_id\": \"{{storage_cost_group_id}}\",\n \"name\": \"name\",\n \"fixed_cost_daily\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//storage-cost-groups/:storageCostGroupID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storageCostGroupID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`storage_cost_group_id`	integer	yes	—
`name`	string	yes	—
`fixed_cost_daily`	number	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storageCostGroupID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`storage_cost_group_id`	integer	yes	—
`name`	string	yes	—
`fixed_cost_daily`	number	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storageCostGroupID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`storage_cost_group_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storageCostGroupID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`storage_cost_group_id`	integer	yes	—
`is_active`	boolean	yes	—

Storage Cost Groups — 7 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"5e6bf8e2-ec55-430d-bb79-21f9da8f48f8","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Stores","item":[{"name":"Stores channels available","id":"4dbb0e84-7479-4055-9f82-4457e68a0359","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//stores/:storeID/channels/available","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`storeID`	integer	yes
`providerType`	string	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`store_id`	Filter by Store Id.
`name`	Filter by Name.
`without_provider`	Filter by Without Provider.
`stock_sync`	Filter by Stock Sync.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

company
settings
store

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Store Id.

\n","type":"text/plain"},"key":"store_id","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Without Provider.

\n","type":"text/plain"},"key":"without_provider","value":""},{"disabled":true,"description":{"content":"

Filter by Stock Sync.

\n","type":"text/plain"},"key":"stock_sync","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - company - settings - store

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"558836c1-2065-44b9-8ae7-13172de215d2","type":"any","value":"","key":"storeID"}]}},"response":[],"_postman_id":"369d4674-6c11-44d1-ab87-8f215ecb0dc1"},{"name":"Stores channels create","id":"7b898638-2a2f-4851-9913-995b420d6c4f","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"store_id\": \"{{store_id}}\",\n \"name\": \"\",\n \"provider\": \"provider\",\n \"channel_settings\": [\n \"\"\n ],\n \"interaction_settings\": [\n \"\"\n ],\n \"import_products\": false,\n \"auto_sync_stock\": false,\n \"use_channel_names\": false,\n \"auto_merge_orders\": false,\n \"is_active\": false,\n \"file_manager_id\": \"{{file_manager_id}}\",\n \"primary_order_reference\": \"1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//stores/:storeID/channels","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`store_id`	integer	yes	—
`name`	string \| null	no	—
`provider`	string	yes	—
`channel_settings`	array \| null	no	—
`interaction_settings`	array \| null	no	—
`import_products`	boolean \| null	no	—
`auto_sync_stock`	boolean \| null	no	—
`use_channel_names`	boolean \| null	no	—
`auto_merge_orders`	boolean \| null	no	—
`is_active`	boolean \| null	no	—
`file_manager_id`	integer \| null	no	—
`primary_order_reference`	string \| null	no	Allowed: `1`, `2`, `3`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`storeID`	integer	yes
`channelID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

company
settings
store

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - company - settings - store

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"99383dd4-32d0-4eb3-ad9c-089b68fb391b","type":"any","value":"","key":"storeID"},{"id":"349e09cb-e2f2-4413-9ecb-9a33caa79e14","type":"any","value":"","key":"channelID"}]}},"response":[],"_postman_id":"bcbd59b6-1111-4265-8de4-9a2137adc0fc"},{"name":"Stores channels update","id":"c59888f3-4bb7-426d-9781-9b5bd446a0c4","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"channel_settings\": [\n \"\"\n ],\n \"interaction_settings\": [\n \"\"\n ],\n \"import_products\": false,\n \"auto_sync_stock\": false,\n \"use_channel_names\": false,\n \"auto_merge_orders\": false,\n \"is_active\": false,\n \"file_manager_id\": \"{{file_manager_id}}\",\n \"primary_order_reference\": \"1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//stores/:storeID/channels/:channelID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`storeID`	integer	yes
`channelID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string \| null	no	—
`channel_settings`	array \| null	no	—
`interaction_settings`	array \| null	no	—
`import_products`	boolean \| null	no	—
`auto_sync_stock`	boolean \| null	no	—
`use_channel_names`	boolean \| null	no	—
`auto_merge_orders`	boolean \| null	no	—
`is_active`	boolean \| null	no	—
`file_manager_id`	integer \| null	no	—
`primary_order_reference`	string \| null	no	Allowed: `1`, `2`, `3`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`storeID`	integer	yes
`channelID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`channels`	array	yes	—
`channels.*.id`	integer	yes	—
`channels.*.invoice_print_template_id`	integer \| null	no	—
`channels.*.packing_slip_print_template_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`storeID`	integer	yes
`channelID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`is_active`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`storeID`	integer	yes
`channelID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`storeID`	integer	yes
`channelID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[{"id":"cf73e91c-b1d7-4b4f-9aee-f1f45d2ce3d6","type":"any","value":"","key":"storeID"}]}},"response":[],"_postman_id":"128ba386-a48b-44e9-b619-5123bca722d6"},{"name":"Stores channel linking settings","id":"1b61bdca-f629-4653-96b3-79b751a46da7","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"auto_link\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//stores/:storeID/channel-linking/settings","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`auto_link`	boolean	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`store_id`	Filter by Store Id.
`channel_id`	Filter by Channel Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Store Id.

\n","type":"text/plain"},"key":"store_id","value":""},{"disabled":true,"description":{"content":"

Filter by Channel Id.

\n","type":"text/plain"},"key":"channel_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations vary per endpoint.

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"dfb730e6-c90b-4fb9-ac72-86ed94e1c764","type":"any","value":"","key":"storeID"}]}},"response":[],"_postman_id":"33bbaa82-7ac5-4af7-ad2d-2efa5c8db48a"},{"name":"Stores channel linking formulas create","id":"f8b1ff0c-6465-4453-a382-17e5e0752f55","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"formula_1\": \"1\",\n \"formula_2\": \"1\",\n \"formula_3\": \"1\",\n \"text\": \"\",\n \"channel_id\": \"{{channel_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//stores/:storeID/channel-linking/formulas","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`formula_1`	string	yes	Allowed: `1`, `2`, `3`
`formula_2`	string	yes	Allowed: `1`, `2`, `3`
`formula_3`	string	yes	Allowed: `1`, `2`, `3`
`text`	string \| null	no	—
`channel_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`formulas`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`storeID`	integer	yes
`formulaID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`formula_id`	integer	yes	—
`formula_1`	string	yes	Allowed: `1`, `2`, `3`
`formula_2`	string	yes	Allowed: `1`, `2`, `3`
`formula_3`	string	yes	Allowed: `1`, `2`, `3`
`text`	string \| null	no	—
`channel_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`storeID`	integer	yes
`formulaID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`formula_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`store_id`	Filter by Store Id.
`channel_id`	Filter by Channel Id.
`type`	Filter by Type.
`inventory_id`	Filter by Inventory Id.
`name`	Filter by Name.
`code`	Filter by Code.
`quantity_min`	Filter by Quantity Min.
`quantity_max`	Filter by Quantity Max.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Store Id.

\n","type":"text/plain"},"key":"store_id","value":""},{"disabled":true,"description":{"content":"

Filter by Channel Id.

\n","type":"text/plain"},"key":"channel_id","value":""},{"disabled":true,"description":{"content":"

Filter by Type.

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

Filter by Inventory Id.

\n","type":"text/plain"},"key":"inventory_id","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Code.

\n","type":"text/plain"},"key":"code","value":""},{"disabled":true,"description":{"content":"

Filter by Quantity Min.

\n","type":"text/plain"},"key":"quantity_min","value":""},{"disabled":true,"description":{"content":"

Filter by Quantity Max.

\n","type":"text/plain"},"key":"quantity_max","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations vary per endpoint.

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"df1710a2-7950-493d-a7b0-6230334c945b","type":"any","value":"","key":"storeID"}]}},"response":[],"_postman_id":"ae4635b6-7972-42b3-87e7-a040cc4bd11e"},{"name":"Stores channel linking inventories bulk attach","id":"47dd09f4-4256-4e38-9fe8-ede1cb5f891c","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"products\": [\n {\n \"channel_product_id\": \"{{channel_product_id}}\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//stores/:storeID/channel-linking/inventories/bulk-attach","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`products`	array	yes	—
`products.*.channel_product_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`products`	array	yes	—
`products.*.channel_product_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`channel_product_id`	integer	yes	—
`inventory_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`channel_product_id`	integer	no	—
`inventory_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`storeID`	integer	yes
`channelProductID`	integer	yes
`inventoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`channel_product_id`	integer	no	—
`inventory_id`	integer	yes	—
`auto_sync_stock`	boolean \| null	no	—
`inbound_po_enabled`	boolean \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`company_id`	string	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`name`	Filter by Name.
`store_and_channel`	Filter by Store And Channel.
`channel_name`	Filter by Channel Name.
`channel_provider`	Filter by Channel Provider.
`without_provider`	Filter by Without Provider.
`channel_is_active`	Filter by Channel Is Active.
`stock_sync`	Filter by Stock Sync.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

company
channels
channels.settings
meta
financialDetail
addresses.address
addresses.address.country

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Store And Channel.

\n","type":"text/plain"},"key":"store_and_channel","value":""},{"disabled":true,"description":{"content":"

Filter by Channel Name.

\n","type":"text/plain"},"key":"channel_name","value":""},{"disabled":true,"description":{"content":"

Filter by Channel Provider.

\n","type":"text/plain"},"key":"channel_provider","value":""},{"disabled":true,"description":{"content":"

Filter by Without Provider.

\n","type":"text/plain"},"key":"without_provider","value":""},{"disabled":true,"description":{"content":"

Filter by Channel Is Active.

\n","type":"text/plain"},"key":"channel_is_active","value":""},{"disabled":true,"description":{"content":"

Filter by Stock Sync.

\n","type":"text/plain"},"key":"stock_sync","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - company - channels - channels.settings - meta - financialDetail - addresses.address - addresses.address.country

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"a90d5ca1-0159-47d2-a34f-53cad6b8d220"},{"name":"Stores create","id":"39669ea6-b8d4-48ad-bd87-74ca7d1de0a9","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"name\",\n \"financial_details\": {\n \"vat_number\": \"\",\n \"eori\": \"\",\n \"ioss\": \"\",\n \"customs_code\": \"\",\n \"vat_rate\": 0\n },\n \"address\": {\n \"company_name\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"postcode\": \"\",\n \"country_id\": \"{{country_id}}\",\n \"phone\": \"\",\n \"email\": \"user@example.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//stores","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`name`	string	yes	—
`financial_details`	object	no	Financial Details (optional)
`financial_details.vat_number`	string \| null	no	—
`financial_details.eori`	string \| null	no	—
`financial_details.ioss`	string \| null	no	—
`financial_details.customs_code`	string \| null	no	—
`financial_details.vat_rate`	number \| null	no	—
`address`	object	no	Address (optional)
`address.company_name`	string \| null	no	—
`address.address_line_1`	string \| null	no	—
`address.address_line_2`	string \| null	no	—
`address.address_line_3`	string \| null	no	—
`address.city`	string \| null	no	—
`address.county`	string \| null	no	—
`address.postcode`	string \| null	no	—
`address.country_id`	integer \| null	no	—
`address.phone`	string \| null	no	—
`address.email`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

company
channels
channels.settings
meta
financialDetail
addresses.address
addresses.address.country

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"07515353-9724-45f6-9c02-1a1d3aba304a","type":"any","value":"","key":"storeID"}]}},"response":[],"_postman_id":"554bce51-bef5-4cc5-a7c1-a2bdf7241090"},{"name":"Stores update","id":"33d1cc55-2b0a-4c2b-b8d2-3cf68bbfb37e","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"file_manager_id\": \"{{file_manager_id}}\",\n \"brand_image_file_manager_id\": \"{{brand_image_file_manager_id}}\",\n \"financial_details\": {\n \"vat_number\": \"\",\n \"eori\": \"\",\n \"ioss\": \"\",\n \"customs_code\": \"\",\n \"vat_rate\": 0\n },\n \"address\": {\n \"company_name\": \"\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"postcode\": \"\",\n \"country_id\": \"{{country_id}}\",\n \"phone\": \"\",\n \"email\": \"user@example.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//stores/:storeID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Body parameters

Field	Type	Required	Description
`name`	string	no	—
`file_manager_id`	integer \| null	no	—
`brand_image_file_manager_id`	integer \| null	no	—
`financial_details`	object	no	Financial Details (optional)
`financial_details.vat_number`	string \| null	no	—
`financial_details.eori`	string \| null	no	—
`financial_details.ioss`	string \| null	no	—
`financial_details.customs_code`	string \| null	no	—
`financial_details.vat_rate`	number \| null	no	—
`address`	object	no	Address (optional)
`address.company_name`	string \| null	no	—
`address.address_line_1`	string \| null	no	—
`address.address_line_2`	string \| null	no	—
`address.address_line_3`	string \| null	no	—
`address.city`	string \| null	no	—
`address.county`	string \| null	no	—
`address.postcode`	string \| null	no	—
`address.country_id`	integer \| null	no	—
`address.phone`	string \| null	no	—
`address.email`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_name`	string \| null	no	—
`address_line_1`	string \| null	no	—
`address_line_2`	string \| null	no	—
`city`	string \| null	no	—
`country_id`	integer \| null	no	—
`county`	string \| null	no	—
`postcode`	string \| null	no	—
`override_defaults`	boolean \| null	no	—
`types`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`storeID`	integer	yes
`type`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`type`	Options: `0`, `1`, `2`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string \| null	no	—
`contact_firstname`	string \| null	no	—
`contact_lastname`	string \| null	no	—
`contact_email`	string \| null	no	—
`contact_phone`	string \| null	no	—
`number`	string \| null	no	—
`vat_number`	string \| null	no	—
`ioss`	string \| null	no	—
`eori`	string \| null	no	—
`override_company_details`	boolean \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`file_manager_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`storeID`	integer	yes

Stores — 39 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"8b77a06f-3236-44fc-96da-4909b18fb210","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Suppliers","item":[{"name":"Suppliers bulk create","id":"65339b9b-08a5-4865-a7c4-6a229c57b2b4","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//suppliers/bulk-create","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`tags`	array \| null	no	—
`details`	object	no	—
`details.registration_number`	string \| null	no	—
`details.tax_id`	string \| null	no	—
`details.eori`	string \| null	no	—
`suppliers`	array	yes	—
`suppliers.*.supplier_id`	integer	yes	—
`suppliers.*.email`	string \| null	no	—
`suppliers.*.phone`	string \| null	no	—
`suppliers.*.url`	string \| null	no	—
`suppliers.*.registration_number`	string \| null	no	—
`suppliers.*.contacts`	array \| null	no	—
`contacts`	array	no	—
`contacts.*.name`	string	yes	—
`contacts.*.surname`	string \| null	no	—
`contacts.*.email`	string \| null	no	—
`contacts.*.phone`	string \| null	no	—
`contacts.*.title`	string \| null	no	—
`addresses`	array \| null	no	—
`addresses.*.company_name`	string \| null	no	—
`addresses.*.address_line_1`	string	yes	—
`addresses.*.address_line_2`	string \| null	no	—
`addresses.*.address_line_3`	string \| null	no	—
`addresses.*.city`	string	yes	—
`addresses.*.county`	string \| null	no	—
`addresses.*.country_id`	integer	yes	—
`addresses.*.postcode`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`suppliers`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`suppliers`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`suppliers`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`name`	Filter by Name.
`archived`	Filter by Archived.
`id`	Filter by Id.
`tags`	Filter by Tags.
`last_ordered_date_from`	Filter by Last Ordered Date From.
`last_ordered_date_to`	Filter by Last Ordered Date To.
`linked_products_from`	Filter by Linked Products From.
`linked_products`	Filter by Linked Products.
`open_deliveries_from`	Filter by Open Deliveries From.
`open_deliveries_to`	Filter by Open Deliveries To.
`open_purchase_order_from`	Filter by Open Purchase Order From.
`open_purchase_order_to`	Filter by Open Purchase Order To.
`custom_field_id`	Filter by Custom Field Id.
`custom_field_value`	Filter by Custom Field Value.
`nested_custom_field_excluded`	Filter by Nested Custom Field Excluded.
`custom_fields`	Filter by Custom Fields.
`postcode`	Filter by Postcode.
`import_ids`	Filter by Import Ids.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

supplierContacts
supplierContacts.contact
supplierAddresses
supplierAddresses.address
supplierAddresses.address.country
contact
contact.currency
tags
tags.tag
notes
statistic
purchasingSettings
fileManager
archivedBy
purchaseOrders
purchaseOrders.items
purchaseOrders.items.inventory
purchaseOrders.items.inventory.meta
registrationDetails
deliveries
deliveries.items
deliveries.items.inventory
deliveries.items.inventory.meta
linkedInventories
customFields
customFields.customFieldOption

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Archived.

\n","type":"text/plain"},"key":"archived","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Tags.

\n","type":"text/plain"},"key":"tags","value":""},{"disabled":true,"description":{"content":"

Filter by Last Ordered Date From.

\n","type":"text/plain"},"key":"last_ordered_date_from","value":""},{"disabled":true,"description":{"content":"

Filter by Last Ordered Date To.

\n","type":"text/plain"},"key":"last_ordered_date_to","value":""},{"disabled":true,"description":{"content":"

Filter by Linked Products From.

\n","type":"text/plain"},"key":"linked_products_from","value":""},{"disabled":true,"description":{"content":"

Filter by Linked Products.

\n","type":"text/plain"},"key":"linked_products","value":""},{"disabled":true,"description":{"content":"

Filter by Open Deliveries From.

\n","type":"text/plain"},"key":"open_deliveries_from","value":""},{"disabled":true,"description":{"content":"

Filter by Open Deliveries To.

\n","type":"text/plain"},"key":"open_deliveries_to","value":""},{"disabled":true,"description":{"content":"

Filter by Open Purchase Order From.

\n","type":"text/plain"},"key":"open_purchase_order_from","value":""},{"disabled":true,"description":{"content":"

Filter by Open Purchase Order To.

\n","type":"text/plain"},"key":"open_purchase_order_to","value":""},{"disabled":true,"description":{"content":"

Filter by Custom Field Id.

\n","type":"text/plain"},"key":"custom_field_id","value":""},{"disabled":true,"description":{"content":"

Filter by Custom Field Value.

\n","type":"text/plain"},"key":"custom_field_value","value":""},{"disabled":true,"description":{"content":"

Filter by Nested Custom Field Excluded.

\n","type":"text/plain"},"key":"nested_custom_field_excluded","value":""},{"disabled":true,"description":{"content":"

Filter by Custom Fields.

\n","type":"text/plain"},"key":"custom_fields","value":""},{"disabled":true,"description":{"content":"

Filter by Postcode.

\n","type":"text/plain"},"key":"postcode","value":""},{"disabled":true,"description":{"content":"

Filter by Import Ids.

\n","type":"text/plain"},"key":"import_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - supplierContacts - supplierContacts.contact - supplierAddresses - supplierAddresses.address - supplierAddresses.address.country - contact - contact.currency - tags - tags.tag - notes - statistic - purchasingSettings - fileManager - archivedBy - purchaseOrders - purchaseOrders.items - purchaseOrders.items.inventory - purchaseOrders.items.inventory.meta - registrationDetails - deliveries - deliveries.items - deliveries.items.inventory - deliveries.items.inventory.meta - linkedInventories - customFields - customFields.customFieldOption

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"cbf866c6-cf92-4494-ba72-e69a12b979f5"},{"name":"Suppliers create","id":"cb0c53dd-da91-4940-bf08-90524d5068ac","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"name\": \"name\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"url\": \"\",\n \"file_manager_id\": \"{{file_manager_id}}\",\n \"registration_number\": \"\",\n \"tags\": [\n \"tag\"\n ],\n \"settings\": {\n \"currency_id\": \"{{currency_id}}\",\n \"lead_time\": 1,\n \"lead_time_type\": 1,\n \"minimum_order_value\": 0,\n \"default_delivery_cost\": 0,\n \"payment_terms\": 0\n },\n \"details\": {\n \"registration_number\": \"\",\n \"tax_id\": \"{{tax_id}}\",\n \"eori\": \"\"\n },\n \"contacts\": [\n {\n \"name\": \"name\",\n \"surname\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"title\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"company_name\": \"\",\n \"address_line_1\": \"address_line_1\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"city\": \"city\",\n \"county\": \"\",\n \"country_id\": \"{{country_id}}\",\n \"postcode\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//suppliers","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`email`	string \| null	no	—
`phone`	string \| null	no	—
`url`	string \| null	no	—
`file_manager_id`	string \| null	no	—
`registration_number`	string \| null	no	—
`tags`	array \| null	no	—
`settings`	object	yes	—
`settings.currency_id`	integer	yes	—
`settings.lead_time`	number \| null	no	—
`settings.lead_time_type`	integer	no	Allowed: `1`
`settings.minimum_order_value`	number \| null	no	—
`settings.default_delivery_cost`	number \| null	no	—
`settings.payment_terms`	integer \| null	no	—
`details`	object	no	—
`details.registration_number`	string \| null	no	—
`details.tax_id`	string \| null	no	—
`details.eori`	string \| null	no	—
`contacts`	array \| null	no	—
`contacts.*.name`	string	yes	—
`contacts.*.surname`	string \| null	no	—
`contacts.*.email`	string \| null	no	—
`contacts.*.phone`	string \| null	no	—
`contacts.*.title`	string \| null	no	—
`addresses`	array \| null	no	—
`addresses.*.company_name`	string \| null	no	—
`addresses.*.address_line_1`	string	yes	—
`addresses.*.address_line_2`	string \| null	no	—
`addresses.*.address_line_3`	string \| null	no	—
`addresses.*.city`	string	yes	—
`addresses.*.county`	string \| null	no	—
`addresses.*.country_id`	integer	yes	—
`addresses.*.postcode`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`supplierID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

supplierContacts
supplierContacts.contact
supplierAddresses
supplierAddresses.address
supplierAddresses.address.country
contact
contact.currency
tags
tags.tag
notes
statistic
purchasingSettings
fileManager
archivedBy
purchaseOrders
purchaseOrders.items
purchaseOrders.items.inventory
purchaseOrders.items.inventory.meta
registrationDetails
deliveries
deliveries.items
deliveries.items.inventory
deliveries.items.inventory.meta
linkedInventories
customFields
customFields.customFieldOption

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"e122d3b5-07c1-45db-9294-fb23e32e670d","type":"any","value":"","key":"supplierID"}]}},"response":[],"_postman_id":"176bec29-2db6-4c18-a17f-40ff080d22e3"},{"name":"Suppliers update","id":"c3b9f5dc-b25a-4fc0-aad2-774fd7e3fa44","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"supplier_id\": \"{{supplier_id}}\",\n \"name\": \"name\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"url\": \"\",\n \"registration_number\": \"\",\n \"tags\": [\n \"tag\"\n ],\n \"settings\": {\n \"currency_id\": \"{{currency_id}}\",\n \"lead_time\": 1,\n \"lead_time_type\": 1,\n \"minimum_order_value\": 0,\n \"default_delivery_cost\": 0,\n \"payment_terms\": 0\n },\n \"details\": {\n \"registration_number\": \"\",\n \"tax_id\": \"{{tax_id}}\",\n \"eori\": \"\"\n },\n \"contacts\": [\n {\n \"id\": null,\n \"name\": \"name\",\n \"surname\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"title\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"id\": null,\n \"company_name\": \"\",\n \"address_line_1\": \"address_line_1\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"city\": \"city\",\n \"county\": \"\",\n \"country_id\": \"{{country_id}}\",\n \"postcode\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//suppliers/:supplierID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`supplierID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`supplier_id`	string	yes	—
`name`	string	yes	—
`email`	string \| null	no	—
`phone`	string \| null	no	—
`url`	string \| null	no	—
`registration_number`	string \| null	no	—
`tags`	array \| null	no	—
`settings`	object	yes	—
`settings.currency_id`	integer	yes	—
`settings.lead_time`	number \| null	no	—
`settings.lead_time_type`	integer	no	Allowed: `1`
`settings.minimum_order_value`	number \| null	no	—
`settings.default_delivery_cost`	number \| null	no	—
`settings.payment_terms`	integer \| null	no	—
`details`	object	no	—
`details.registration_number`	string \| null	no	—
`details.tax_id`	string \| null	no	—
`details.eori`	string \| null	no	—
`contacts`	array \| null	no	—
`contacts.*.id`	integer \| null	no	—
`contacts.*.name`	string	yes	—
`contacts.*.surname`	string \| null	no	—
`contacts.*.email`	string \| null	no	—
`contacts.*.phone`	string \| null	no	—
`contacts.*.title`	string \| null	no	—
`addresses`	array \| null	no	—
`addresses.*.id`	integer \| null	no	—
`addresses.*.company_name`	string \| null	no	—
`addresses.*.address_line_1`	string	yes	—
`addresses.*.address_line_2`	string \| null	no	—
`addresses.*.address_line_3`	string \| null	no	—
`addresses.*.city`	string	yes	—
`addresses.*.county`	string \| null	no	—
`addresses.*.country_id`	integer	yes	—
`addresses.*.postcode`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`supplierID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`supplierID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`supplierID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`supplierID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`supplier_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`supplierID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`currency_id`	integer	yes	—
`supplier_id`	integer	yes	—
`lead_time`	number \| null	no	—
`lead_time_type`	integer	no	Unit of `lead_time`; required when `lead_time` has a value. Only `1` (day) is accepted. Allowed: `1`
`minimum_order_value`	number \| null	no	—
`default_delivery_cost`	number \| null	no	—
`payment_terms`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`supplierID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`supplier_id`	integer	yes	—
`registration_number`	string \| null	no	—
`tax_id`	string \| null	no	—
`eori`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`supplierID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`archive`	Filter by Archive.
`supplier_id`	Filter by Supplier Id.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

supplier
supplier.contact
supplier.contact.currency
address
address.country
archivedBy

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Archive.

\n","type":"text/plain"},"key":"archive","value":""},{"disabled":true,"description":{"content":"

Filter by Supplier Id.

\n","type":"text/plain"},"key":"supplier_id","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - supplier - supplier.contact - supplier.contact.currency - address - address.country - archivedBy

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"b8e5f6f3-0e91-4f2f-a209-20ae64deb776","type":"any","value":"","key":"supplierID"}]}},"response":[],"_postman_id":"ccb07dd9-9daa-4dc1-9859-4b6c93245be8"},{"name":"Suppliers addresses create","id":"33fc9cc9-56b5-4da3-9b97-4ca2589c6ab4","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"supplier_id\": \"{{supplier_id}}\",\n \"company_name\": \"\",\n \"address_line_1\": \"address_line_1\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"city\": \"city\",\n \"county\": \"\",\n \"country_id\": \"{{country_id}}\",\n \"postcode\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//suppliers/:supplierID/addresses","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`supplierID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`supplier_id`	integer	yes	—
`company_name`	string \| null	no	—
`address_line_1`	string	yes	—
`address_line_2`	string \| null	no	—
`address_line_3`	string \| null	no	—
`city`	string	yes	—
`county`	string \| null	no	—
`country_id`	integer	yes	—
`postcode`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`supplierID`	integer	yes
`addressID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

supplier
supplier.contact
supplier.contact.currency
address
address.country
archivedBy

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"1a20e7a4-c096-49f1-8eae-72ff67852996","type":"any","value":"","key":"supplierID"},{"id":"bba6e8e0-71bb-48f6-9af9-0b209e603aef","type":"any","value":"","key":"addressID"}]}},"response":[],"_postman_id":"4b996f54-179e-4149-ac2e-f2bfb1dd23f7"},{"name":"Suppliers addresses update","id":"8cee755c-0e6b-4ab7-b1c5-bdd8a1ce4b6b","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"supplier_id\": \"{{supplier_id}}\",\n \"address_id\": \"{{address_id}}\",\n \"company_name\": \"\",\n \"address_line_1\": \"address_line_1\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"city\": \"city\",\n \"county\": \"\",\n \"country_id\": \"{{country_id}}\",\n \"postcode\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//suppliers/:supplierID/addresses/:addressID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`supplierID`	integer	yes
`addressID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`supplier_id`	integer	yes	—
`address_id`	integer	yes	—
`company_name`	string \| null	no	—
`address_line_1`	string	yes	—
`address_line_2`	string \| null	no	—
`address_line_3`	string \| null	no	—
`city`	string	yes	—
`county`	string \| null	no	—
`country_id`	integer	yes	—
`postcode`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`supplierID`	integer	yes
`addressID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`supplier_id`	integer	yes	—
`address_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`supplierID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`archive`	Filter by Archive.
`supplier_id`	Filter by Supplier Id.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

supplier
supplier.contact
supplier.contact.currency
contact
archivedBy
fileManager

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Archive.

\n","type":"text/plain"},"key":"archive","value":""},{"disabled":true,"description":{"content":"

Filter by Supplier Id.

\n","type":"text/plain"},"key":"supplier_id","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"a25b27e1-335d-4452-b45f-028ae272d8cb","type":"any","value":"","key":"supplierID"}]}},"response":[],"_postman_id":"f0784afc-5fd9-4a25-8432-9e69801c7135"},{"name":"Suppliers contacts create","id":"1b967731-def9-47f7-9fb7-2ee6bc638e80","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"supplier_id\": \"{{supplier_id}}\",\n \"name\": \"name\",\n \"surname\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"title\": \"\",\n \"file_manager_id\": \"{{file_manager_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//suppliers/:supplierID/contacts","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`supplierID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`supplier_id`	integer	yes	—
`name`	string	yes	—
`surname`	string \| null	no	—
`email`	string \| null	no	—
`phone`	string \| null	no	—
`title`	string \| null	no	—
`file_manager_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`supplierID`	integer	yes
`contactID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

supplier
supplier.contact
supplier.contact.currency
contact
archivedBy
fileManager

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"4ccd4b84-e202-48dd-bfae-c99bcbe19c3e","type":"any","value":"","key":"supplierID"},{"id":"d983ebc3-3c9f-4e3b-bd09-13d9743b3b19","type":"any","value":"","key":"contactID"}]}},"response":[],"_postman_id":"3685b875-b416-42f5-a1e4-214f4948a55d"},{"name":"Suppliers contacts update","id":"533f49e8-c4f9-4760-91e6-a93e061f667b","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"supplier_id\": \"{{supplier_id}}\",\n \"contact_id\": \"{{contact_id}}\",\n \"name\": \"name\",\n \"surname\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"title\": \"\",\n \"file_manager_id\": \"{{file_manager_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//suppliers/:supplierID/contacts/:contactID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`supplierID`	integer	yes
`contactID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`supplier_id`	integer	yes	—
`contact_id`	integer	yes	—
`name`	string	yes	—
`surname`	string \| null	no	—
`email`	string \| null	no	—
`phone`	string \| null	no	—
`title`	string \| null	no	—
`file_manager_id`	integer \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`supplierID`	integer	yes
`contactID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`supplier_id`	—
`contact_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`supplierID`	integer	yes
`contactID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`supplier_id`	integer	yes	—
`contact_id`	integer	yes	—

Every inventory_id listed here is one POST /purchase-orders accepts in\nitems[] for this supplier: links to group and service-charge products,\nwhich purchase order create rejects, are filtered out rather than\nadvertised, and so are deleted products. Purchase order create does apply\none further condition this endpoint does not, on the supplier rather than\nthe product: it refuses an archived or deleted supplier outright. Such a\nsupplier still lists its links here, because the links are real; nothing\ncan be ordered against it until it is restored.\nAdding lines later through POST /purchase-orders/{id}/items is stricter\nstill: it also rejects a batch-expired product, which this list does not\nfilter out.

Alongside inventory_id each row carries the agreed purchasing terms:\nsupplier_code, item_cost, currency_id, lead_time,\nlead_time_type, minimum_order_quantity and priority. Pass\n?includes=inventory for the product itself and\n?includes=inventoryContainer for the packaging link.

Filterable on inventory_id, currency_id, supplier_code,\nitem_cost_from / item_cost_to and lead_time_from / lead_time_to,\nand paginated on the v2 default cursor contract. Sortable on id and\ncreated_at; default order: link id ascending.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`supplierID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`inventory_id`	Filter by Inventory Id.
`supplier_id`	Filter by Supplier Id.
`currency_id`	Filter by Currency Id.
`supplier_code`	Filter by Supplier Code.
`item_cost_from`	Filter by Item Cost From.
`item_cost_to`	Filter by Item Cost To.
`lead_time_from`	Filter by Lead Time From.
`lead_time_to`	Filter by Lead Time To.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

inventory
supplier
supplier.contact
supplier.purchasingSettings
supplier.fileManager
inventoryContainer

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Inventory Id.

\n","type":"text/plain"},"key":"inventory_id","value":""},{"disabled":true,"description":{"content":"

Filter by Supplier Id.

\n","type":"text/plain"},"key":"supplier_id","value":""},{"disabled":true,"description":{"content":"

Filter by Currency Id.

\n","type":"text/plain"},"key":"currency_id","value":""},{"disabled":true,"description":{"content":"

Filter by Supplier Code.

\n","type":"text/plain"},"key":"supplier_code","value":""},{"disabled":true,"description":{"content":"

Filter by Item Cost From.

\n","type":"text/plain"},"key":"item_cost_from","value":""},{"disabled":true,"description":{"content":"

Filter by Item Cost To.

\n","type":"text/plain"},"key":"item_cost_to","value":""},{"disabled":true,"description":{"content":"

Filter by Lead Time From.

\n","type":"text/plain"},"key":"lead_time_from","value":""},{"disabled":true,"description":{"content":"

Filter by Lead Time To.

\n","type":"text/plain"},"key":"lead_time_to","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"0ebd9b97-b442-4a0d-9893-4bda6147cb09","type":"any","value":"","key":"supplierID"}]}},"response":[],"_postman_id":"61bca7f2-a6e1-45f5-b178-a191f0edc99a"},{"name":"Suppliers notes list","id":"989c1c0c-f707-4eee-aecc-0148b634b51c","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//suppliers/:supplierID/notes","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`supplierID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`supplier_id`	Filter by Supplier Id.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

supplier
user
deletedBy

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Supplier Id.

\n","type":"text/plain"},"key":"supplier_id","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - supplier - user - deletedBy

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"e9069634-5417-45d7-b61b-663789e6d8ff","type":"any","value":"","key":"supplierID"}]}},"response":[],"_postman_id":"989c1c0c-f707-4eee-aecc-0148b634b51c"},{"name":"Suppliers notes create","id":"272f8884-c41d-4d95-9e39-2b695e9208c7","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"supplier_id\": \"{{supplier_id}}\",\n \"note\": \"note\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//suppliers/:supplierID/notes","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`supplierID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`supplier_id`	integer	yes	—
`note`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`supplier_ids[]`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`supplierID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`supplier_id`	Filter by Supplier Id.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

company
supplier
tag

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Supplier Id.

\n","type":"text/plain"},"key":"supplier_id","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - company - supplier - tag

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"740ae7c4-ac8d-4d69-9b7d-e65d365bde29","type":"any","value":"","key":"supplierID"}]}},"response":[],"_postman_id":"a4c79391-a80e-4b2a-8f7d-a7fc512ac9f3"},{"name":"Suppliers tags create","id":"bf7df08b-e9a9-40b8-8329-269b443c84f4","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"supplier_id\": \"{{supplier_id}}\",\n \"name\": \"name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//suppliers/:supplierID/tags","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`supplierID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`supplier_id`	integer	yes	—
`name`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`supplierID`	integer	yes
`tagID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`supplier_id`	integer	yes	—
`tag_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`supplierID`	integer	yes
`tagID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`supplier_id`	—
`tag_id`	—

Suppliers — 35 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"83da4d6e-f1c7-478e-9b3a-2358e1b4b6ac","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Tax Groups","item":[{"name":"Tax groups bulk create","id":"82b14525-5909-4c9a-8f55-13190280fd10","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"tax_groups\": [\n {\n \"name\": \"name\",\n \"description\": \"\",\n \"parameters\": [\n {\n \"country_id\": \"{{country_id}}\",\n \"region\": [\n 0\n ],\n \"tax_rate\": \"tax_rate\"\n }\n ],\n \"status\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//tax-groups/bulk-create","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`tax_groups`	array	yes	—
`tax_groups.*.name`	string	yes	—
`tax_groups.*.description`	string \| null	no	—
`tax_groups.*.parameters`	array	yes	—
`tax_groups..parameters..country_id`	integer	yes	—
`tax_groups..parameters..region`	array	yes	—
`tax_groups..parameters..tax_rate`	string	yes	—
`tax_groups.*.status`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`tax_groups`	array	yes	—
`tax_groups.*.tax_group_id`	integer	yes	—
`tax_groups.*.parameters`	array	yes	—
`tax_groups..parameters..country_id`	integer	yes	—
`tax_groups..parameters..region`	array	yes	—
`tax_groups..parameters..tax_rate`	string	yes	—
`tax_groups.*.status`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`tax_group_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`status`	Filter by Status.
`search`	Filter by Search.
`name`	Filter by Name.
`countries`	Filter by Countries.
`tax_rate`	Filter by Tax Rate.
`tax_rate_from`	Filter by Tax Rate From.
`tax_rate_to`	Filter by Tax Rate To.
`regions`	Filter by Regions.
`nested_regions_excluded`	Filter by Nested Regions Excluded.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

companies

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Search.

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Countries.

\n","type":"text/plain"},"key":"countries","value":""},{"disabled":true,"description":{"content":"

Filter by Tax Rate.

\n","type":"text/plain"},"key":"tax_rate","value":""},{"disabled":true,"description":{"content":"

Filter by Tax Rate From.

\n","type":"text/plain"},"key":"tax_rate_from","value":""},{"disabled":true,"description":{"content":"

Filter by Tax Rate To.

\n","type":"text/plain"},"key":"tax_rate_to","value":""},{"disabled":true,"description":{"content":"

Filter by Regions.

\n","type":"text/plain"},"key":"regions","value":""},{"disabled":true,"description":{"content":"

Filter by Nested Regions Excluded.

\n","type":"text/plain"},"key":"nested_regions_excluded","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - companies

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"559514cf-92d4-4a99-a947-bab7a5e5b1c5"},{"name":"Tax groups create","id":"970d63f6-7894-4c27-a56c-e50c7ba0737e","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"name\": \"name\",\n \"description\": \"\",\n \"status\": false,\n \"parameters\": [\n {\n \"country_id\": \"{{country_id}}\",\n \"region\": [\n 0\n ],\n \"tax_rate\": \"tax_rate\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//tax-groups","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`description`	string \| null	no	—
`status`	boolean	yes	—
`parameters`	array	yes	—
`parameters.*.country_id`	integer	yes	—
`parameters.*.region`	array \| null	no	—
`parameters.*.tax_rate`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`taxGroupID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`taxGroupID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`tax_group_id`	integer	yes	—
`name`	string	yes	—
`description`	string \| null	no	—
`status`	boolean	yes	—
`parameters`	array	yes	—
`parameters.*.country_id`	integer	yes	—
`parameters.*.region`	array	yes	—
`parameters.*.tax_rate`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`taxGroupID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`tax_group_id`	integer	yes	—
`name`	string	yes	—
`description`	string \| null	no	—
`status`	boolean	yes	—
`parameters`	array	yes	—
`parameters.*.country_id`	integer	yes	—
`parameters.*.region`	array	yes	—
`parameters.*.tax_rate`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`taxGroupID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`tax_group_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`term`	—
`ignore_ids[]`	—
`is_archived`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`taxGroupID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`tax_group_id`	integer	yes	—

Tax Groups — 11 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"a6370858-7cb7-4506-b2a8-9f005cf726dc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Timezones","item":[{"name":"Display a listing of every timezone","id":"0494d493-108b-489d-9d31-5648881208b0","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//timezones","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"0494d493-108b-489d-9d31-5648881208b0"},{"name":"Display the specified timezone","id":"c75b2fa7-b5b1-4fad-a940-2b01c7fd2f5c","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//timezones/:timezoneID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`timezoneID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Timezones — 2 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"ab43bf1b-5923-4ddb-88fd-237ccf892f8a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Users","item":[{"name":"Users invites list","id":"10c1e5ba-7aa0-48bb-8683-f1715669246a","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//users/invites","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`ids`	Filter by Ids.
`query`	Filter by Query.
`name`	Filter by Name.
`email`	Filter by Email.

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Email.

\n","type":"text/plain"},"key":"email","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"10c1e5ba-7aa0-48bb-8683-f1715669246a"},{"name":"Users invites delete","id":"db256a6a-3ca7-4ea8-a9ea-8b2ca6f3f4a2","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//users/invites/:invitationID?company_id=&invitation_id=","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`invitationID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`invitation_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`invitationID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`invitation_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`ids`	Filter by Ids.
`name`	Filter by Name.
`email`	Filter by Email.
`status`	Filter by Status.
`role`	Filter by Role.
`last_login_from`	Filter by Last Login From.
`last_login_to`	Filter by Last Login To.
`id`	Filter by Id.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Email.

\n","type":"text/plain"},"key":"email","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Role.

\n","type":"text/plain"},"key":"role","value":""},{"disabled":true,"description":{"content":"

Filter by Last Login From.

\n","type":"text/plain"},"key":"last_login_from","value":""},{"disabled":true,"description":{"content":"

Filter by Last Login To.

\n","type":"text/plain"},"key":"last_login_to","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"2ae40cc7-f78c-4e81-bda5-ed4813161545"},{"name":"Users create","id":"a1e63397-e485-4ec3-be5e-bb2878c23b38","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"name\": \"name\",\n \"file_manager_id\": \"{{file_manager_id}}\",\n \"email\": \"user@example.com\",\n \"password\": \"password\",\n \"role_id\": 0,\n \"timezone_id\": 0,\n \"language_id\": 0,\n \"time\": \"\",\n \"hourly_wage\": 0,\n \"enable_two_factor_auth\": false,\n \"quick_access_code\": [\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//users","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`name`	string	yes	—
`file_manager_id`	string	no	—
`email`	string \| null	no	—
`password`	string	no	—
`role_id`	number	yes	—
`timezone_id`	number	yes	—
`language_id`	number	yes	—
`time`	string	no	—
`hourly_wage`	number \| null	no	—
`enable_two_factor_auth`	boolean	yes	—
`quick_access_code`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`userID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`userID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`user_id`	integer	yes	—
`company_id`	integer	yes	—
`name`	string	yes	—
`email`	string	no	—
`file_manager_id`	string \| null	no	—
`password`	string	no	—
`role_id`	number	yes	—
`timezone_id`	number	yes	—
`language_id`	number	yes	—
`time`	string	no	—
`hourly_wage`	number \| null	no	—
`enable_two_factor_auth`	boolean	yes	—
`quick_access_code`	array	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`userID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`user_id`	—
`company_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`email`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`email`	string	yes	—
`role_id`	integer	yes	—
`timezone_id`	number	yes	—
`language_id`	number	yes	—
`enable_two_factor_auth`	boolean	yes	—
`hourly_wage`	number \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string	yes	—
`company_id`	integer	yes	—
`role_id`	integer	yes	—
`email`	string	yes	—
`timezone_id`	number	yes	—
`language_id`	number	yes	—
`enable_two_factor_auth`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`users`	array	yes	—
`users.*.email`	string	yes	—
`users.*.role_id`	integer	yes	—
`users.*.hourly_wage`	number \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`userID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`user_id`	integer	yes	—
`company_id`	integer	yes	—
`password`	string	yes	—
`password_confirmation`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`userID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`user_id`	integer	yes	—
`company_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`userID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`user_id`	integer	yes	BOLA: user_id must be a MEMBER of the route company, not just any user — otherwise a token could be minted for a foreign user.
`token_name`	string	yes	—
`is_active`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`userID`	integer	yes
`tokenID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`user_id`	integer	yes	—
`token_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`userID`	integer	yes
`tokenID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`user_id`	integer	yes	—
`token_id`	integer	yes	—
`token_name`	string	yes	—
`is_active`	boolean	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`userID`	integer	yes
`tokenID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`user_id`	—
`token_id`	—

Users — 18 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"9dd12207-74fc-4f4e-be79-3edf7d6b0c65","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Warehouses","item":[{"name":"Warehouses locations location types","id":"13a67929-80f1-493e-8a85-584b06675b9e","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//warehouses/warehouse/:warehouse_id/locations/location-types","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouse_id`	string	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouse_id`	string	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouse_id`	string	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouse_id`	string	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`locations`	array	yes	—
`locations.*.zone_id`	integer \| null	no	—
`locations.*.sequence_number`	integer \| null	no	—
`locations.*.code`	string	yes	—
`locations.*.category_id`	integer \| null	no	—
`locations.*.dedicated_location_id`	integer \| null	no	—
`locations.*.settings`	object	yes	—
`locations.*.settings.storage_type`	array	yes	—
`locations.*.settings.location_type`	string	yes	LocationTypes values: - `1` = STORAGE - `2` = SORT_WALL - `3` = GOODS_IN - `4` = RETURNS - `5` = ASSEMBLY - `6` = GOODS_OUT Allowed: `1`, `2`, `3`, `4`, `5`, `6`
`locations.*.settings.colour_type`	string \| null	no	LocationColourTypes values: - `1` = RED - `2` = GREEN - `3` = YELLOW - `4` = BLUE - `5` = ORANGE - `6` = PURPLE - `7` = PINK - `8` = BROWN - `9` = MINT - `10` = BEIGE - `11` = CYAN - `12` = NAVY - `13` = MAROON - `14` = BLACK - `15` = GRAY - `16` = WHITE Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`
`locations.*.settings.description`	string \| null	no	—
`locations.*.settings.max_stock_quantity`	number \| null	no	—
`locations.*.settings.length`	number \| null	no	—
`locations.*.settings.width`	number \| null	no	—
`locations.*.settings.height`	number \| null	no	—
`locations.*.settings.exclude_qty_from_available`	boolean \| null	no	—
`locations.*.settings.force_elp`	boolean \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouse_id`	string	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`locations`	array	yes	—
`locations.*.zone_id`	integer \| null	no	—
`locations.*.location_id`	integer	yes	—
`locations.*.dedicated_location_id`	integer \| null	no	—
`locations.*.sequence_number`	integer	yes	—
`locations.*.code`	string	yes	—
`locations.*.category_id`	integer \| null	no	—
`locations.*.settings`	object	yes	—
`locations.*.settings.storage_type`	array	yes	—
`locations.*.settings.location_type`	string	yes	LocationTypes values: - `1` = STORAGE - `2` = SORT_WALL - `3` = GOODS_IN - `4` = RETURNS - `5` = ASSEMBLY - `6` = GOODS_OUT Allowed: `1`, `2`, `3`, `4`, `5`, `6`
`locations.*.settings.colour_type`	string \| null	no	LocationColourTypes values: - `1` = RED - `2` = GREEN - `3` = YELLOW - `4` = BLUE - `5` = ORANGE - `6` = PURPLE - `7` = PINK - `8` = BROWN - `9` = MINT - `10` = BEIGE - `11` = CYAN - `12` = NAVY - `13` = MAROON - `14` = BLACK - `15` = GRAY - `16` = WHITE Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`
`locations.*.settings.description`	string \| null	no	—
`locations.*.settings.max_stock_quantity`	number \| null	no	—
`locations.*.settings.length`	number \| null	no	—
`locations.*.settings.width`	number \| null	no	—
`locations.*.settings.height`	number \| null	no	—
`locations.*.settings.exclude_qty_from_available`	boolean \| null	no	—
`locations.*.settings.force_elp`	boolean \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouse_id`	string	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`location_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouse_id`	string	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

Parameter	Description
`includes_count`	—
`query`	Filter by Query.
`import_ids`	Filter by Import Ids.
`name`	Filter by Name.
`location`	Filter by Location.
`warehouse_id`	Filter by Warehouse Id.
`zone_id`	Filter by Zone Id.
`items_count`	Filter by Items Count.
`items_count_from`	Filter by Items Count From.
`items_count_to`	Filter by Items Count To.
`empty`	Filter by Empty.
`visit_order_from`	Filter by Visit Order From.
`visit_order_to`	Filter by Visit Order To.
`visit_order`	Filter by Visit Order.
`exclude_qty_from_available`	Filter by Exclude Qty From Available.
`force_elp`	Filter by Force Elp.
`location_type`	Filter by Location Type.
`storage_type`	Filter by Storage Type.
`colour`	Filter by Colour.
`category_id`	Filter by Category Id.
`storage_cost_group_id`	Filter by Storage Cost Group Id.
`dedicated_location_id`	Filter by Dedicated Location Id.
`code`	Filter by Code.
`location_code`	Filter by Location Code.
`search`	Filter by Search.
`inventory`	Filter by Inventory.
`inventory_id`	Filter by Inventory Id.
`replenishment_type`	Filter by Replenishment Type.
`items`	Filter by Items.
`nested_location_excluded`	Filter by Nested Location Excluded.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

settings
category
category.category
category.category.parent
zone
stocks
stocks.inventory.meta
stocks.inventory.barcodes
storageTypes
storageCostGroup

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Query.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Filter by Import Ids.

\n","type":"text/plain"},"key":"import_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Location.

\n","type":"text/plain"},"key":"location","value":""},{"disabled":true,"description":{"content":"

Filter by Warehouse Id.

\n","type":"text/plain"},"key":"warehouse_id","value":""},{"disabled":true,"description":{"content":"

Filter by Zone Id.

\n","type":"text/plain"},"key":"zone_id","value":""},{"disabled":true,"description":{"content":"

Filter by Items Count.

\n","type":"text/plain"},"key":"items_count","value":""},{"disabled":true,"description":{"content":"

Filter by Items Count From.

\n","type":"text/plain"},"key":"items_count_from","value":""},{"disabled":true,"description":{"content":"

Filter by Items Count To.

\n","type":"text/plain"},"key":"items_count_to","value":""},{"disabled":true,"description":{"content":"

Filter by Empty.

\n","type":"text/plain"},"key":"empty","value":""},{"disabled":true,"description":{"content":"

Filter by Visit Order From.

\n","type":"text/plain"},"key":"visit_order_from","value":""},{"disabled":true,"description":{"content":"

Filter by Visit Order To.

\n","type":"text/plain"},"key":"visit_order_to","value":""},{"disabled":true,"description":{"content":"

Filter by Visit Order.

\n","type":"text/plain"},"key":"visit_order","value":""},{"disabled":true,"description":{"content":"

Filter by Exclude Qty From Available.

\n","type":"text/plain"},"key":"exclude_qty_from_available","value":""},{"disabled":true,"description":{"content":"

Filter by Force Elp.

\n","type":"text/plain"},"key":"force_elp","value":""},{"disabled":true,"description":{"content":"

Filter by Location Type.

\n","type":"text/plain"},"key":"location_type","value":""},{"disabled":true,"description":{"content":"

Filter by Storage Type.

\n","type":"text/plain"},"key":"storage_type","value":""},{"disabled":true,"description":{"content":"

Filter by Colour.

\n","type":"text/plain"},"key":"colour","value":""},{"disabled":true,"description":{"content":"

Filter by Category Id.

\n","type":"text/plain"},"key":"category_id","value":""},{"disabled":true,"description":{"content":"

Filter by Storage Cost Group Id.

\n","type":"text/plain"},"key":"storage_cost_group_id","value":""},{"disabled":true,"description":{"content":"

Filter by Dedicated Location Id.

\n","type":"text/plain"},"key":"dedicated_location_id","value":""},{"disabled":true,"description":{"content":"

Filter by Code.

\n","type":"text/plain"},"key":"code","value":""},{"disabled":true,"description":{"content":"

Filter by Location Code.

\n","type":"text/plain"},"key":"location_code","value":""},{"disabled":true,"description":{"content":"

Filter by Search.

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

Filter by Inventory.

\n","type":"text/plain"},"key":"inventory","value":""},{"disabled":true,"description":{"content":"

Filter by Inventory Id.

\n","type":"text/plain"},"key":"inventory_id","value":""},{"disabled":true,"description":{"content":"

Filter by Replenishment Type.

\n","type":"text/plain"},"key":"replenishment_type","value":""},{"disabled":true,"description":{"content":"

Filter by Items.

\n","type":"text/plain"},"key":"items","value":""},{"disabled":true,"description":{"content":"

Filter by Nested Location Excluded.

\n","type":"text/plain"},"key":"nested_location_excluded","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - settings - category - category.category - category.category.parent - zone - stocks - stocks.inventory.meta - stocks.inventory.barcodes - storageTypes - storageCostGroup

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"a9fbed9c-fae2-48fc-a9fd-f41575bb3638","type":"any","value":"","key":"warehouse_id"}]}},"response":[],"_postman_id":"e0ba886b-dbcc-4e04-a36d-93d02f47854b"},{"name":"Warehouses locations create","id":"c20b83d7-bc54-4f52-8d51-a4f6fdb87f75","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"warehouse_id\": \"{{warehouse_id}}\",\n \"zone_id\": \"{{zone_id}}\",\n \"copied_from\": 0,\n \"sequence_number\": 0,\n \"code\": \"code\",\n \"category_id\": \"{{category_id}}\",\n \"dedicated_location_id\": \"{{dedicated_location_id}}\",\n \"settings\": {\n \"storage_type\": [\n \"1\"\n ],\n \"location_type\": \"1\",\n \"colour_type\": \"1\",\n \"description\": \"\",\n \"max_stock_quantity\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"exclude_qty_from_available\": false,\n \"force_elp\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//warehouses/warehouse/:warehouseID/locations","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouseID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`zone_id`	integer \| null	no	—
`copied_from`	integer \| null	no	—
`sequence_number`	integer \| null	no	—
`code`	string	yes	—
`category_id`	integer \| null	no	—
`dedicated_location_id`	integer \| null	no	—
`settings`	object	yes	—
`settings.storage_type`	array	yes	—
`settings.location_type`	string	yes	LocationTypes values: - `1` = STORAGE - `2` = SORT_WALL - `3` = GOODS_IN - `4` = RETURNS - `5` = ASSEMBLY - `6` = GOODS_OUT Allowed: `1`, `2`, `3`, `4`, `5`, `6`
`settings.colour_type`	string \| null	no	LocationColourTypes values: - `1` = RED - `2` = GREEN - `3` = YELLOW - `4` = BLUE - `5` = ORANGE - `6` = PURPLE - `7` = PINK - `8` = BROWN - `9` = MINT - `10` = BEIGE - `11` = CYAN - `12` = NAVY - `13` = MAROON - `14` = BLACK - `15` = GRAY - `16` = WHITE Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`
`settings.description`	string \| null	no	—
`settings.max_stock_quantity`	number \| null	no	—
`settings.length`	number \| null	no	—
`settings.width`	number \| null	no	—
`settings.height`	number \| null	no	—
`settings.exclude_qty_from_available`	boolean \| null	no	—
`settings.force_elp`	boolean \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`warehouseID`	integer	yes
`locationID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

settings
category
category.category
category.category.parent
zone
stocks
stocks.inventory.meta
stocks.inventory.barcodes
storageTypes
storageCostGroup

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"188eb895-a97e-4a08-ab51-c39fb1c4fd98","type":"any","value":"","key":"warehouseID"},{"id":"01d6552a-d4e2-46e8-918c-c8ee1308087f","type":"any","value":"","key":"locationID"}]}},"response":[],"_postman_id":"508664d8-9455-4dea-874c-31ae86ce445a"},{"name":"Warehouses locations update","id":"8d806c50-fd18-4c7a-8018-5394c0443384","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"warehouse_id\": \"{{warehouse_id}}\",\n \"zone_id\": \"{{zone_id}}\",\n \"location_id\": \"{{location_id}}\",\n \"dedicated_location_id\": \"{{dedicated_location_id}}\",\n \"sequence_number\": 0,\n \"code\": \"code\",\n \"category_id\": \"{{category_id}}\",\n \"settings\": {\n \"storage_type\": [\n \"1\"\n ],\n \"location_type\": \"1\",\n \"colour_type\": \"1\",\n \"description\": \"\",\n \"max_stock_quantity\": 0,\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"exclude_qty_from_available\": false,\n \"force_elp\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//warehouses/warehouse/:warehouseID/locations/:locationID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`warehouseID`	integer	yes
`locationID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`zone_id`	integer \| null	no	—
`location_id`	integer	yes	—
`dedicated_location_id`	integer \| null	no	—
`sequence_number`	integer	yes	—
`code`	string	yes	—
`category_id`	integer \| null	no	—
`settings`	object	yes	—
`settings.storage_type`	array	yes	—
`settings.location_type`	string	yes	LocationTypes values: - `1` = STORAGE - `2` = SORT_WALL - `3` = GOODS_IN - `4` = RETURNS - `5` = ASSEMBLY - `6` = GOODS_OUT Allowed: `1`, `2`, `3`, `4`, `5`, `6`
`settings.colour_type`	string \| null	no	LocationColourTypes values: - `1` = RED - `2` = GREEN - `3` = YELLOW - `4` = BLUE - `5` = ORANGE - `6` = PURPLE - `7` = PINK - `8` = BROWN - `9` = MINT - `10` = BEIGE - `11` = CYAN - `12` = NAVY - `13` = MAROON - `14` = BLACK - `15` = GRAY - `16` = WHITE Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`
`settings.description`	string \| null	no	—
`settings.max_stock_quantity`	number \| null	no	—
`settings.length`	number \| null	no	—
`settings.width`	number \| null	no	—
`settings.height`	number \| null	no	—
`settings.exclude_qty_from_available`	boolean \| null	no	—
`settings.force_elp`	boolean \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`warehouseID`	integer	yes
`locationID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`warehouse_id`	—
`location_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouseID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`warehouse_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouseID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`locations`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`warehouseID`	integer	yes
`locationID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`zone_id`	integer \| null	no	—
`location_id`	integer	yes	—
`exclude_qty_from_available`	boolean \| null	no	—
`force_elp`	boolean \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`warehouseID`	integer	yes
`locationID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`warehouseID`	integer	yes
`locationID`	integer	yes
`categoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`category_id`	integer	yes	—
`location_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`warehouseID`	integer	yes
`locationID`	integer	yes
`categoryID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`category_id`	integer	yes	—
`location_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`warehouseID`	integer	yes
`categoryID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouseID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`categories`	array	yes	—
`categories.*.name`	string	yes	—
`categories.*.parent_id`	integer \| null	no	—
`categories.*.description`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouseID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`categories`	array	yes	—
`categories.*.description`	string \| null	no	—
`categories.*.name`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouseID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`categories`	array	yes	—
`categories.*.id`	integer	yes	—
`categories.*.description`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

settings
settings.address
settings.contact
settings.address.country
settings.pickedLocation
settings.deliveryLocation
settings.assemblyLocation
settings.returnLocation
contacts
contacts.user
locations

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - settings - settings.address - settings.contact - settings.address.country - settings.pickedLocation - settings.deliveryLocation - settings.assemblyLocation - settings.returnLocation - contacts - contacts.user - locations

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"b60bc84b-799b-402b-b13e-7046e3371a00"},{"name":"Warehouses show","id":"273fd614-6d5a-48be-9b56-8a33f36de48b","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//warehouses/:warehouseID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouseID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

settings
settings.address
settings.contact
settings.address.country
settings.pickedLocation
settings.deliveryLocation
settings.assemblyLocation
settings.returnLocation
contacts
contacts.user
locations

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"1af1e109-ada8-4691-a220-5739496262d0","type":"any","value":"","key":"warehouseID"}]}},"response":[],"_postman_id":"273fd614-6d5a-48be-9b56-8a33f36de48b"},{"name":"Warehouses update","id":"6543ff03-972b-4216-8ebb-3c39bcedb2ab","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"warehouse_id\": \"{{warehouse_id}}\",\n \"name\": \"name\",\n \"settings\": {\n \"location_structure\": \"1\",\n \"description\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//warehouses/:warehouseID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouseID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`name`	string	yes	—
`settings`	object	no	—
`settings.location_structure`	string	no	Allowed: `1`, `2`
`settings.description`	string \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouseID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`picked_location_id`	integer	yes	—
`delivery_location_id`	integer	yes	—
`assembly_location_id`	integer	yes	—
`return_location_id`	integer	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouseID`	integer	yes

Body parameters

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`stock_control_types`	string	no	Allowed: `2`, `3`
`item_confirmation_type`	string	no	Allowed: `1`, `2`
`stock_control_enabled`	boolean	no	—
`remove_empty_stock_locations`	boolean	no	—
`require_location_scan`	boolean	no	—
`require_tote_scan_in_sorting`	boolean	no	—
`require_item_scan`	boolean	no	—
`allow_product_not_found`	boolean	no	—
`hide_unassigned_jobs`	boolean	no	—
`allow_location_skip`	boolean	no	—
`require_change_reasons`	boolean	no	—
`hide_zones`	boolean	no	—
`opportunity_stock_count`	boolean	no	—
`archive_completed_picks`	boolean	no	—
`archive_completed_delivery`	boolean	no	—
`archive_completed_movement`	boolean	no	—
`enforce_single_batch_per_location`	boolean	no	—
`allow_barcode_reuse`	boolean	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouseID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`warehouse_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouseID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`contact_firstname`	string \| null	no	—
`contact_lastname`	string \| null	no	—
`contact_email`	string \| null	no	—
`contact_phone`	string \| null	no	—
`company_name`	string \| null	no	—
`address_line_1`	string	yes	—
`address_line_2`	string \| null	no	—
`city`	string	yes	—
`county`	string \| null	no	—
`country_id`	integer	yes	—
`postcode`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouseID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`warehouse_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouseID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`contacts`	array	yes	—
`contacts.*.user_id`	integer	yes	—
`contacts.*.role_type`	string	yes	WarehouseContactRoleTypes values: - `1` = MANAGER - `2` = PICKER - `3` = PACKER - `4` = FORKLIFT_OPERATOR Allowed: `1`, `2`, `3`, `4`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouseID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`warehouse_id`	Filter by Warehouse Id.
`role_type`	Filter by Role Type.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

user
user.fileManager

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Warehouse Id.

\n","type":"text/plain"},"key":"warehouse_id","value":""},{"disabled":true,"description":{"content":"

Filter by Role Type.

\n","type":"text/plain"},"key":"role_type","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - user - user.fileManager

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"8c3b9eb2-65f5-41cb-b2ee-2da0742e8904","type":"any","value":"","key":"warehouseID"}]}},"response":[],"_postman_id":"b21e833f-5723-4bf5-ab97-e95b42324229"},{"name":"Warehouses contacts create","id":"c3b66e7e-11cb-4384-8579-926e585fbb8f","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"warehouse_id\": \"{{warehouse_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"role_type\": \"1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//warehouses/warehouse/:warehouseID/contacts","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouseID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`user_id`	integer	yes	—
`role_type`	string	yes	WarehouseContactRoleTypes values: - `1` = MANAGER - `2` = PICKER - `3` = PACKER - `4` = FORKLIFT_OPERATOR Allowed: `1`, `2`, `3`, `4`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`warehouseID`	integer	yes
`contactID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

user
user.fileManager

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - user - user.fileManager

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"d9d700f0-77e0-46a6-8bf2-e0f75bccac6c","type":"any","value":"","key":"warehouseID"},{"id":"b5b29cd3-d01c-41df-8a27-758b683d933e","type":"any","value":"","key":"contactID"}]}},"response":[],"_postman_id":"f4df0f2e-d36a-4d8b-84c3-0992cb082108"},{"name":"Warehouses contacts update","id":"84f5cb6d-8f81-4320-9df9-5545751bd7de","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"warehouse_id\": \"{{warehouse_id}}\",\n \"contact_id\": \"{{contact_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"role_type\": \"1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//warehouses/warehouse/:warehouseID/contacts/:contactID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`warehouseID`	integer	yes
`contactID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`contact_id`	integer	yes	—
`user_id`	integer	yes	—
`role_type`	string	yes	WarehouseContactRoleTypes values: - `1` = MANAGER - `2` = PICKER - `3` = PACKER - `4` = FORKLIFT_OPERATOR Allowed: `1`, `2`, `3`, `4`

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`warehouseID`	integer	yes
`contactID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`warehouse_id`	—
`contact_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouse_id`	string	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`zones`	array	yes	—
`zones.*.name`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouse_id`	string	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`zones`	array	yes	—
`zones.*.zone_id`	integer	yes	—
`zones.*.name`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouse_id`	string	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`zone_ids`	array	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouse_id`	string	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`warehouse_id`	Filter by Warehouse Id.
`name`	Filter by Name.
`location_name`	Filter by Location Name.
`location_type`	Filter by Location Type.
`location_code`	Filter by Location Code.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

locations
locations.settings

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Warehouse Id.

\n","type":"text/plain"},"key":"warehouse_id","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Location Name.

\n","type":"text/plain"},"key":"location_name","value":""},{"disabled":true,"description":{"content":"

Filter by Location Type.

\n","type":"text/plain"},"key":"location_type","value":""},{"disabled":true,"description":{"content":"

Filter by Location Code.

\n","type":"text/plain"},"key":"location_code","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - locations - locations.settings

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"9bd232a7-50bd-40d6-9844-da7cf30f8591","type":"any","value":"","key":"warehouse_id"}]}},"response":[],"_postman_id":"8c4ba094-6c07-488b-912e-454c09f69f81"},{"name":"Warehouses zone create","id":"f6a13ef6-0c11-4835-82ba-92653370d79f","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"warehouse_id\": \"{{warehouse_id}}\",\n \"name\": \"name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//warehouses/warehouse/:warehouseID/zone","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouseID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`name`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`warehouseID`	integer	yes
`zoneID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

locations
locations.settings

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - locations - locations.settings

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"6a582bc7-2fc7-4aba-b7e0-6efcf65789ed","type":"any","value":"","key":"warehouseID"},{"id":"51b35118-2ae5-4bf6-af79-0d4bd28a2a3c","type":"any","value":"","key":"zoneID"}]}},"response":[],"_postman_id":"fcb369b7-739c-4ede-b125-0fc242ef33b2"},{"name":"Warehouses zone update","id":"4f15077a-8946-41b6-b117-4f103388f930","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"\",\n \"warehouse_id\": \"{{warehouse_id}}\",\n \"zone_id\": \"{{zone_id}}\",\n \"name\": \"name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//warehouses/warehouse/:warehouseID/zone/:zoneID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`warehouseID`	integer	yes
`zoneID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`company_id`	integer	yes	—
`warehouse_id`	integer	yes	—
`zone_id`	integer	yes	—
`name`	string	yes	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`warehouseID`	integer	yes
`zoneID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`warehouse_id`	—
`zone_id`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`warehouseID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`company_id`	—
`warehouse_id`	—
`inventory_id`	—
`search`	—
`location_type`	Options: `1`, `2`, `3`, `4`, `5`, `6`
`ignore_ids[]`	—

Warehouses — 46 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"82440de8-1229-4c7a-b8c2-bde871fb92ed","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Webhooks","item":[{"name":"Webhooks list","id":"be85b142-c90c-404b-af36-796bba7bf9a5","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//webhooks","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`filter`	Lift nested filter[] payload to top-level so QueryFilters dispatches correctly.
`name`	Filter by Name.
`event_type`	Filter by Event Type.
`method`	Filter by Method.
`is_active`	Filter by Is Active.
`status`	Filter by Status.
`url`	Filter by Url.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

company
events
jobs

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Lift nested filter[] payload to top-level so QueryFilters dispatches correctly.

\n","type":"text/plain"},"key":"filter","value":""},{"disabled":true,"description":{"content":"

Filter by Name.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Filter by Event Type.

\n","type":"text/plain"},"key":"event_type","value":""},{"disabled":true,"description":{"content":"

Filter by Method.

\n","type":"text/plain"},"key":"method","value":""},{"disabled":true,"description":{"content":"

Filter by Is Active.

\n","type":"text/plain"},"key":"is_active","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Url.

\n","type":"text/plain"},"key":"url","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - company - events - jobs

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"be85b142-c90c-404b-af36-796bba7bf9a5"},{"name":"Webhooks create","id":"e0e98fc4-0239-4513-a4b5-534fff3f41b0","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"name\",\n \"event_type\": 1,\n \"url\": \"url\",\n \"method\": 1,\n \"interval_minutes\": 1,\n \"is_active\": false,\n \"auto_mark_as_synced\": false,\n \"notify_on_job_failure\": false,\n \"notify_on_auto_disabled\": false,\n \"auth_method\": 1,\n \"notification_emails\": [\n \"user@example.com\"\n ],\n \"auth_config\": {\n \"username\": \"\",\n \"password\": \"\",\n \"token\": \"\",\n \"signing_secret\": \"signing_secret\",\n \"signature_header_name\": \"\",\n \"algorithm\": \"sha1\",\n \"include_timestamp\": false,\n \"timestamp_header_name\": \"\"\n },\n \"headers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//webhooks","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`name`	string	yes	—
`event_type`	integer	yes	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`
`url`	string	yes	—
`method`	integer	yes	Allowed: `1`, `2`
`interval_minutes`	integer	yes	Allowed: `1`, `10`, `30`, `60`
`is_active`	boolean	yes	—
`auto_mark_as_synced`	boolean	yes	—
`notify_on_job_failure`	boolean \| null	no	—
`notify_on_auto_disabled`	boolean \| null	no	—
`auth_method`	integer \| null	no	WebhookAuthMethods values: - `1` = BASIC - `2` = BEARER - `3` = HMAC Allowed: `1`, `2`, `3`
`notification_emails`	array \| null	no	—
`auth_config`	object	no	—
`auth_config.username`	string	no	Basic Auth
`auth_config.password`	string	no	—
`auth_config.token`	string	no	Bearer Token
`auth_config.signing_secret`	string	no	HMAC
`auth_config.signature_header_name`	string	no	—
`auth_config.algorithm`	string	no	Allowed: `sha1`, `sha256`, `sha512`
`auth_config.include_timestamp`	boolean \| null	no	—
`auth_config.timestamp_header_name`	string \| null	no	—
`headers`	array \| null	no	—
`headers.*.key`	string	no	—
`headers.*.value`	string	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`webhook_id`	integer \| null	no	Optional: when pinging an existing webhook, the caller sends its id so the backend can restore masked secrets from the stored record.
`url`	string	yes	—
`method`	integer	yes	Allowed: `1`, `2`
`auth_method`	integer \| null	no	WebhookAuthMethods values: - `1` = BASIC - `2` = BEARER - `3` = HMAC Allowed: `1`, `2`, `3`
`auth_config`	object	no	—
`auth_config.username`	string	no	—
`auth_config.password`	string	no	—
`auth_config.token`	string	no	—
`auth_config.signing_secret`	string	no	—
`auth_config.signature_header_name`	string	no	—
`auth_config.algorithm`	string	no	Allowed: `sha1`, `sha256`, `sha512`
`auth_config.include_timestamp`	boolean \| null	no	—
`auth_config.timestamp_header_name`	string \| null	no	—
`headers`	array \| null	no	—
`headers.*.key`	string	no	—
`headers.*.value`	string	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`webhookID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`webhookID`	integer	yes

Body parameters

Field	Type	Required	Description
`name`	string	yes	—
`event_type`	integer	yes	Allowed: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`
`url`	string	yes	—
`method`	integer	yes	Allowed: `1`, `2`
`interval_minutes`	integer	yes	Allowed: `1`, `10`, `30`, `60`
`is_active`	boolean	yes	—
`auto_mark_as_synced`	boolean	yes	—
`notify_on_job_failure`	boolean \| null	no	—
`notify_on_auto_disabled`	boolean \| null	no	—
`auth_method`	integer \| null	no	WebhookAuthMethods values: - `1` = BASIC - `2` = BEARER - `3` = HMAC Allowed: `1`, `2`, `3`
`notification_emails`	array \| null	no	—
`auth_config`	object	no	—
`auth_config.username`	string	no	Basic Auth
`auth_config.password`	string	no	—
`auth_config.token`	string	no	Bearer Token
`auth_config.signing_secret`	string	no	HMAC
`auth_config.signature_header_name`	string	no	—
`auth_config.algorithm`	string	no	Allowed: `sha1`, `sha256`, `sha512`
`auth_config.include_timestamp`	boolean \| null	no	—
`auth_config.timestamp_header_name`	string \| null	no	—
`headers`	array \| null	no	—
`headers.*.key`	string	no	—
`headers.*.value`	string	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`webhookID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`webhookID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`is_active`	boolean \| null	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`webhookID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`filter[status]`	Options: `1`, `2`, `3`
`filter[try_count_min]`	—
`filter[try_count_max]`	—
`filter[last_response_code]`	—
`filter[date_from]`	—
`filter[date_to]`	—
`filter[resource_search]`	—
`webhook_id`	Filter by Webhook Id.
`ids`	Filter by Ids.
`status`	Filter by Status.
`try_count_min`	Filter by Try Count Min.
`try_count_max`	Filter by Try Count Max.
`last_response_code`	Filter by Last Response Code.
`date_from`	Filter by Date From.
`date_to`	Filter by Date To.
`resource_ids`	Filter by Resource Ids.
`method`	Filter by Method.
`id`	Filter by Id.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

webhook
events
logs

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Webhook Id.

\n","type":"text/plain"},"key":"webhook_id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Status.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by Try Count Min.

\n","type":"text/plain"},"key":"try_count_min","value":""},{"disabled":true,"description":{"content":"

Filter by Try Count Max.

\n","type":"text/plain"},"key":"try_count_max","value":""},{"disabled":true,"description":{"content":"

Filter by Last Response Code.

\n","type":"text/plain"},"key":"last_response_code","value":""},{"disabled":true,"description":{"content":"

Filter by Date From.

\n","type":"text/plain"},"key":"date_from","value":""},{"disabled":true,"description":{"content":"

Filter by Date To.

\n","type":"text/plain"},"key":"date_to","value":""},{"disabled":true,"description":{"content":"

Filter by Resource Ids.

\n","type":"text/plain"},"key":"resource_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Method.

\n","type":"text/plain"},"key":"method","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - webhook - events - logs

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"e4bfeb2d-ec6d-4624-8611-1f52ab04bb6b","type":"any","value":"","key":"webhookID"}]}},"response":[],"_postman_id":"506d0843-2bb3-4397-b19c-9b53eeb70b04"},{"name":"Webhooks jobs show","id":"81e94b27-57cd-44e3-9322-83dc10ada982","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//webhooks/:webhookID/jobs/:jobID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`webhookID`	integer	yes
`jobID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`webhookID`	integer	yes
`jobID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`webhookID`	integer	yes
`jobID`	integer	yes

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`webhookID`	integer	yes
`jobID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`filter`	Lift nested filter[] payload to top-level so QueryFilters dispatches correctly.
`webhook_job_id`	Filter by Webhook Job Id.
`job_id`	Route-param alias for {job_id} in /webhooks/{webhook_id}/jobs/{job_id}/logs.
`attempt_number`	Filter by Attempt Number.
`response_status_code`	Filter by Response Status Code.
`sent_at_from`	Filter by Sent At From.
`sent_at_to`	Filter by Sent At To.
`request_method`	Filter by Request Method.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Includes

Eager-load related resources with a comma-separated includes parameter, e.g. ?includes=items,customer.

Allowed relations:

job

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Lift nested filter[] payload to top-level so QueryFilters dispatches correctly.

\n","type":"text/plain"},"key":"filter","value":""},{"disabled":true,"description":{"content":"

Filter by Webhook Job Id.

\n","type":"text/plain"},"key":"webhook_job_id","value":""},{"disabled":true,"description":{"content":"

Route-param alias for {job_id} in /webhooks/{webhook_id}/jobs/{job_id}/logs.

\n","type":"text/plain"},"key":"job_id","value":""},{"disabled":true,"description":{"content":"

Filter by Attempt Number.

\n","type":"text/plain"},"key":"attempt_number","value":""},{"disabled":true,"description":{"content":"

Filter by Response Status Code.

\n","type":"text/plain"},"key":"response_status_code","value":""},{"disabled":true,"description":{"content":"

Filter by Sent At From.

\n","type":"text/plain"},"key":"sent_at_from","value":""},{"disabled":true,"description":{"content":"

Filter by Sent At To.

\n","type":"text/plain"},"key":"sent_at_to","value":""},{"disabled":true,"description":{"content":"

Filter by Request Method.

\n","type":"text/plain"},"key":"request_method","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\"). Allowed relations: - job

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[{"id":"ddadd76b-83ff-4253-8b6d-6c01ca38031e","type":"any","value":"","key":"webhookID"},{"id":"da8f42dd-168d-4c26-aeaa-1828542f626e","type":"any","value":"","key":"jobID"}]}},"response":[],"_postman_id":"60bbdeae-133c-4de1-9c72-6f12b2de6958"},{"name":"Webhooks jobs logs show","id":"f9a009a4-ec8b-494a-a1f7-93c2fb567bc0","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//webhooks/:webhookID/jobs/:jobID/logs/:logID","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`companyID`	integer	yes
`webhookID`	integer	yes
`jobID`	integer	yes
`logID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_from=2024-01-01). Range filters expose <field>_from / <field>_to.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`webhookID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`event_ids`	array	yes	—

Webhooks — 17 endpoints.

List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination. See each request for the parameters it accepts.

\n","_postman_id":"b8de5cc9-10a9-441a-a0ea-309a749bf30e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Hooks","item":[{"name":"Hooks list","id":"f396f268-73d6-4887-af06-cf1ef76798a5","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//hooks","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Filters

Pass these as flat query-string parameters (e.g. ?hook_point=label.request.before_send&is_active=1).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`includes_count`	—
`filter`	—
`hook_point`	Filter by Hook Point.
`is_active`	Filter by Is Active.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

Sorting & pagination

Sorting: sort_by=<field> with sort_direction=asc|desc.
Pagination: cursor-based by default — follow the opaque cursor from meta.next_cursor / meta.prev_cursor. Pass ?page=N for classic page pagination. per_page defaults to 10 (max 250).

Filter by Hook Point.

\n","type":"text/plain"},"key":"hook_point","value":""},{"disabled":true,"description":{"content":"

Filter by Is Active.

\n","type":"text/plain"},"key":"is_active","value":""},{"disabled":true,"description":{"content":"

Filter by Id.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Filter by Ids.

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

Filter by Excepted Ids.

\n","type":"text/plain"},"key":"excepted_ids","value":""},{"disabled":true,"description":{"content":"

Filter by Ignore Ids.

\n","type":"text/plain"},"key":"ignore_ids","value":""},{"disabled":true,"description":{"content":"

Field to sort the collection by.

\n","type":"text/plain"},"key":"sort_by","value":""},{"disabled":true,"description":{"content":"

Sort direction: \"asc\" or \"desc\".

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"

Items per page. Default 10, maximum 250 (values above 250 are rejected with 422).

\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"

Page number for classic page pagination. Sending this parameter opts out of the default cursor mode.

\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of related resources to eager-load (e.g. \"items,customer\").

Allowed relations:

company

\n","type":"text/plain"},"key":"includes","value":""}],"variable":[]}},"response":[],"_postman_id":"f396f268-73d6-4887-af06-cf1ef76798a5"},{"name":"Hooks create","id":"c4e808e8-7e09-4178-b30f-7750f438a248","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"hook_point\": \"label.request.before_send\",\n \"url\": \"https://app.example.com/helm/pre-voila\",\n \"description\": \"Adds Detrack delivery slot\",\n \"timeout_ms\": 2500,\n \"on_failure\": \"fail\",\n \"priority\": 7,\n \"is_active\": true,\n \"headers\": [\n {\n \"key\": \"X-Tenant\",\n \"value\": \"acme\"\n }\n ],\n \"auth_method\": 3,\n \"auth_config\": {\n \"signing_secret\": \"change-me-secret\",\n \"signature_header_name\": \"X-Helm-Signature\",\n \"algorithm\": \"sha256\",\n \"include_timestamp\": true,\n \"timestamp_header_name\": \"X-Helm-Timestamp\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//hooks","description":"

Register a hook. A hook is an HTTPS URL Helm calls at the given hook point with prepared data; the JSON object you return under payload replaces that data before Helm continues.

Hook point label.request.before_send: Helm POSTs {hook_point, hook_id, sent_at, context, payload} where payload is the shipment object of the create-label request and context holds the company, shipment, order, courier and request ids. Answer 2xx with {\"payload\": {...}} within timeout_ms. Any other answer is handled per on_failure: continue sends the label with the unmodified payload, fail blocks the label and shows your message to the user.

Registered with an App Store token, the hook belongs to that app: it is deleted when the app is uninstalled and paused while the app is deactivated.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

Body parameters

Field	Type	Required	Description
`hook_point`	string	yes	Allowed: `label.request.before_send`
`url`	string	yes	HTTPS URL Helm will POST to.
`description`	string \| null	no	—
`timeout_ms`	integer \| null	no	—
`on_failure`	string \| null	no	Allowed: `continue`, `fail`
`priority`	integer \| null	no	—
`is_active`	boolean \| null	no	—
`auth_method`	integer \| null	no	WebhookAuthMethods values: - `1` = BASIC - `2` = BEARER - `3` = HMAC Allowed: `1`, `2`, `3`
`auth_config`	object	no	—
`auth_config.username`	string	no	—
`auth_config.password`	string	no	—
`auth_config.token`	string	no	—
`auth_config.signing_secret`	string	no	—
`auth_config.signature_header_name`	string	no	—
`auth_config.algorithm`	string	no	Allowed: `sha1`, `sha256`, `sha512`
`auth_config.include_timestamp`	boolean \| null	no	—
`auth_config.timestamp_header_name`	string \| null	no	—
`headers`	array \| null	no	—
`headers.*.key`	string	no	—
`headers.*.value`	string	no	—

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`hookID`	integer	yes

Replace a hook. hook_point and url are required, with the same rules as when registering; every other field you omit is reset to its default. A missing id, or one that belongs to another company, answers 404.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`hookID`	integer	yes

Body parameters

Field	Type	Required	Description
`hook_point`	string	yes	Allowed: `label.request.before_send`
`url`	string	yes	HTTPS URL Helm will POST to.
`description`	string \| null	no	—
`timeout_ms`	integer \| null	no	—
`on_failure`	string \| null	no	Allowed: `continue`, `fail`
`priority`	integer \| null	no	—
`is_active`	boolean \| null	no	—
`auth_method`	integer \| null	no	WebhookAuthMethods values: - `1` = BASIC - `2` = BEARER - `3` = HMAC Allowed: `1`, `2`, `3`
`auth_config`	object	no	—
`auth_config.username`	string	no	—
`auth_config.password`	string \| null	no	Secrets are optional on update: omit one (or send the masked value back) to keep the stored secret. Registration requires them.
`auth_config.token`	string \| null	no	—
`auth_config.signing_secret`	string \| null	no	—
`auth_config.signature_header_name`	string	no	—
`auth_config.algorithm`	string	no	Allowed: `sha1`, `sha256`, `sha512`
`auth_config.include_timestamp`	boolean \| null	no	—
`auth_config.timestamp_header_name`	string \| null	no	—
`headers`	array \| null	no	—
`headers.*.key`	string	no	—
`headers.*.value`	string	no	—

Delete a hook. Answers 204 with no body. A missing id, or one that belongs to another company, answers 404.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`hookID`	integer	yes

Switch a hook on or off without resending its definition. Send is_active to set the state explicitly, or an empty body to flip the current state. An inactive hook is kept but not called. Answers 200 with the hook. A missing id, or one that belongs to another company (or another app), answers 404.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`hookID`	integer	yes

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`is_active`	boolean \| null	no	—

Hooks — 5 endpoints.

A hook is an HTTPS URL Helm calls at a defined point of its own processing (currently label.request.before_send, just before a shipment label request is sent to the courier) so your system can adjust the data before Helm continues. List endpoints support filtering (flat query params), includes (eager-loaded relations), sort_by / sort_direction, and cursor pagination.

\n","_postman_id":"5b43690a-f438-4f9f-82cd-2d3b054dd92d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Fulfilment","item":[{"name":"Location Counts","id":"4d4077e6-703f-4078-9552-490b6c73d846","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-XSRF-TOKEN","value":"{{xsrf-token}}","type":"text"},{"key":"Referer","value":"{{referrer}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": 1,\n // \"inventory_ids\": [1,2], \n \"inventory_code\": \"test-\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//fulfilment/location-counts","description":"

POST endpoint. Filters travel in the JSON request body (not the query string), so inventory_ids can carry a large id list without hitting max_input_vars or URL-length limits.

Returns, for every warehouse location type, a qty computed from the inventory-location links (inventory_location_stocks). The type body field selects the calculation method.

Rate limit: 120 requests/minute (read tier), per token, for this endpoint. Each endpoint has its own independent budget. Exceeding it returns 429 Too Many Requests with Retry-After and X-RateLimit-* headers. Errors are returned as RFC 9457 application/problem+json.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
company_id	integer	yes	Company id.

Request body (application/json)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
type	integer (1-4)	yes	Calculation method. `1` = all inventory-location links (no stock filter); `2` = distinct locations (no stock filter); `3` = links with physical stock (quantity > 0); `4` = distinct locations with physical stock (quantity > 0).
warehouse_id	integer	no	Restrict the count to a single warehouse. Omit for a company-wide count.
inventory_ids	integer[]	no	Filter by an explicit list of inventory ids (bulk). Mutually exclusive with inventory_code.
inventory_code	string	no	Filter by inventory code prefix (case-insensitive `LIKE 'value%'`), e.g. `abc-` matches all products whose code starts with `abc-`. Mutually exclusive with inventory_ids.

inventory_ids and inventory_code are mutually exclusive — sending both returns 422.

Response

An array with one entry per location type (all six are always present; qty is 0 when a type has no matching links).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
type_id	integer	Location type id (1 storage, 2 sort_wall, 3 goods_in, 4 returns, 5 assembly, 6 goods_out).
type_name	string	Location type slug.
qty	integer	Count for the selected `type`.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}},"urlObject":{"path":["companies","","fulfilment","location-counts"],"host":["https://app-api.helmwms.app/api/v2"],"query":[],"variable":[]}},"response":[{"id":"e64c34b4-7c80-4496-a6aa-fd29221302ae","name":"Location Counts - 200 OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-XSRF-TOKEN","value":"{{xsrf-token}}","type":"text"},{"key":"Referer","value":"{{referrer}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//fulfilment/location-counts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Cache-Control","value":"no-cache, private"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type_id\": 1,\n \"type_name\": \"storage\",\n \"qty\": 19\n },\n {\n \"type_id\": 2,\n \"type_name\": \"sort_wall\",\n \"qty\": 0\n },\n {\n \"type_id\": 3,\n \"type_name\": \"goods_in\",\n \"qty\": 1\n },\n {\n \"type_id\": 4,\n \"type_name\": \"returns\",\n \"qty\": 1\n },\n {\n \"type_id\": 5,\n \"type_name\": \"assembly\",\n \"qty\": 0\n },\n {\n \"type_id\": 6,\n \"type_name\": \"goods_out\",\n \"qty\": 4\n }\n ],\n \"success\": true,\n \"execution_time\": \"0.045\"\n}"},{"id":"296adf99-f0d4-46d9-807a-fd7553a6c3ef","name":"Location Counts - 403 Basic mode","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-XSRF-TOKEN","value":"{{xsrf-token}}","type":"text"},{"key":"Referer","value":"{{referrer}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//fulfilment/location-counts"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/problem+json"},{"key":"Cache-Control","value":"no-cache, private"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"about:blank\",\n \"title\": \"Forbidden\",\n \"status\": 403,\n \"detail\": \"You cannot do this because you do not use the full stock structure!\",\n \"instance\": \"/api/v2/companies/1/fulfilment/location-counts\"\n}"},{"id":"55dc506c-5b76-492d-83fa-d2242cfdb503","name":"Location Counts - 422 Both inventory filters","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-XSRF-TOKEN","value":"{{xsrf-token}}","type":"text"},{"key":"Referer","value":"{{referrer}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//fulfilment/location-counts"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/problem+json"},{"key":"Cache-Control","value":"no-cache, private"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"about:blank\",\n \"title\": \"Unprocessable Entity\",\n \"status\": 422,\n \"detail\": \"The given data was invalid.\",\n \"instance\": \"/api/v2/companies/1/fulfilment/location-counts\",\n \"errors\": {\n \"inventory_ids\": [\n \"The Inventories field prohibits Inventory Code from being present.\"\n ],\n \"inventory_code\": [\n \"The Inventory Code field prohibits Inventories from being present.\"\n ]\n }\n}"}],"_postman_id":"4d4077e6-703f-4078-9552-490b6c73d846"}],"id":"4c1aed3e-b136-4757-abda-97c90de969f0","_postman_id":"4c1aed3e-b136-4757-abda-97c90de969f0","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Apps","item":[{"name":"Installed Apps","event":[{"listen":"test","script":{"exec":["const EXPECTED_KEYS = ["," 'slug', 'id', 'name', 'description', 'active', 'status', 'source',"," 'installed_at', 'logo', 'developer', 'headline', 'rating', 'prices',"," 'inapp_purchases', 'billing_type',","];","","pm.test('200 OK', () => pm.response.to.have.status(200));","","pm.test('body is wrapped in a data array', () => {"," const body = pm.response.json();"," pm.expect(body).to.have.property('data');"," pm.expect(body.data).to.be.an('array');","});","","pm.test('every row has the exact same 15 keys', () => {"," pm.response.json().data.forEach((row, i) => {"," pm.expect(Object.keys(row).sort(), `row ${i}`).to.eql([...EXPECTED_KEYS].sort());"," });","});","","pm.test('source is one of app_store / internal / ai_app', () => {"," pm.response.json().data.forEach((row, i) => {"," pm.expect(['app_store', 'internal', 'ai_app'], `row ${i} (${row.slug})`).to.include(row.source);"," });","});","","pm.test('active is a real boolean, never a string or number', () => {"," pm.response.json().data.forEach((row, i) => {"," pm.expect(row.active, `row ${i} (${row.slug})`).to.be.a('boolean');"," });","});","","pm.test('id is null for app_store and internal, numeric for ai_app', () => {"," pm.response.json().data.forEach((row) => {"," if (row.source === 'ai_app') {"," pm.expect(row.id, `${row.slug} (ai_app)`).to.be.a('number');"," } else {"," pm.expect(row.id, `${row.slug} (${row.source})`).to.equal(null);"," }"," });","});","","pm.test('status is only populated for ai_app rows', () => {"," pm.response.json().data.forEach((row) => {"," if (row.source !== 'ai_app') {"," pm.expect(row.status, `${row.slug} (${row.source})`).to.equal(null);"," }"," });","});","","pm.test('no credential ever leaks into the response', () => {"," const raw = pm.response.text();"," ['client_id', 'client_secret', 'access_token', 'access_token_hash'].forEach((needle) => {"," pm.expect(raw, `response must not contain ${needle}`).to.not.include(needle);"," });","});","","pm.test('rows are sorted ascending by slug', () => {"," const slugs = pm.response.json().data.map((r) => r.slug);"," pm.expect(slugs).to.eql([...slugs].sort());","});","","// Informational: which sources this company actually exercised, and whether any","// install is missing from the App Store catalog (the case this ticket exists for).","const rows = pm.response.json().data;","const bySource = rows.reduce((acc, r) => { acc[r.source] = (acc[r.source] || 0) + 1; return acc; }, {});","console.log('rows by source:', JSON.stringify(bySource));","const unenriched = rows.filter((r) => r.source === 'app_store' && r.name === null).map((r) => r.slug);","console.log('app_store installs missing from the catalog (expect null name):', JSON.stringify(unenriched));","console.log('inactive installs:', JSON.stringify(rows.filter((r) => !r.active).map((r) => r.slug)));"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"6a824afe-598c-47ee-84d6-5b3231bcf684","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//apps","description":"

The company's installed apps, one row per install, ordered by slug. Covers App Store apps, internal modules and AI micro-apps; every row has the same keys and the ones a source does not have are null. active is the switched-on state.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes

One App Store app or internal module by slug, installed or not: the list row plus installed. 404 when the slug is unknown.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`appSlug`	string	yes	The app slug, as returned by the installed-apps list.

The app slug.

\n","type":"text/plain"},"type":"any","value":"","key":"appSlug"}]}},"response":[],"_postman_id":"d7998598-b7f8-46c4-aa9b-e7bf5b9e4931"},{"name":"App install","id":"006f6197-6d4b-4df0-97f0-625928ecd562","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//apps/:appSlug/install","description":"

Installs an internal module on the spot. For an App Store app nothing is installed here: the install is an OAuth consent at the partners store that a person must give in a browser, so the response carries the redirect_url to open. 404 unknown slug, 409 internal module already installed.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`appSlug`	string	yes	The app slug, as returned by the installed-apps list.

The app slug.

\n","type":"text/plain"},"type":"any","value":"","key":"appSlug"}]}},"response":[],"_postman_id":"006f6197-6d4b-4df0-97f0-625928ecd562"},{"name":"App update","id":"7707abba-2db3-4ad5-8d84-3ca24c238ef2","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"active\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://app-api.helmwms.app/api/v2/companies//apps/:appSlug","description":"

Switches an installed app on or off. Responds 204 No Content. 404 when the app is not installed.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`appSlug`	string	yes	The app slug, as returned by the installed-apps list.

Body parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`active`	boolean	yes	Whether the install is switched on.

The app slug.

\n","type":"text/plain"},"type":"any","value":"","key":"appSlug"}]}},"response":[],"_postman_id":"7707abba-2db3-4ad5-8d84-3ca24c238ef2"},{"name":"App uninstall","id":"09fc369b-a343-41b5-9280-2a8704259968","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//apps/:appSlug","description":"

Uninstalls an App Store app (its token is revoked at the store) or an internal module (its data is removed). Responds 204 No Content. 404 when the app is not installed.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`companyID`	integer	yes
`appSlug`	string	yes	The app slug, as returned by the installed-apps list.

The app slug.

\n","type":"text/plain"},"type":"any","value":"","key":"appSlug"}]}},"response":[],"_postman_id":"09fc369b-a343-41b5-9280-2a8704259968"}],"id":"43e6b913-ecd7-4f50-ba63-27a7c8956311","description":"

Apps — 5 endpoints.

Which apps the company has installed and whether each one is switched on, plus per-app detail, install, on/off toggle and uninstall. Covers App Store apps and internal modules; the list also includes AI micro-apps.

\n","_postman_id":"43e6b913-ecd7-4f50-ba63-27a7c8956311","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Staff Performance Stats","item":[{"name":"All blocks","id":"7ecc2820-f059-4006-ac89-9775d1bd6343","request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//users/{{user_id}}/performance-stats?date_from=2026-07-01T00:00:00Z&date_to=2026-07-31T23:59:59Z","description":"

Omitting type returns all three blocks. Omitting group_by returns totals only, with no bucket breakdown.

A block comes back as null when the person had no activity of that kind in the window — that is different from a block full of zeroes, which cannot occur.

Response fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Meaning
`user_id`	Echo of the user the figures belong to.
`date_from` / `date_to`	The window actually used, normalised to UTC.
`picking.orders_picked`	Distinct orders this person picked from.
`picking.units_picked`	Units picked during tracked sessions.
`picking.lines_picked`	Distinct order lines picked.
`picking.picks_worked`	Distinct picks (pick jobs) worked on.
`picking.picks_per_hour`	`units_picked` per tracked hour. `null` when no tracked time covers the work.
`picking.active_picking_time_seconds`	Measured hands-on picking time.
`packing.orders_packed`	Distinct orders packed at the packing terminal.
`packing.units_packed`	Units in those orders.
`packing.labels_created`	Labels produced — higher than `orders_packed` for multi-parcel orders.
`packing.packs_per_hour`	`units_packed` per measured packing hour. `null` when no terminal session covers the work.
`packing.active_packing_time_seconds`	Measured packing-terminal time.
`despatch.orders_despatched`	Distinct orders despatched, by any route.
`despatch.units_despatched`	Units in those orders.
`despatch.labels_created`	Labels produced.
`group_by`	Echo of the requested granularity, or `null`.
`buckets`	`null` unless `group_by` was sent.

","urlObject":{"path":["companies","","users","{{user_id}}","performance-stats"],"host":["https://app-api.helmwms.app/api/v2"],"query":[{"description":{"content":"

REQUIRED. Start of the window, ISO 8601. An offset such as 2026-07-01T00:00:00+03:00 is accepted and converted to UTC; the response echoes the UTC instant it actually used. Inclusive.

\n","type":"text/plain"},"key":"date_from","value":"2026-07-01T00:00:00Z"},{"description":{"content":"

REQUIRED. End of the window, ISO 8601. Must be greater than or equal to date_from. Inclusive.

\n","type":"text/plain"},"key":"date_to","value":"2026-07-31T23:59:59Z"}],"variable":[]}},"response":[],"_postman_id":"7ecc2820-f059-4006-ac89-9775d1bd6343"},{"name":"Today, broken down by hour","id":"f187fc32-1744-47ae-89ac-b98bbeb1bcc2","request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//users/{{user_id}}/performance-stats?date_from=2026-07-31T00:00:00Z&date_to=2026-07-31T23:59:59Z&group_by=hour","description":"

This is the call that answers \"how many did this person do in the last hour, and how many so far today\" in ONE request: the totals cover the whole day, and each buckets entry covers one hour of it. No need to poll a second endpoint or send one request per window.

Each bucket carries the same three blocks, each null when that activity did not occur in that hour (or was excluded by type).

period_start is the UTC instant the bucket begins; the bucket covers one hour (or one day) from there.

\n","urlObject":{"path":["companies","","users","{{user_id}}","performance-stats"],"host":["https://app-api.helmwms.app/api/v2"],"query":[{"description":{"content":"

REQUIRED. Start of the window, ISO 8601, inclusive.

\n","type":"text/plain"},"key":"date_from","value":"2026-07-31T00:00:00Z"},{"description":{"content":"

REQUIRED. End of the window, ISO 8601, inclusive.

\n","type":"text/plain"},"key":"date_to","value":"2026-07-31T23:59:59Z"},{"description":{"content":"

OPTIONAL. hour or day. Adds a buckets array on top of the totals. Buckets with no activity are absent rather than zero-filled. Max window: 31 days with hour, 366 days otherwise.

\n","type":"text/plain"},"key":"group_by","value":"hour"}],"variable":[]}},"response":[],"_postman_id":"f187fc32-1744-47ae-89ac-b98bbeb1bcc2"},{"name":"Last hour only","id":"2708123b-26a6-4586-b499-b98da212d2db","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//users/{{user_id}}/performance-stats?date_from=2026-07-31T14:00:00Z&date_to=2026-07-31T15:00:00Z&type=despatch","description":"

A one-hour window with type=despatch — \"how many orders has this person despatched in the last hour\".

Order and label counts are anchored on the exact label timestamp, so a one-hour window is precise. Note that picking and packing time in a one-hour window is not: a session that started before the window is not measured inside it, and a session that started inside it is measured whole even if it ran past the end. Use counts, not time, for short windows.

REQUIRED. Start of the window, ISO 8601, inclusive.

\n","type":"text/plain"},"key":"date_from","value":"2026-07-31T14:00:00Z"},{"description":{"content":"

REQUIRED. End of the window, ISO 8601, inclusive.

\n","type":"text/plain"},"key":"date_to","value":"2026-07-31T15:00:00Z"},{"description":{"content":"

OPTIONAL. picking, packing or despatch. Narrows the response to one block; the others come back null. Omit for all three.

\n","type":"text/plain"},"key":"type","value":"despatch"}],"variable":[]}},"response":[],"_postman_id":"2708123b-26a6-4586-b499-b98da212d2db"},{"name":"Picking only, by day","id":"a02cf419-a1eb-4e72-acf4-4250a2193a12","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app-api.helmwms.app/api/v2/companies//users/{{user_id}}/performance-stats?date_from=2026-07-01T00:00:00Z&date_to=2026-07-31T23:59:59Z&type=picking&group_by=day","description":"

Daily pick rate per person over a month — the shape to feed a trend chart or a shift review.

picks_per_hour is recomputed inside each bucket from that bucket's own units and tracked time, so it is a genuine per-day rate rather than the month's average repeated.

REQUIRED. Start of the window, ISO 8601, inclusive.

\n","type":"text/plain"},"key":"date_from","value":"2026-07-01T00:00:00Z"},{"description":{"content":"

REQUIRED. End of the window, ISO 8601, inclusive.

\n","type":"text/plain"},"key":"date_to","value":"2026-07-31T23:59:59Z"},{"description":{"content":"

OPTIONAL. Narrow to picking; packing and despatch return null.

\n","type":"text/plain"},"key":"type","value":"picking"},{"description":{"content":"

OPTIONAL. Daily buckets. period_start is midnight UTC of each day.

\n","type":"text/plain"},"key":"group_by","value":"day"}],"variable":[]}},"response":[],"_postman_id":"a02cf419-a1eb-4e72-acf4-4250a2193a12"}],"id":"25885dca-bd29-41e0-84be-a04b576c6137","_postman_id":"25885dca-bd29-41e0-84be-a04b576c6137","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","id":"188f74b7-3468-4f3c-b836-f924ecefe2b2","name":"HELM WMS API V2","type":"collection"}}},{"name":"Pakeye Recordings","item":[{"name":"1. Order recordings (happy path)","id":"0c6415df-4649-4178-b890-9888a0b25183","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{pat}}"}],"url":"https://app-api.helmwms.app/api/v2/companies//orders/{{order_id}}/packeye-recordings","description":"

Expected 200 with one entry per shipment that has a recording.

{\n    \"data\": [\n        {\n            \"shipment_id\": 4521,\n            \"reference_number\": \"SHP-0004521\",\n            \"status\": \"available\",\n            \"url\": \"https://cdn.example/file/bucket/packeye-videos/c1/s4521/2026/08/17/20260817T101500_...mp4?Authorization=...\",\n            \"expires_at\": \"2026-08-17T10:30:00.000000Z\"\n        },\n        {\n            \"shipment_id\": 4522,\n            \"reference_number\": \"SHP-0004522\",\n            \"status\": \"uploading\",\n            \"url\": null,\n            \"expires_at\": null\n        }\n    ]\n}\n

Open an available url in a browser to confirm the video plays. Re-send this request after expires_at has passed to confirm you get a freshly signed url rather than a dead one.

Expected 200 with {\"data\": []}.

An owned order with nothing to show is NOT a 404. This is the difference the hub must handle: an empty list means \"no video for this order\", a 404 means \"this order is not yours\".

Expected 404 as RFC 9457 problem+json. The order id is deliberately not validated in the request class, so a missing order surfaces as a 404 from the ownership guard rather than a 422 validation error.

Expected 404. The path company_id must match the token's company, and that check runs before any tenant database is selected. Set other_company_id to a real company that your token does not belong to for this to be a meaningful test.

Expected 401. No Authorization header at all.

A bogus bearer token must produce 401, never a 500. To test the ability gate itself (403), replace the header value with a real token that lacks the orders:read ability.

Expected 403 naming shipment.view_video_recording.

This is the permission every existing custom role starts without, so it is worth running once before release. Owners, admins and support bypass role permissions, so the token must belong to a restricted role for this to prove anything.