{"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;
errors follow RFC 7807 application/problem+json.

Base URL

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

Every request is built on the https://dcv7.test/api/v2 collection variable — point it at
your environment's API host (the default is the spec's https://app-api.helmwms.app/api/v2). All data
endpoints are scoped to a company: https://dcv7.test/api/v2/companies//....
Set 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
request:

Authorization: Bearer <your-token>\n\n

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

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

Rate limiting

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

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

Pagination

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

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

Filtering

Filters are flat query-string parameters named after the field — there is no
filter[...] wrapper. For example ?status=2&store_id=5. Range filters expose
_from / _to (e.g. created_at_from, created_at_to). Most
collections also accept id, ids, excepted_ids and ignore_ids. The exact
filter 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
resources, e.g. ?includes=items,customer,shippingAddress.address.country. Each
list endpoint documents its allowed relations (drawn from the model's
includable whitelist); requesting a relation outside that set is ignored.

Sorting

?sort_by=&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\n

Validation failures return 422 with field-level detail. Error messages are
localized 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":"44e27ff6-f71e-4af2-b22c-08260722bdc5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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\". Options: asc, 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":"44e27ff6-f71e-4af2-b22c-08260722bdc5"},{"name":"Batch shipments files download","id":"fa2a9467-f28f-4135-a79f-1d3a8191ee6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//batch-shipments/:batchID/files/download?batch_id=&file_name=","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
`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`	—

","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","","batch-shipments",":batchID","files","download"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"batch_id","value":""},{"key":"file_name","value":""}],"variable":[{"id":"47aa7fff-6200-4ccb-8225-337bf8e00f0a","type":"any","value":"","key":"batchID"}]}},"response":[],"_postman_id":"fa2a9467-f28f-4135-a79f-1d3a8191ee6b"},{"name":"Batch shipments files renew","id":"893479f5-545b-46df-ab18-cfc04d35ad7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"batch_id\": 0,\n \"batch_file_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//batch-shipments/:batchID/files/:batchFileID/renew","description":"

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\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	—

Path parameters

\n\n\n\n\n\n\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":"156bd759-273e-40a5-b8db-a6fce533f131","type":"any","value":"","key":"batchShipmentID"}]}},"response":[],"_postman_id":"54ab7bfe-4131-4793-9a63-d02c3d650d70"},{"name":"Batch shipments change label format","id":"ccfe182d-e048-46b3-b4f2-921375e4ae69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"batch_shipment_id\": 0,\n \"label_format\": \"2\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//batch-shipments/:batchShipmentID/change-label-format","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

Body 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
`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`	—

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":"06840f6a-d4ca-4acc-9cdd-67d5285d68a9","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":"c3329ca0-5079-4589-b6a4-1aabeafd6946","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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 _from / _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= with sort_direction=asc|desc.
\n
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

Field to sort the collection by.

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

Sort direction: \"asc\" or \"desc\". Options: asc, 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":"c3329ca0-5079-4589-b6a4-1aabeafd6946"},{"name":"Channel linking logs show","id":"7f08fed9-773e-4147-9929-12dd19d54ef0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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":"dd5a3a12-023e-4477-b7db-8f4a8b29a5a1","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 list","id":"518514d4-877f-418d-b66b-4f6c42af7e38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//countries","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\". Options: asc, 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":"518514d4-877f-418d-b66b-4f6c42af7e38"},{"name":"Countries states list","id":"62f7bc52-4196-4f10-9239-7b5678c46024","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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\". Options: asc, 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":"62f7bc52-4196-4f10-9239-7b5678c46024"},{"name":"Countries defaults","id":"6c6a79c8-ad8f-4582-bfa2-cfddf7f9f1b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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\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":"da99af2c-df95-49c0-887c-2da58911dcf9","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 list","id":"6fa8e874-d3db-4901-bedb-8e487b2ea965","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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\". Options: asc, 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":"6fa8e874-d3db-4901-bedb-8e487b2ea965"},{"name":"Couriers create","id":"c9dd0baa-3920-412c-bfcd-bc1758d2a79a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"courier_key\": \"\",\n \"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://dcv7.test/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

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	—

Path parameters

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

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

Options: asc, desc

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"key":"includes_count","value":""},{"disabled":true,"key":"page","value":""},{"disabled":true,"key":"per_page","value":""}],"variable":[]}},"response":[],"_postman_id":"afc700d8-ba1c-4844-95e7-1b19577df93d"},{"name":"Couriers manifestable","id":"18dee2f7-261d-4f4d-adf5-cfd4fe74a916","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//couriers/manifestable","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
`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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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

","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","","couriers","services",":courierServiceID","specifics-field-detail"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"6a3d293d-c2db-4c81-9d0c-f83d766fa07a","type":"any","value":"","key":"courierServiceID"}]}},"response":[],"_postman_id":"69297c30-6e7b-45d7-9c89-4f1ccbff517a"},{"name":"Couriers specifics create","id":"833bb19a-1cc2-4b2a-a287-3c09956fed09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"courier_service_id\": 0,\n \"fields\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//couriers/services/:courierServiceID/specifics-fields","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
`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

Field	Type	Required	Description
`courier_service_id`	integer	yes	—
`fields`	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

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\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`	—

","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","","couriers",":courierID"],"host":["https://dcv7.test/api/v2"],"query":[{"disabled":true,"key":"includes_count","value":""}],"variable":[{"id":"2ebd2baa-e4fa-49a2-8198-3ba63bcddddb","type":"any","value":"","key":"courierID"}]}},"response":[],"_postman_id":"0337ef36-ac4c-4664-924f-245a310c8e6e"},{"name":"Couriers update","id":"f54be24e-d7bd-46d8-a6ce-9fd2bd940916","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": false,\n \"name\": \"\",\n \"config\": [\n \"\"\n ],\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://dcv7.test/api/v2/companies//couriers/:courierID","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\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	—

Path parameters

\n\n\n\n\n\n\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

","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","","couriers",":courierID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"4a84e944-23d6-4697-abbe-b501ea2daa4f","type":"any","value":"","key":"courierID"}]}},"response":[],"_postman_id":"0feabc39-77b0-4ea4-936f-641ad87096b1"},{"name":"Couriers collection times","id":"03d9b297-af1e-48a1-89a1-8e2699207f38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"courier_id\": 0,\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://dcv7.test/api/v2/companies//couriers/:courierID/collection-times","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

Field	Type	Required	Description
`courier_id`	integer	yes	—
`collection_times`	object	yes	—

","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","","couriers",":courierID","collection-times"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"ce485922-34d4-4c0e-b889-5c2f6c8ba0a8","type":"any","value":"","key":"courierID"}]}},"response":[],"_postman_id":"03d9b297-af1e-48a1-89a1-8e2699207f38"},{"name":"Couriers manifest schedule","id":"27e0cf9c-3a19-4bf8-8c2c-ec75899a46ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"courier_id\": 0,\n \"schedule\": {\n \"monday\": \"\",\n \"tuesday\": \"\",\n \"wednesday\": \"\",\n \"thursday\": \"\",\n \"friday\": \"\",\n \"saturday\": \"\",\n \"sunday\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//couriers/:courierID/manifest-schedule","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

Field	Type	Required	Description
`courier_id`	integer	yes	—
`schedule`	object	no	—

","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","","couriers",":courierID","manifest-schedule"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"02f7b408-82b5-4e16-8a20-38a42b38f3b4","type":"any","value":"","key":"courierID"}]}},"response":[],"_postman_id":"27e0cf9c-3a19-4bf8-8c2c-ec75899a46ab"},{"name":"Couriers manual services create","id":"9d389405-1fb1-4cc6-8109-420396da0b9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"courier_id\": 0,\n \"courier_service_name\": \"\",\n \"label_reference\": \"1\",\n \"label_secondary_reference\": \"1\",\n \"presets\": [\n \"\"\n ],\n \"specifics\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//couriers/:courierID/manual-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\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	—

Path parameters

\n\n\n\n\n\n\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\". Options: asc, 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":"8e84977a-2c64-4a90-9231-483cecbb7ca5","type":"any","value":"","key":"courierID"}]}},"response":[],"_postman_id":"e8580a0c-4c00-43ed-bf7c-6782e80214b1"},{"name":"Couriers services create","id":"84d0d361-cfd6-4628-9b2c-d2fca51fadcd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"courier_service_name\": \"\",\n \"shipping_service_id\": \"\",\n \"label_reference\": \"1\",\n \"label_secondary_reference\": \"1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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`

","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","","couriers",":courierID","services"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"6e8a509f-6b80-4c68-a3e2-2e2e5a4d6520","type":"any","value":"","key":"courierID"}]}},"response":[],"_postman_id":"84d0d361-cfd6-4628-9b2c-d2fca51fadcd"},{"name":"Couriers services bulk","id":"3e8be554-b94a-4f38-af87-35a45797d838","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"courier_id\": 0,\n \"services\": [\n {\n \"courier_service_name\": \"\",\n \"shipping_service_id\": \"\",\n \"label_reference\": \"1\",\n \"label_secondary_reference\": \"1\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//couriers/:courierID/services/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
`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

Field	Type	Required	Description
`courier_id`	integer	yes	—
`services`	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
`courierID`	integer	yes
`courierServiceID`	integer	yes

","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","","couriers",":courierID","services",":courierServiceID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"c385be01-b176-4fc9-82c0-036ef6936188","type":"any","value":"","key":"courierID"},{"id":"210e2234-6a9b-40db-b86a-930288ec6cbd","type":"any","value":"","key":"courierServiceID"}]}},"response":[],"_postman_id":"2c3f7835-98ff-44fb-9b2c-653d56cfad7d"},{"name":"Couriers services update","id":"0a6924bf-a01f-443a-9478-4a8f046d0443","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"courier_service_name\": \"\",\n \"status\": false,\n \"label_reference\": \"1\",\n \"label_secondary_reference\": \"1\",\n \"presets\": [\n \"\"\n ],\n \"specifics\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//couriers/:courierID/services/:courierServiceID","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
`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

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	—

","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","","couriers",":courierID","services",":courierServiceID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"a3885aa2-64a1-4c7b-bafe-4d5022194256","type":"any","value":"","key":"courierID"},{"id":"0cc1e372-ed02-4dca-93b3-faa0cac5f2ee","type":"any","value":"","key":"courierServiceID"}]}},"response":[],"_postman_id":"0a6924bf-a01f-443a-9478-4a8f046d0443"},{"name":"Couriers services delete","id":"6b6df113-04d2-450a-acc4-e0ebd6bfa603","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//couriers/:courierID/services/:courierServiceID","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
`courierID`	integer	yes
`courierServiceID`	integer	yes

","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","","couriers",":courierID","services",":courierServiceID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"c8041046-c002-4e11-b838-16b9c65188ea","type":"any","value":"","key":"courierID"},{"id":"e1385793-df0a-4527-94df-817fa31eff1b","type":"any","value":"","key":"courierServiceID"}]}},"response":[],"_postman_id":"6b6df113-04d2-450a-acc4-e0ebd6bfa603"},{"name":"Couriers services status","id":"09c4cff9-a73f-42ed-9451-3d95e59da520","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"courier_id\": 0,\n \"courier_service_id\": 0,\n \"status\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//couriers/:courierID/services/:courierServiceID/status","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
`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	—

","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","","couriers",":courierID","services",":courierServiceID","status"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"2854cf5e-1cae-4336-994a-715585b9d40f","type":"any","value":"","key":"courierID"},{"id":"abfea1f1-1866-4abd-8633-f86b6024bcdf","type":"any","value":"","key":"courierServiceID"}]}},"response":[],"_postman_id":"09c4cff9-a73f-42ed-9451-3d95e59da520"},{"name":"Couriers status","id":"5133818a-fdcd-4252-ab7c-7c8a3fe3be80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"courier_id\": 0,\n \"status\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//couriers/:courierID/status","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

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
`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

","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","","couriers",":courierKey","manifest"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"f5fdae05-cdc0-4f50-bea9-ac43c9c700c9","type":"any","value":"","key":"courierKey"}]}},"response":[],"_postman_id":"af5ed763-4a58-4386-b1af-3b48cfa84d5a"},{"name":"Couriers oauth url","id":"6e1b4a6d-97f7-4d61-93ea-62fe7b1d486c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"testing\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//couriers/:courierKey/oauth-url","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
`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

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":"78cad106-d950-4cf2-b071-5fbfb47e823d","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":"Currencies list","id":"db2ffffe-e497-4bb9-85f9-d3e622995df6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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\". Options: asc, 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":"db2ffffe-e497-4bb9-85f9-d3e622995df6"},{"name":"Display the specified currency with its base-rebased rate","id":"f3e2c0a9-7742-4e74-9b5c-ab6a428cf81b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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 — 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":"b089d55f-43b5-4666-b09a-ec10ee9c0e0a","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 list","id":"4db130ee-48b8-4fbc-a589-58488cde5c4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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).

Options: 1, 2, 3, 4, 5, 6

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

Options: 1, 2, 3, 4, 5

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

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\". Options: asc, 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":"4db130ee-48b8-4fbc-a589-58488cde5c4c"},{"name":"Custom fields create","id":"6dd1d2e1-b34a-467b-9436-95e91a1a7b0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"custom_field_type_id\": \"1\",\n \"custom_field_group_type_id\": \"1\",\n \"name\": \"\",\n \"options\": [\n {\n \"name\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

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	—

","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","","custom-fields"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"6dd1d2e1-b34a-467b-9436-95e91a1a7b0c"},{"name":"Custom fields relations create","id":"0dbb18fd-43b2-4db3-a3be-0f9cb6a8db97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"custom_field_group_type_id\": \"1\",\n \"relation_id\": \"\",\n \"custom_field_type_id\": \"1\",\n \"custom_field_id\": 0,\n \"value\": false,\n \"custom_field_option_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//custom-fields/relations/:relationID","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
`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`	—

Options: 1, 2, 4, 5

\n","type":"text/plain"},"key":"custom_field_group_type_id","value":""},{"disabled":true,"key":"relation_id","value":""},{"key":"custom_field_value_id","value":""}],"variable":[{"id":"0705f09f-7cb3-4ccf-9b18-6826f5de9aa7","type":"any","value":"","key":"relationID"}]}},"response":[],"_postman_id":"38b3a1c7-1064-4eae-b9da-38b81464ffdc"},{"name":"Custom fields relations bulk delete","id":"c93e931f-3c87-4e06-89a6-0fc5c6a817e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//custom-fields/relations/:relationID/bulk-delete?company_id=&custom_field_group_type_id=&all=","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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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`	—

Options: 1, 2, 4, 5

\n","type":"text/plain"},"key":"custom_field_group_type_id","value":""},{"disabled":true,"key":"relation_id","value":""},{"key":"all","value":""}],"variable":[{"id":"3f77d8c4-82ba-4b34-bda7-cefd7eebf533","type":"any","value":"","key":"relationID"}]}},"response":[],"_postman_id":"c93e931f-3c87-4e06-89a6-0fc5c6a817e1"},{"name":"Custom fields relations bulk update","id":"7a3520d1-7b0a-4ced-9d62-f11828282f58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"custom_field_group_type_id\": \"1\",\n \"relation_id\": \"\",\n \"fields\": [\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//custom-fields/relations/:relationID/bulk-update","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
`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\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).

Options: 1, 2, 4, 5

\n","type":"text/plain"},"key":"custom_field_group_type_id","value":""},{"disabled":true,"key":"relation_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\". Options: asc, 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":"66f29bc3-b514-47e4-8539-f59077b5e7d3","type":"any","value":"","key":"relationID"},{"id":"88589c20-4b5e-4e5e-a836-16d5c0f2c6e7","type":"any","value":"","key":"customFieldGroupTypeID"}]}},"response":[],"_postman_id":"a78d4e85-d83a-4e61-9699-d882eaa6f567"},{"name":"Custom fields types","id":"3a74ffb5-5d56-4163-a70c-952dbd0eaf52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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

","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","","custom-fields","types"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"3a74ffb5-5d56-4163-a70c-952dbd0eaf52"},{"name":"Custom fields update","id":"6c26038e-3da5-40e8-a848-8ff5a6264558","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"custom_field_id\": 0,\n \"custom_field_type_id\": \"1\",\n \"name\": \"\",\n \"options\": [\n {\n \"option_id\": 0,\n \"name\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//custom-fields/:customFieldID","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
`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

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	—

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":"47936d3f-8424-4613-a9ca-ca3ad0f5fd42","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 list","id":"4f84effd-6cde-4a07-8e9d-d227174e726f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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\". Options: asc, 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":"4f84effd-6cde-4a07-8e9d-d227174e726f"},{"name":"Customers create","id":"6fbd67ad-1d80-4914-bb70-dc1f063b0b4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"type\": \"1\",\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"file_manager_id\": 0,\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\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country_id\": 0,\n \"postcode\": \"\",\n \"vat_number\": \"\",\n \"eori\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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`
`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	—

Path parameters

\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	—

","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","","customers","bulk-archive"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"1b8e9a7c-8999-4cfa-ba4b-9d069380cdd5"},{"name":"Customers bulk create","id":"7d88947f-1a1a-42e9-8cb5-04e08ba03941","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"customers\": [\n {\n \"type\": \"1\",\n \"name\": \"\",\n \"surname\": \"\",\n \"phone\": \"\",\n \"tags\": [\n \"\"\n ],\n \"file_manager_id\": 0,\n \"addresses\": [\n {\n \"company_name\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"phone\": \"\",\n \"email\": \"user@example.com\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country_id\": 0,\n \"postcode\": \"\",\n \"vat_number\": \"\",\n \"eori\": \"\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//customers/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

Field	Type	Required	Description
`company_id`	integer	yes	—
`customers`	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	—

","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","","customers","bulk-restore"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"a7237bd6-d36f-4cbe-8dc5-c04cf8f656cb"},{"name":"Customers bulk update","id":"175366a8-ba17-483a-a4a8-13d0fa39c976","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"customers\": [\n {\n \"customer_id\": 0,\n \"type\": \"1\",\n \"name\": \"\",\n \"surname\": \"\",\n \"phone\": \"\",\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\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country_id\": 0,\n \"postcode\": \"\",\n \"vat_number\": \"\",\n \"eori\": \"\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//customers/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

Field	Type	Required	Description
`company_id`	integer	yes	—
`customers`	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

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

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

Options: asc, desc

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"key":"includes_count","value":""},{"disabled":true,"key":"page","value":""},{"disabled":true,"key":"per_page","value":""}],"variable":[]}},"response":[],"_postman_id":"ba4fba47-1c13-4a49-b708-6242e4d210f2"},{"name":"Customers show","id":"b4bf6805-3cb3-4a93-bf51-788b2bbbf069","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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":"14614df3-38db-4411-b050-d324c9e3836f","type":"any","value":"","key":"customerID"}]}},"response":[],"_postman_id":"b4bf6805-3cb3-4a93-bf51-788b2bbbf069"},{"name":"Customers update","id":"f6523d71-cf9e-45dc-bf95-7774b60ae7c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"customer_id\": \"\",\n \"type\": \"1\",\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"file_manager_id\": \"\",\n \"tags\": [\n \"\"\n ],\n \"addresses\": [\n {\n \"id\": \"\",\n \"company_name\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"phone\": \"\",\n \"email\": \"user@example.com\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country_id\": 0,\n \"postcode\": \"\",\n \"vat_number\": \"\",\n \"eori\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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`	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	—

Path parameters

\n\n\n\n\n\n\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\". Options: asc, 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":"11847663-b1d9-4fe1-a24a-b0a5fac95aa6","type":"any","value":"","key":"customerID"}]}},"response":[],"_postman_id":"c94e07a5-412c-49d8-b7aa-c0c3bc670c0b"},{"name":"Customers addresses create","id":"f86efafc-d154-4bf2-9908-dd08cf3595b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"customer_id\": 0,\n \"ship_to_somebody_else\": false,\n \"company_name\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"phone\": \"\",\n \"email\": \"user@example.com\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country_id\": 0,\n \"postcode\": \"\",\n \"vat_number\": \"\",\n \"eori\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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":"5f8aee69-a211-4275-9f83-558b4a46a0ae","type":"any","value":"","key":"customerID"},{"id":"f09f1707-b22d-4897-bc01-096471fde4ae","type":"any","value":"","key":"addressID"}]}},"response":[],"_postman_id":"d2de6387-e4e1-4b80-9062-7b72b2f81266"},{"name":"Customers addresses update","id":"d4fd1735-b9fc-4864-9608-cf3512eea0ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"customer_id\": 0,\n \"address_id\": 0,\n \"ship_to_somebody_else\": false,\n \"company_name\": \"\",\n \"name\": \"\",\n \"surname\": \"\",\n \"phone\": \"\",\n \"email\": \"user@example.com\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country_id\": 0,\n \"postcode\": \"\",\n \"vat_number\": \"\",\n \"eori\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	—
`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	—

","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","","customers",":customerID","addresses",":addressID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"abee8b57-f592-4cb3-b627-e78afd5cd1f1","type":"any","value":"","key":"customerID"},{"id":"8a673a09-e1e9-437f-908c-adb7bed3eaa6","type":"any","value":"","key":"addressID"}]}},"response":[],"_postman_id":"d4fd1735-b9fc-4864-9608-cf3512eea0ee"},{"name":"Customers addresses delete","id":"3f0dc96a-f397-41bf-bc49-bf6cd77409fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//customers/:customerID/addresses/:addressID?company_id=&customer_id=&address_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\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`	—

","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","","customers",":customerID","addresses",":addressID"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"company_id","value":""},{"key":"customer_id","value":""},{"key":"address_id","value":""}],"variable":[{"id":"e2ff785d-8cc5-4d50-8449-a66474da7121","type":"any","value":"","key":"customerID"},{"id":"d2c91a54-4ffd-4747-9aba-4bd3bdca627d","type":"any","value":"","key":"addressID"}]}},"response":[],"_postman_id":"3f0dc96a-f397-41bf-bc49-bf6cd77409fe"},{"name":"Customers addresses archive","id":"7756730c-876b-4856-ba45-7510c3a51eff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"customer_id\": 0,\n \"address_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//customers/:customerID/addresses/:addressID/archive","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

\n\n\n\n\n\n\n\n\n\n\n\n\n\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	—

","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","","customers",":customerID","addresses",":addressID","archive"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"8ab14f1a-e1c1-4f01-881c-19c178c5b312","type":"any","value":"","key":"customerID"},{"id":"a6dc7b01-b72a-46e9-92c7-9ece91f2c68c","type":"any","value":"","key":"addressID"}]}},"response":[],"_postman_id":"7756730c-876b-4856-ba45-7510c3a51eff"},{"name":"Customers archive","id":"fe3c9379-1f5f-4662-96ff-26494a8bb505","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"customer_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//customers/:customerID/archive","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

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

","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","","customers",":customerID","archive"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"86aadc4a-9ce8-4a0f-91d0-2ccee4474846","type":"any","value":"","key":"customerID"}]}},"response":[],"_postman_id":"fe3c9379-1f5f-4662-96ff-26494a8bb505"},{"name":"Customers change type","id":"69df5acb-72f5-4cf0-b07d-0bf11bbbecd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"customer_id\": 0,\n \"name\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"file_manager_id\": 0,\n \"vat_number\": \"\",\n \"eori\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//customers/:customerID/change-type","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	—
`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	—

Path parameters

\n\n\n\n\n\n\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\". Options: asc, 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":"d589e6f7-4490-4636-ab6d-7cb8a4d4acf9","type":"any","value":"","key":"customerID"}]}},"response":[],"_postman_id":"3e0667ae-dfb4-4002-9462-f9956b74365c"},{"name":"Customers contacts create","id":"ba8e0dd6-2c9b-4ff2-9228-b5d5dfd06d66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"company_customer_id\": 0,\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"file_manager_id\": 0,\n \"title\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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":"d348b9d9-da94-4e8b-bf15-cc11c8961066","type":"any","value":"","key":"customerID"},{"id":"c95511f6-8285-4700-954b-afeb9de61955","type":"any","value":"","key":"contactID"}]}},"response":[],"_postman_id":"106723c4-7557-4a42-98d4-116ebd824904"},{"name":"Customers contacts update","id":"a6ad813a-1b29-46e5-ab1d-52f604097145","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"company_customer_id\": 0,\n \"contact_id\": 0,\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"file_manager_id\": 0,\n \"title\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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	—

","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","","customers",":customerID","contacts",":contactID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"5de666ed-7fca-4d58-ae42-4c09c71b7a42","type":"any","value":"","key":"customerID"},{"id":"dc4085a0-99c6-4466-8071-f87a017639cf","type":"any","value":"","key":"contactID"}]}},"response":[],"_postman_id":"a6ad813a-1b29-46e5-ab1d-52f604097145"},{"name":"Customers contacts delete","id":"19ccf526-078b-4420-b964-e10bdccdcf18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//customers/:customerID/contacts/:contactID?company_id=&company_customer_id=&contact_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\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`	—

","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","","customers",":customerID","contacts",":contactID"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"company_id","value":""},{"key":"company_customer_id","value":""},{"key":"contact_id","value":""}],"variable":[{"id":"1a6c2c4e-b63a-4050-b075-e4042c96aa81","type":"any","value":"","key":"customerID"},{"id":"44e51128-290b-4fdc-9ed9-a3e10ddab281","type":"any","value":"","key":"contactID"}]}},"response":[],"_postman_id":"19ccf526-078b-4420-b964-e10bdccdcf18"},{"name":"Customers contacts archive","id":"c4249cbc-438a-4808-bbe3-052f96c6d318","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"company_customer_id\": 0,\n \"contact_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//customers/:customerID/contacts/:contactID/archive","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

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\". Options: asc, 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":"240eb123-8afa-4c84-9ff6-47e67dbdcbdf","type":"any","value":"","key":"customerID"}]}},"response":[],"_postman_id":"2eb423b0-62d0-47c4-b0a5-8748b6d4235a"},{"name":"Customers notes create","id":"f86de8c9-6df2-44cd-830d-6525f1c5fff8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"customer_id\": 0,\n \"note\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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`	—

","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","","customers",":customerID","notes",":noteID"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"company_id","value":""},{"key":"customer_id","value":""},{"key":"note_id","value":""}],"variable":[{"id":"84da69c5-fed8-43a9-aed5-667e97b49027","type":"any","value":"","key":"customerID"},{"id":"bb6b1a0e-3682-4dd0-a2a9-27de9e3a509c","type":"any","value":"","key":"noteID"}]}},"response":[],"_postman_id":"4e7359ae-ef4b-40d7-9333-f1d1440223e9"},{"name":"Customers related contact companies","id":"8c531f12-d07d-41e3-ac5f-ab303166166d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//customers/:customerID/related-contact-companies?company_id=&customer_id=","description":"

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`	—

","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","","customers",":customerID","related-contact-companies"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"company_id","value":""},{"key":"customer_id","value":""}],"variable":[{"id":"7db2d1e4-901e-4103-b7c2-b24d86fa4ee5","type":"any","value":"","key":"customerID"}]}},"response":[],"_postman_id":"8c531f12-d07d-41e3-ac5f-ab303166166d"},{"name":"Customers restore","id":"efd8a7ac-a47d-48a9-b7af-8a57f5ad5b1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"customer_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//customers/:customerID/restore","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

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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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\". Options: asc, 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":"6bd1bd62-30f4-43da-94a3-f5e121e68170","type":"any","value":"","key":"customerID"}]}},"response":[],"_postman_id":"dc62b5b0-4173-47bc-819f-7374f0972a63"},{"name":"Customers tags create","id":"3c2ed812-2ab0-4653-8604-f3f908e9e2f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"customer_id\": 0,\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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	—

","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","","customers",":customerID","tags"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"c4d22416-8a4c-4e90-a00a-f50ebd388df6","type":"any","value":"","key":"customerID"}]}},"response":[],"_postman_id":"3c2ed812-2ab0-4653-8604-f3f908e9e2f6"},{"name":"Customers tags attach","id":"f177f414-8f58-4963-8b06-bae792ff6834","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"customer_id\": 0,\n \"tag_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//customers/:customerID/tags/:tagID/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\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	—

","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","","customers",":customerID","tags",":tagID","attach"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"802d529d-a6b9-4fad-91e6-c5faa92d094b","type":"any","value":"","key":"customerID"},{"id":"0499517c-21fc-469c-8298-95ce559e5be6","type":"any","value":"","key":"tagID"}]}},"response":[],"_postman_id":"f177f414-8f58-4963-8b06-bae792ff6834"},{"name":"Customers tags detach","id":"b8545733-6bd4-4789-b4dc-6cd2fd26d6c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//customers/:customerID/tags/:tagID/detach?company_id=&customer_id=&tag_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\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`	—

","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","","customers",":customerID","tags",":tagID","detach"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"company_id","value":""},{"key":"customer_id","value":""},{"key":"tag_id","value":""}],"variable":[{"id":"3b7674b2-0718-42ee-ba5c-724760687e3f","type":"any","value":"","key":"customerID"},{"id":"c272dbf5-432e-463a-9579-ca38751b27ff","type":"any","value":"","key":"tagID"}]}},"response":[],"_postman_id":"b8545733-6bd4-4789-b4dc-6cd2fd26d6c8"},{"name":"Customers unarchive","id":"20d09425-4195-4d63-8aae-f2eea9edcac8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"customer_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//customers/:customerID/unarchive","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

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

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":"ca5a603f-9814-414e-abcd-d147ce12f2a6","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 cost by module","id":"6a2e37a2-f73a-457a-8c2e-c1b997578a78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//dashboard/costdashboard/cost-by-module?start_time=&end_time=","description":"

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`

Options: picking, packing, receiving, movement, inventory_check, storage, courier

\n","type":"text/plain"},"key":"include[]","value":""}],"variable":[]}},"response":[],"_postman_id":"6a2e37a2-f73a-457a-8c2e-c1b997578a78"},{"name":"Dashboard costdashboard cost over time","id":"2183f273-d04e-4953-88f1-8cdba928c03e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//dashboard/costdashboard/cost-over-time?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\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`

Options: picking, packing, receiving, movement, inventory_check, storage, courier

\n","type":"text/plain"},"key":"include[]","value":""}],"variable":[]}},"response":[],"_postman_id":"2183f273-d04e-4953-88f1-8cdba928c03e"},{"name":"Dashboard costdashboard cost per period","id":"2929d30c-5bfd-4a38-9664-518927276f7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//dashboard/costdashboard/cost-per-period?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\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`

Options: daily, weekly, monthly

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

Options: picking, packing, receiving, movement, inventory_check, storage, courier

\n","type":"text/plain"},"key":"include[]","value":""}],"variable":[]}},"response":[],"_postman_id":"2929d30c-5bfd-4a38-9664-518927276f7d"},{"name":"Dashboard costdashboard courier costs","id":"0ec568e3-06f4-41c2-8ce1-dc90937e5345","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//dashboard/costdashboard/courier-costs?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\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`	—

Options: courier, store, channel, service, courier_service

\n","type":"text/plain"},"key":"view","value":""},{"disabled":true,"key":"limit","value":""}],"variable":[]}},"response":[],"_postman_id":"0ec568e3-06f4-41c2-8ce1-dc90937e5345"},{"name":"Dashboard costdashboard department costs","id":"e0095d10-f11e-4f00-9a13-255451dcfa11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//dashboard/costdashboard/department-costs?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\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`

Options: department, job

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

Options: picking, packing, receiving, movement, inventory_check, storage, courier

\n","type":"text/plain"},"key":"include[]","value":""}],"variable":[]}},"response":[],"_postman_id":"e0095d10-f11e-4f00-9a13-255451dcfa11"},{"name":"Dashboard costdashboard figures","id":"16abd847-edba-454c-ba77-07d98dfedb35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//dashboard/costdashboard/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\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`

Options: picking, packing, receiving, movement, inventory_check, storage, courier

\n","type":"text/plain"},"key":"include[]","value":""}],"variable":[]}},"response":[],"_postman_id":"16abd847-edba-454c-ba77-07d98dfedb35"},{"name":"Dashboard costdashboard operational costs","id":"9a57b65b-de47-4c8f-abcb-59fe85d7d480","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//dashboard/costdashboard/operational-costs?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\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`

Options: supplier, store, channel, client, customer, top_products

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

Options: picking, packing, receiving, movement, inventory_check, storage, courier

\n","type":"text/plain"},"key":"include[]","value":""}],"variable":[]}},"response":[],"_postman_id":"9a57b65b-de47-4c8f-abcb-59fe85d7d480"},{"name":"Dashboard customer care active statuses","id":"fb60e45b-2019-4f17-a297-a04a47295858","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//dashboard/customer-care/active-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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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`

Options: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14

\n","type":"text/plain"},"key":"statuses[]","value":""}],"variable":[]}},"response":[],"_postman_id":"fb60e45b-2019-4f17-a297-a04a47295858"},{"name":"Dashboard customer care delivery performance","id":"fcdf12af-042d-415f-93ea-130f31047c0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//dashboard/customer-care/delivery-performance","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

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

Options: courier, service

\n","type":"text/plain"},"key":"type","value":""},{"key":"date_start","value":""},{"key":"date_end","value":""}],"variable":[]}},"response":[],"_postman_id":"72127c6e-9c1e-4284-840c-3ad8baef3299"},{"name":"Dashboard customer care delivery performance chart","id":"c940c6a1-88bd-4a32-afee-7129a0eff5c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//dashboard/customer-care/delivery-performance-chart?status=&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
`status`	Options: `delivered`, `late`, `exception`, `failed`
`date_start`	—
`date_end`	—
`has_comparison`	—
`comparison_date_start`	—
`comparison_date_end`	—

Options: delivered, late, exception, failed

\n","type":"text/plain"},"key":"status","value":""},{"key":"date_start","value":""},{"key":"date_end","value":""},{"key":"has_comparison","value":""},{"disabled":true,"key":"comparison_date_start","value":""},{"disabled":true,"key":"comparison_date_end","value":""}],"variable":[]}},"response":[],"_postman_id":"c940c6a1-88bd-4a32-afee-7129a0eff5c3"},{"name":"Dashboard customer care orders vs returns","id":"27f35bc9-57b0-49ea-9ac8-6bb3e122e725","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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`	—
`comparison_date_start`	—
`comparison_date_end`	—

","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","","dashboard","customer-care","orders-vs-returns"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"date_start","value":""},{"key":"date_end","value":""},{"key":"has_comparison","value":""},{"disabled":true,"key":"comparison_date_start","value":""},{"disabled":true,"key":"comparison_date_end","value":""}],"variable":[]}},"response":[],"_postman_id":"27f35bc9-57b0-49ea-9ac8-6bb3e122e725"},{"name":"Dashboard customer care shipment performance by country","id":"82ef4476-efb9-4f24-839f-d4d9247b40e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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`	—
`comparison_date_start`	—
`comparison_date_end`	—

","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","","dashboard","customer-care","shipment-performance-by-country"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"country_id","value":""},{"key":"date_start","value":""},{"key":"date_end","value":""},{"key":"has_comparison","value":""},{"disabled":true,"key":"comparison_date_start","value":""},{"disabled":true,"key":"comparison_date_end","value":""}],"variable":[]}},"response":[],"_postman_id":"82ef4476-efb9-4f24-839f-d4d9247b40e2"},{"name":"Dashboard inventorydashboard figures","id":"5f23e307-20c3-4dc5-ac69-59f90c2ca036","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//dashboard/inventorydashboard/figures","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

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`

Options: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12

\n","type":"text/plain"},"key":"statuses[]","value":""}],"variable":[]}},"response":[],"_postman_id":"949348e9-6c4a-458f-8f11-6dcefd892cf0"},{"name":"Dashboard overview order statistics","id":"5bc63152-a4c8-434b-a0de-9c9f7d72c259","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//dashboard/overview/order-statistics?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`	—
`comparison_date_start`	—
`comparison_date_end`	—

","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","","dashboard","overview","order-statistics"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"date_start","value":""},{"key":"date_end","value":""},{"key":"has_comparison","value":""},{"disabled":true,"key":"comparison_date_start","value":""},{"disabled":true,"key":"comparison_date_end","value":""}],"variable":[]}},"response":[],"_postman_id":"5bc63152-a4c8-434b-a0de-9c9f7d72c259"},{"name":"Dashboard overview recently added orders","id":"d338b1fa-b52a-4f76-aa7e-db7d781d8788","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//dashboard/overview/recently-added-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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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`	—
`comparison_date_start`	—
`comparison_date_end`	—

","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","","dashboard","overview","revenue"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"date_start","value":""},{"key":"date_end","value":""},{"key":"has_comparison","value":""},{"disabled":true,"key":"comparison_date_start","value":""},{"disabled":true,"key":"comparison_date_end","value":""}],"variable":[]}},"response":[],"_postman_id":"9607241c-458d-4ea5-a255-1881dd171602"},{"name":"Dashboard overview top channels","id":"3d88aba9-543b-4902-9a20-5305d03bae3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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`	—
`comparison_date_start`	—
`comparison_date_end`	—
`limit`	—

","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","","dashboard","overview","top-channels"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"date_start","value":""},{"key":"date_end","value":""},{"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":"3d88aba9-543b-4902-9a20-5305d03bae3b"},{"name":"Dashboard overview top couriers","id":"8e39185b-9d12-439a-8d2c-2f562fb9be9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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`	—
`comparison_date_start`	—
`comparison_date_end`	—
`limit`	—

","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","","dashboard","overview","top-couriers"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"date_start","value":""},{"key":"date_end","value":""},{"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":"8e39185b-9d12-439a-8d2c-2f562fb9be9c"},{"name":"Dashboard overview top products","id":"c105e5ac-2559-4277-8764-8b4501d1d366","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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`	—
`comparison_date_start`	—
`comparison_date_end`	—
`limit`	—

","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","","dashboard","overview","top-products"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"date_start","value":""},{"key":"date_end","value":""},{"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":"c105e5ac-2559-4277-8764-8b4501d1d366"},{"name":"Dashboard salesdashboard figures","id":"631eaeb7-060f-4b15-830e-5999a80817f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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`	—

","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","","dashboard","salesdashboard","figures"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"start_time","value":""},{"key":"end_time","value":""},{"disabled":true,"key":"compare_start_time","value":""},{"disabled":true,"key":"compare_end_time","value":""}],"variable":[]}},"response":[],"_postman_id":"631eaeb7-060f-4b15-830e-5999a80817f6"},{"name":"Dashboard salesdashboard product revenue","id":"405e70c9-31c7-42c1-9006-afaca314b214","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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`	—

","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","","dashboard","salesdashboard","product-revenue"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"start_time","value":""},{"key":"end_time","value":""},{"disabled":true,"key":"compare_start_time","value":""},{"disabled":true,"key":"compare_end_time","value":""}],"variable":[]}},"response":[],"_postman_id":"405e70c9-31c7-42c1-9006-afaca314b214"},{"name":"Dashboard salesdashboard product revenue droppers","id":"009f2d12-4043-4a73-abcb-9077d50ea7e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//dashboard/salesdashboard/product-revenue-droppers?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`	—

","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","","dashboard","salesdashboard","product-revenue-droppers"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"start_time","value":""},{"key":"end_time","value":""},{"disabled":true,"key":"compare_start_time","value":""},{"disabled":true,"key":"compare_end_time","value":""}],"variable":[]}},"response":[],"_postman_id":"009f2d12-4043-4a73-abcb-9077d50ea7e2"},{"name":"Dashboard salesdashboard revenue over time","id":"b5fe5e34-fc78-4e57-917f-929c7ae9e3a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//dashboard/salesdashboard/revenue-over-time?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`	—

","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","","dashboard","salesdashboard","revenue-over-time"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"start_time","value":""},{"key":"end_time","value":""},{"disabled":true,"key":"compare_start_time","value":""},{"disabled":true,"key":"compare_end_time","value":""}],"variable":[]}},"response":[],"_postman_id":"b5fe5e34-fc78-4e57-917f-929c7ae9e3a2"},{"name":"Dashboard salesdashboard sales by channel","id":"f4359a2d-f00c-412f-a613-39bc66dd5ede","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//dashboard/salesdashboard/sales-by-channel?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`	—

","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","","dashboard","salesdashboard","sales-by-channel"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"start_time","value":""},{"key":"end_time","value":""},{"disabled":true,"key":"compare_start_time","value":""},{"disabled":true,"key":"compare_end_time","value":""}],"variable":[]}},"response":[],"_postman_id":"f4359a2d-f00c-412f-a613-39bc66dd5ede"},{"name":"Dashboard salesdashboard sales by countries","id":"33aef493-d2f4-487b-8bc4-86690941dd5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//dashboard/salesdashboard/sales-by-countries?start_time=&end_time=&exclude_domestic=","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
`start_time`	—
`end_time`	—
`compare_start_time`	—
`compare_end_time`	—
`exclude_domestic`	—

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":"bc955b43-7dbe-45b0-a93b-ceab6ba8ae0f","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 list","id":"eb1bc96e-8e95-4c78-a488-9cd2fab6f0de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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

Filters

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\". Options: asc, 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":"eb1bc96e-8e95-4c78-a488-9cd2fab6f0de"},{"name":"Deliveries create","id":"e821676b-b1bd-4406-80c1-8014174421cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"type\": \"1\",\n \"reference_number\": \"\",\n \"supplier_id\": 0,\n \"delivery_number\": \"\",\n \"warehouse_location_id\": 0,\n \"expected_delivery_date\": \"2024-01-01T00:00:00Z\",\n \"assigned_user_id\": 0,\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\": 0,\n \"expected_qty\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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`
`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	—
`items`	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\n\n\n\n

Parameter	Description
`company_id`	—
`delivery_ids[]`	—

","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","","deliveries","attached-tags"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"company_id","value":""},{"disabled":true,"key":"delivery_ids[]","value":""}],"variable":[]}},"response":[],"_postman_id":"88b86f92-e156-4cad-98e2-16056a95e6f9"},{"name":"Deliveries bulk archive","id":"c4a395f9-54c1-48ce-9f26-8465d042342d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"delivery_ids\": [\n 0\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//deliveries/bulk-archive","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
`delivery_ids`	array	yes	—

","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","","deliveries","bulk-archive"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"c4a395f9-54c1-48ce-9f26-8465d042342d"},{"name":"Deliveries bulk create","id":"0b350e53-0c1f-43ac-a0da-2f23527e3766","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"deliveries\": [\n {\n \"type\": \"1\",\n \"reference_number\": \"\",\n \"supplier_id\": 0,\n \"delivery_number\": \"\",\n \"warehouse_location_id\": 0,\n \"expected_delivery_date\": \"2024-01-01T00:00:00Z\",\n \"assigned_user_id\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//deliveries/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

Field	Type	Required	Description
`company_id`	integer	yes	—
`deliveries`	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	—

","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","","deliveries","bulk-restore"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"57d10c00-258f-49a3-a40e-5ddf6c54c4fc"},{"name":"Deliveries bulk update","id":"69e10eb4-604b-4632-bdfb-de927d2af632","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"deliveries\": [\n {\n \"delivery_id\": 0,\n \"type\": \"1\",\n \"supplier_id\": 0,\n \"delivery_number\": \"\",\n \"warehouse_location_id\": 0,\n \"expected_delivery_date\": \"2024-01-01T00:00:00Z\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//deliveries/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

Field	Type	Required	Description
`company_id`	integer	yes	—
`deliveries`	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

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

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

Options: asc, desc

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"key":"includes_count","value":""},{"disabled":true,"key":"page","value":""},{"disabled":true,"key":"per_page","value":""}],"variable":[]}},"response":[],"_postman_id":"513a8c4d-65d7-47d3-97ec-2f3bd8bd6d0e"},{"name":"Deliveries types","id":"9b6225e9-dfc9-4aec-87e7-a1d760947e04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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\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":"227d18dc-a9b9-4df7-8556-a3da95f997a3","type":"any","value":"","key":"deliveryID"}]}},"response":[],"_postman_id":"fbd2179f-b7ee-4cc7-9014-0a355524000d"},{"name":"Deliveries update","id":"8048c3c2-d170-4124-a40d-d955266c7417","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"type\": \"1\",\n \"supplier_id\": 0,\n \"delivery_number\": \"\",\n \"warehouse_location_id\": 0,\n \"expected_delivery_date\": \"2024-01-01T00:00:00Z\",\n \"tags\": [\n \"\"\n ],\n \"sizes\": [\n {\n \"id\": 0,\n \"unit\": \"1\",\n \"qty\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

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	—

","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","","deliveries",":deliveryID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"ef54266a-12d2-4c20-bb22-5530c54710ce","type":"any","value":"","key":"deliveryID"}]}},"response":[],"_postman_id":"8048c3c2-d170-4124-a40d-d955266c7417"},{"name":"Deliveries update patch","id":"eb7f9592-0072-4d5f-aeb0-c078ded21881","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"type\": \"1\",\n \"supplier_id\": 0,\n \"delivery_number\": \"\",\n \"warehouse_location_id\": 0,\n \"expected_delivery_date\": \"2024-01-01T00:00:00Z\",\n \"tags\": [\n \"\"\n ],\n \"sizes\": [\n {\n \"id\": 0,\n \"unit\": \"1\",\n \"qty\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

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	—

Path parameters

\n\n\n\n\n\n\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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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\". Options: asc, 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":"96c29421-a087-40bd-b0c0-1686ea45d74e","type":"any","value":"","key":"deliveryID"}]}},"response":[],"_postman_id":"11525000-9863-4f76-9239-3b6625bbfd13"},{"name":"Deliveries assigned users create","id":"83eaf42e-e75b-432b-874c-9400160bf970","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"delivery_id\": 0,\n \"user_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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\". Options: asc, 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":"6393ae11-2f0f-4165-b5da-4c69fb00552c","type":"any","value":"","key":"deliveryID"}]}},"response":[],"_postman_id":"5eea227c-561e-4302-a4de-fffcf6908250"},{"name":"Deliveries attachments create","id":"f9882a09-8398-426b-83ff-89cfbfbd6ea6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"delivery_id\": 0,\n \"type\": \"1\",\n \"file_manager_id\": 0,\n \"inventory_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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	—

","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","","deliveries",":deliveryID","attachments"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"b52358a4-b2ce-4b91-b8c8-02603c988dc9","type":"any","value":"","key":"deliveryID"}]}},"response":[],"_postman_id":"f9882a09-8398-426b-83ff-89cfbfbd6ea6"},{"name":"Deliveries attachments update","id":"ec715e65-5234-47c7-ad0c-ecfe3043292e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"delivery_id\": 0,\n \"attachment_id\": 0,\n \"type\": \"1\",\n \"file_manager_id\": 0,\n \"inventory_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//deliveries/:deliveryID/attachments/:attachmentID","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
`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	—

","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","","deliveries",":deliveryID","attachments",":attachmentID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"7d3df184-fef0-4479-a227-73b5f9674383","type":"any","value":"","key":"deliveryID"},{"id":"4ab4d632-481b-4b70-b245-640dd1d9884a","type":"any","value":"","key":"attachmentID"}]}},"response":[],"_postman_id":"ec715e65-5234-47c7-ad0c-ecfe3043292e"},{"name":"Deliveries attachments update patch","id":"38530243-936e-468d-a354-41aab652482d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"delivery_id\": 0,\n \"attachment_id\": 0,\n \"type\": \"1\",\n \"file_manager_id\": 0,\n \"inventory_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//deliveries/:deliveryID/attachments/:attachmentID","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
`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	—

","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","","deliveries",":deliveryID","attachments",":attachmentID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"e6919f79-d87a-41b8-86ac-7d27f81d5ec8","type":"any","value":"","key":"deliveryID"},{"id":"7ec7ff14-772a-407e-93d1-4e70b034ba28","type":"any","value":"","key":"attachmentID"}]}},"response":[],"_postman_id":"38530243-936e-468d-a354-41aab652482d"},{"name":"Deliveries attachments delete","id":"97391a29-f097-4fb8-a371-1bfa7c1ec1f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//deliveries/:deliveryID/attachments/:attachmentID?company_id=&delivery_id=&attachment_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\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`	—

","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","","deliveries",":deliveryID","attachments",":attachmentID"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"company_id","value":""},{"key":"delivery_id","value":""},{"key":"attachment_id","value":""}],"variable":[{"id":"dd142f08-f551-4f65-9376-4f5d2561e133","type":"any","value":"","key":"deliveryID"},{"id":"6ec41c7a-8da0-418e-a1d2-9e85e97a7d62","type":"any","value":"","key":"attachmentID"}]}},"response":[],"_postman_id":"97391a29-f097-4fb8-a371-1bfa7c1ec1f7"},{"name":"Deliveries items list","id":"56c96aca-cac3-4a0b-b03f-611bec288d8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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\". Options: asc, 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":"f6f43384-35d7-4a08-9b91-7e500bcb59f4","type":"any","value":"","key":"deliveryID"}]}},"response":[],"_postman_id":"56c96aca-cac3-4a0b-b03f-611bec288d8f"},{"name":"Deliveries items create","id":"5c4b986d-d6b0-4e2d-899f-e2ebc9d1146f","protocolProfileBehavior":{"disableBodyPruning":true},"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\": 0,\n \"purchase_order_id\": 0,\n \"expected_qty\": 0,\n \"warehouse_location_id\": 0,\n \"shelf\": \"\",\n \"batch_number\": \"\",\n \"expiry_date\": \"2024-01-01T00:00:00Z\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

Field	Type	Required	Description
`delivery_type`	string	yes	Allowed: `1`, `2`
`mark_as_all_received`	boolean \| null	no	—
`items`	array	yes	—

","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","","deliveries",":deliveryID","items"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"a62121e1-e342-4517-8004-30aa7c2ded93","type":"any","value":"","key":"deliveryID"}]}},"response":[],"_postman_id":"5c4b986d-d6b0-4e2d-899f-e2ebc9d1146f"},{"name":"Deliveries items bulk upsert","id":"4377f0a3-66f7-4684-8929-66ec9ddeb35d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"delivery_id\": 0,\n \"items\": [\n {\n \"inventory_id\": 0,\n \"expected_qty\": 0,\n \"purchase_order_id\": \"\",\n \"warehouse_location_id\": \"\",\n \"batch_number\": \"\",\n \"expiry_date\": \"2024-01-01T00:00:00Z\",\n \"shelf\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//deliveries/:deliveryID/items/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
`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	—
`items`	array	yes	—

","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","","deliveries",":deliveryID","items","bulk"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"a80bdf87-a303-4c64-8f3c-84f803149762","type":"any","value":"","key":"deliveryID"}]}},"response":[],"_postman_id":"4377f0a3-66f7-4684-8929-66ec9ddeb35d"},{"name":"Deliveries items add qty cancelled","id":"631344dd-c192-47b0-9554-c30b6bf0302b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"delivery_id\": \"\",\n \"item_id\": \"\",\n \"quantity\": 0,\n \"reason\": \"1\",\n \"apply_purchase_order\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//deliveries/:deliveryID/items/:itemID/add-qty-cancelled","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
`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	—

","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","","deliveries",":deliveryID","items",":itemID","add-qty-cancelled"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"47704508-4dca-44c2-83bf-05e3e121bcd2","type":"any","value":"","key":"deliveryID"},{"id":"71ad8d1a-a53c-48ab-86f0-86fa97ea2e1c","type":"any","value":"","key":"itemID"}]}},"response":[],"_postman_id":"631344dd-c192-47b0-9554-c30b6bf0302b"},{"name":"Deliveries items split line","id":"f524f7a1-864d-4947-a340-44316f2ab7dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"delivery_id\": 0,\n \"item_id\": 0,\n \"lines\": [\n {\n \"quantity\": 0,\n \"batch_number\": \"\",\n \"expiry_date\": \"2024-01-01T00:00:00Z\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//deliveries/:deliveryID/items/:itemID/split-line","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
`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	—
`lines`	array	yes	—

","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","","deliveries",":deliveryID","items",":itemID","split-line"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"8556e04c-454e-4533-a001-a802c33e34ed","type":"any","value":"","key":"deliveryID"},{"id":"b05ee436-7b3d-4550-8e87-114eabb9e09a","type":"any","value":"","key":"itemID"}]}},"response":[],"_postman_id":"f524f7a1-864d-4947-a340-44316f2ab7dc"},{"name":"Deliveries items update action qty","id":"5cce72b2-53e4-440c-8aa9-f55596000ac9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"delivery_id\": 0,\n \"item_id\": 0,\n \"action_qty\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//deliveries/:deliveryID/items/:itemID/update-action-qty","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
`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	—

","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","","deliveries",":deliveryID","items",":itemID","update-action-qty"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"cb66910a-71da-4d3d-aaf4-e4deb29586c9","type":"any","value":"","key":"deliveryID"},{"id":"636ee445-d12f-4b57-b8bb-c3400064fb6f","type":"any","value":"","key":"itemID"}]}},"response":[],"_postman_id":"5cce72b2-53e4-440c-8aa9-f55596000ac9"},{"name":"Deliveries items update warehouse location","id":"1076c3e9-e208-45e4-9d21-24ce9c14032e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"delivery_id\": \"\",\n \"item_id\": \"\",\n \"warehouse_location_id\": \"\",\n \"shelf\": \"\",\n \"batch_number\": \"\",\n \"expiry_date\": \"2024-01-01T00:00:00Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//deliveries/:deliveryID/items/:itemID/update-warehouse-location","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
`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

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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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\". Options: asc, 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":"736f640d-f3a7-4c1f-8bda-a9260902ddb2","type":"any","value":"","key":"deliveryID"}]}},"response":[],"_postman_id":"8bdb1a55-11f9-4828-8a89-072a3244b9b0"},{"name":"Deliveries sizes create","id":"eb52e425-a7f3-4b21-b6ed-7eaecaea0c2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"delivery_id\": 0,\n \"sizes\": [\n {\n \"id\": 0,\n \"unit\": \"1\",\n \"qty\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

Field	Type	Required	Description
`company_id`	integer	yes	—
`delivery_id`	integer	yes	—
`sizes`	array	yes	—

","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","","deliveries",":deliveryID","sizes"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"12d8509a-397f-4e5f-bce7-71a7d6528d3e","type":"any","value":"","key":"deliveryID"}]}},"response":[],"_postman_id":"eb52e425-a7f3-4b21-b6ed-7eaecaea0c2c"},{"name":"Deliveries time tracking start","id":"75ea23e8-6e00-4193-b8e1-18a20f8c21c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"delivery_id\": 0,\n \"is_mobile\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//deliveries/:deliveryID/start-time-tracking","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	—
`is_mobile`	boolean \| null	no	—

","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","","deliveries",":deliveryID","start-time-tracking"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"1ffb91e8-e12e-4fdb-955a-864ad74ae554","type":"any","value":"","key":"deliveryID"}]}},"response":[],"_postman_id":"75ea23e8-6e00-4193-b8e1-18a20f8c21c5"},{"name":"Deliveries time tracking stop","id":"451a5d80-1d27-444b-bc91-4fa5f252a696","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"delivery_id\": 0,\n \"stopped_at\": \"2024-01-01T00:00:00Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//deliveries/:deliveryID/stop-time-tracking","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	—
`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

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\". Options: asc, 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":"15f56ba0-92f0-49da-9aa7-ab675b35b0b3","type":"any","value":"","key":"deliveryID"}]}},"response":[],"_postman_id":"e5a4908b-416e-4006-bfc6-92fb6587040d"},{"name":"Deliveries tags create","id":"f979fd85-c06e-462f-b3bd-431c2488932f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"delivery_id\": 0,\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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	—

","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","","deliveries",":deliveryID","tags"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"66528ee7-5476-4a0c-a76d-ff3707c5f7b3","type":"any","value":"","key":"deliveryID"}]}},"response":[],"_postman_id":"f979fd85-c06e-462f-b3bd-431c2488932f"},{"name":"Deliveries tags attach","id":"d45943b3-6da0-4e2a-a3cf-02f824be2e65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"delivery_id\": 0,\n \"tag_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//deliveries/:deliveryID/tags/:tagID/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\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	—

","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","","deliveries",":deliveryID","tags",":tagID","attach"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"9f9c947c-ea05-4c8b-a5b1-ab6a5cf03a0d","type":"any","value":"","key":"deliveryID"},{"id":"038f5f2e-80be-4205-a427-174a12f4df7a","type":"any","value":"","key":"tagID"}]}},"response":[],"_postman_id":"d45943b3-6da0-4e2a-a3cf-02f824be2e65"},{"name":"Deliveries tags detach","id":"ad5f55f0-1040-4170-a500-52b9bacd5513","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"delivery_id\": 0,\n \"tag_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//deliveries/:deliveryID/tags/:tagID/detach","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
`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

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

","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","","deliveries",":deliveryID","unarchive"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"1d404cf3-3b70-4c85-bcfd-0fbee3496b95","type":"any","value":"","key":"deliveryID"}]}},"response":[],"_postman_id":"6a088aef-b824-4f23-90ee-217fd04f4b3e"},{"name":"Deliveries update expected delivery date","id":"86987509-2e8e-4aa5-acea-cdbc2b61837b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"delivery_id\": 0,\n \"expected_delivery_date\": \"2024-01-01T00:00:00Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//deliveries/:deliveryID/update-expected-delivery-date","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	—
`expected_delivery_date`	string	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":"e7d8c9fa-7e57-4923-ae06-7d39a688758f","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":"8342cdae-afd0-4e27-ac62-b84032c3bd7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"imageUrls\": [\n \"\"\n ],\n \"suppliers\": [\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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":"0130783d-70c4-499f-95b1-8f305fd6ce83","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":"769978e6-f7cc-4fc1-9328-c1b0aeb065f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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\". Options: asc, 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":"769978e6-f7cc-4fc1-9328-c1b0aeb065f5"},{"name":"Despatch target rules create","id":"841e050a-01d6-4044-a8f8-b033bf175fdc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"name\": \"\",\n \"despatch_target_hour\": 0,\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://dcv7.test/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

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	—
`actions`	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`	—

","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","","despatch-target-rules","delete-saved-conditions",":savedConditionID"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"company_id","value":""},{"key":"saved_condition_id","value":""}],"variable":[{"id":"1c14f8a1-a7f0-47b6-aef7-be486633ebc1","type":"any","value":"","key":"savedConditionID"}]}},"response":[],"_postman_id":"0c68e382-962e-4784-b4e8-cf5aa1358025"},{"name":"Despatch target rules restore conditions","id":"517b3020-d2ae-4e85-a08b-b768b8f4ba31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"saved_condition_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//despatch-target-rules/restore-conditions/:savedConditionID","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
`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	—

","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","","despatch-target-rules","restore-conditions",":savedConditionID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"edcd8442-a7f8-42b5-91da-52805873d5ed","type":"any","value":"","key":"savedConditionID"}]}},"response":[],"_postman_id":"517b3020-d2ae-4e85-a08b-b768b8f4ba31"},{"name":"Despatch target rules save conditions","id":"a1bc10b0-bc3f-4570-a7c1-f9e5e52a9bed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"name\": \"\",\n \"conditions\": [\n [\n {\n \"field\": \"1\",\n \"operator\": 0,\n \"value\": [\n \"\"\n ]\n }\n ]\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//despatch-target-rules/save-conditions","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	—
`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`	—

","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","","despatch-target-rules","saved-conditions"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"company_id","value":""}],"variable":[]}},"response":[],"_postman_id":"bdceb5fb-1681-44c2-bef1-cd021ba5d22e"},{"name":"Despatch target rules sorting","id":"3566a2ee-ca1d-4f4e-9b5c-297eda81b6a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"sorting\": [\n {\n \"id\": 0,\n \"order\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//despatch-target-rules/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

Body 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	—
`sorting`	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
`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":"ef58e74f-faeb-4df9-bcab-c36abfdcf93d","type":"any","value":"","key":"despatchTargetRuleID"}]}},"response":[],"_postman_id":"15c68eb0-8cf9-45f3-98d8-f70966d25bf3"},{"name":"Despatch target rules update","id":"58791713-d42b-43e8-a7b3-67819e246201","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"name\": \"\",\n \"despatch_target_hour\": 0,\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://dcv7.test/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

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	—
`actions`	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
`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`	—

","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","","despatch-target-rules",":despatchTargetRuleID"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"company_id","value":""},{"key":"despatch_target_rule_id","value":""}],"variable":[{"id":"271fdc3f-694d-4f44-962b-d9f24cf3c853","type":"any","value":"","key":"despatchTargetRuleID"}]}},"response":[],"_postman_id":"ad17f806-bb95-416c-b19d-dfd5cd9453ee"},{"name":"Despatch target rules change status","id":"07ebf3c6-5347-46b3-94ec-27ed519d3e5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//despatch-target-rules/:despatchTargetRuleID/change-status","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

Field	Type	Required	Description
`company_id`	integer	yes	—

","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","","despatch-target-rules",":despatchTargetRuleID","change-status"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"809afa86-f175-4890-9052-0bce4aabee94","type":"any","value":"","key":"despatchTargetRuleID"}]}},"response":[],"_postman_id":"07ebf3c6-5347-46b3-94ec-27ed519d3e5c"},{"name":"Despatch target rules duplicate","id":"6a4ff6fb-a7c0-4a9a-8956-2ac150ba5ec2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//despatch-target-rules/:despatchTargetRuleID/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
`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	—

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":"9e46f044-7587-4910-8770-383b1f90dffc","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":"bb76cf6e-bf00-4577-8e1f-0bbd6360d5cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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\". Options: asc, 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":"bb76cf6e-bf00-4577-8e1f-0bbd6360d5cb"},{"name":"Document rules create","id":"c7fba939-2567-4e04-bae6-284ae8fe6468","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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
`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`	—

","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","","document-rules","delete-saved-conditions",":savedConditionID"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"company_id","value":""},{"key":"saved_condition_id","value":""}],"variable":[{"id":"a4e36d50-b7ed-48b1-a067-dbcc748af85a","type":"any","value":"","key":"savedConditionID"}]}},"response":[],"_postman_id":"8012e470-a071-413c-a1ba-b4456ccb71e9"},{"name":"Document rules restore conditions","id":"bddb5c7a-11d9-4215-9394-13cfeb4c38c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"saved_condition_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//document-rules/restore-conditions/:savedConditionID","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
`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	—

","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","","document-rules","restore-conditions",":savedConditionID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"f060c335-fd26-4917-a9de-214fe2fd91f2","type":"any","value":"","key":"savedConditionID"}]}},"response":[],"_postman_id":"bddb5c7a-11d9-4215-9394-13cfeb4c38c4"},{"name":"Document rules save conditions","id":"a83da2e6-fee5-4165-8861-602dcab9a560","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"name\": \"\",\n \"conditions\": [\n [\n {\n \"field\": \"6\",\n \"operator\": 0,\n \"value\": [\n \"\"\n ]\n }\n ]\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//document-rules/save-conditions","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	—
`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`	—

","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","","document-rules","saved-conditions"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"company_id","value":""}],"variable":[]}},"response":[],"_postman_id":"7645ed9e-b896-48b6-96a9-ef6890d661ca"},{"name":"PATCH /sorting — reorder the company's document rules","id":"77a7573c-8658-4c3d-a705-580e84a86b1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"sorting\": [\n {\n \"id\": 0,\n \"order\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//document-rules/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

Body 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	—
`sorting`	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
`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":"646d0b80-e490-4f7b-bcda-b120ca7b4838","type":"any","value":"","key":"documentRuleID"}]}},"response":[],"_postman_id":"1cde2834-6920-4621-b738-ca425d6f8e61"},{"name":"Document rules update","id":"45bf7f1a-3742-4ef0-acb2-1f08602d5605","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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

","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","","document-rules",":documentRuleID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"1b1c8d4c-1275-4e40-9626-7d14d71bb9e4","type":"any","value":"","key":"documentRuleID"}]}},"response":[],"_postman_id":"45bf7f1a-3742-4ef0-acb2-1f08602d5605"},{"name":"Document rules change status","id":"8ec0713b-0459-4aee-a7ba-e387c6f69217","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"document_rule_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//document-rules/:documentRuleID/change-status","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

Body 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	—

","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","","document-rules",":documentRuleID","change-status"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"0cdd9f88-22e2-4024-bab2-a95dfb72cd7d","type":"any","value":"","key":"documentRuleID"}]}},"response":[],"_postman_id":"8ec0713b-0459-4aee-a7ba-e387c6f69217"},{"name":"Document rules duplicate","id":"5f779c36-3e76-48ed-8288-9240281d15b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"document_rule_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//document-rules/:documentRuleID/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
`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	—

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":"c8b5fc2e-224c-4931-a042-1f906fa82ea9","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":"fe654a91-a3af-452b-a9d5-6bab1d4d7c43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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\". Options: asc, 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":"fe654a91-a3af-452b-a9d5-6bab1d4d7c43"},{"name":"Email templates create","id":"44d877ab-53d8-4250-97a1-7f7574df5f97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"name\": \"\",\n \"format\": \"1\",\n \"type\": \"1\",\n \"html\": \"\",\n \"json\": \"\",\n \"file_manager_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

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`

Options: 1, 2

\n","type":"text/plain"},"key":"types[]","value":""}],"variable":[]}},"response":[],"_postman_id":"800e2804-ce33-4d1b-a674-60a39b52ed67"},{"name":"Email templates tags list","id":"a117a4c5-3ae4-4590-bbbe-ff5445e73d5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//email-templates/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
`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).

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

Options: asc, desc

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"key":"includes_count","value":""},{"disabled":true,"key":"page","value":""},{"disabled":true,"key":"per_page","value":""}],"variable":[]}},"response":[],"_postman_id":"a117a4c5-3ae4-4590-bbbe-ff5445e73d5d"},{"name":"Email templates test email","id":"f1df9b12-3c9a-41e6-8b84-23793103f0ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"html\": \"\",\n \"emails\": [\n \"user@example.com\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//email-templates/test-email","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	—
`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

Parameter	Description
`includes_count`	—

","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","","email-templates",":emailTemplateID"],"host":["https://dcv7.test/api/v2"],"query":[{"disabled":true,"key":"includes_count","value":""}],"variable":[{"id":"77e40fca-8ee6-42e0-88fe-3abff681e749","type":"any","value":"","key":"emailTemplateID"}]}},"response":[],"_postman_id":"5ea32b98-7e27-42e7-95ad-e06207997b2c"},{"name":"Email templates update","id":"f5644f6f-1123-4b50-84f8-8ccd2beb66ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"email_template_id\": 0,\n \"name\": \"\",\n \"format\": \"1\",\n \"html\": \"\",\n \"json\": \"\",\n \"file_manager_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//email-templates/:emailTemplateID","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
`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	—

","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","","email-templates",":emailTemplateID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"6c839836-8f98-4cf0-8350-3c173decf255","type":"any","value":"","key":"emailTemplateID"}]}},"response":[],"_postman_id":"f5644f6f-1123-4b50-84f8-8ccd2beb66ef"},{"name":"Email templates update patch","id":"c4d8955c-91ee-4f6b-88d3-75155954d63e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"email_template_id\": 0,\n \"name\": \"\",\n \"format\": \"1\",\n \"html\": \"\",\n \"json\": \"\",\n \"file_manager_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//email-templates/:emailTemplateID","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
`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\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`	—

","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","","email-templates",":emailTemplateID","duplicate"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"company_id","value":""},{"key":"email_template_id","value":""}],"variable":[{"id":"cac9d926-c500-4ff1-bf83-68a6cf9dc844","type":"any","value":"","key":"emailTemplateID"}]}},"response":[],"_postman_id":"c25c93c3-120e-4d8b-94a8-b38db94c72f1"},{"name":"Email templates tags add","id":"4eadf893-0b1b-4204-b8cb-e52b35f93d6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"company_id\": 0,\n \"email_template_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//email-templates/:emailTemplateID/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
`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	—

","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","","email-templates",":emailTemplateID","tags"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"9eb34d5d-60b9-439e-866b-65df13321478","type":"any","value":"","key":"emailTemplateID"}]}},"response":[],"_postman_id":"4eadf893-0b1b-4204-b8cb-e52b35f93d6e"},{"name":"Email templates tags attach","id":"90ac150a-f27c-462c-ac2a-6965f6cbd2bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"email_template_id\": 0,\n \"tag_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//email-templates/:emailTemplateID/tags/attach/:tagID","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
`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	—

","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","","email-templates",":emailTemplateID","tags","attach",":tagID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"9945b136-e449-4765-8aa8-36585c3b8356","type":"any","value":"","key":"emailTemplateID"},{"id":"535eeba3-349d-43bb-85ba-d5206968c689","type":"any","value":"","key":"tagID"}]}},"response":[],"_postman_id":"90ac150a-f27c-462c-ac2a-6965f6cbd2bc"},{"name":"Email templates tags detach","id":"f9bfb859-70b2-4e2f-ba63-b4bbbfffb27c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"email_template_id\": 0,\n \"tag_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//email-templates/:emailTemplateID/tags/detach/:tagID","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
`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	—

","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","","email-templates",":emailTemplateID","tags","detach",":tagID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"67ee4a65-b854-4084-877c-74f0fa772275","type":"any","value":"","key":"emailTemplateID"},{"id":"8aafb85e-5e78-4bb3-aa3b-a082bc27711c","type":"any","value":"","key":"tagID"}]}},"response":[],"_postman_id":"f9bfb859-70b2-4e2f-ba63-b4bbbfffb27c"},{"name":"Email templates toggle","id":"2e8bc891-bf47-48b0-a985-2559038bba5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"email_template_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//email-templates/:emailTemplateID/toggle","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
`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	—

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":"d270f800-85d5-4b02-a0f3-f35a99e92e62","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":"5745ee90-83ca-491a-a38a-13a4ca28b0a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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\". Options: asc, 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":"5745ee90-83ca-491a-a38a-13a4ca28b0a6"},{"name":"Fixed banners show","id":"2d8e0dd6-d41d-44e3-a0c7-8ee37c1c4576","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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`	—

","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","","fixed-banners",":fixedBannerID"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"company_id","value":""},{"key":"fixed_banner_id","value":""},{"disabled":true,"key":"includes_count","value":""}],"variable":[{"id":"3e063ce1-8f14-4ac7-9942-98fea83e73bc","type":"any","value":"","key":"fixedBannerID"}]}},"response":[],"_postman_id":"2d8e0dd6-d41d-44e3-a0c7-8ee37c1c4576"},{"name":"Fixed banners dismiss","id":"b0383ead-fcd7-4ae9-9790-70c3ac0e17fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"fixed_banner_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//fixed-banners/:fixedBannerID/dismiss","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

Body 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":"20399328-7053-49c1-a28e-2456c2517c19","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":"4620e004-5c08-4f9e-b022-9f1d63323b01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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\". Options: asc, 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":"4620e004-5c08-4f9e-b022-9f1d63323b01"},{"name":"Global system notifications snooze","id":"3ae58a18-9cdf-4e7c-a3f1-37c7c7e74fb6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"notification_id\": 0,\n \"snooze_delay\": \"1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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":"4192433f-ae24-4330-89af-bd32470575e4","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 list","id":"19427a0f-dc14-4b7a-90f1-1daea22e2ca2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//import-export/exports","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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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\". Options: asc, 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":"19427a0f-dc14-4b7a-90f1-1daea22e2ca2"},{"name":"Import export exports export","id":"c1273ad6-78f7-407c-b94a-f0abfb50a414","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//import-export/exports/export","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

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
`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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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\". Options: asc, 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":"97e1ff3a-3f8c-40ab-889b-26d8af7a2b9e"},{"name":"Import export imports load","id":"c59ba5b7-7459-4d28-8092-a1e5857dae4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//import-export/imports/load","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

","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","","import-export","imports","load"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"c59ba5b7-7459-4d28-8092-a1e5857dae4d"},{"name":"Import export imports start","id":"aa906671-2931-48e4-a2c1-35cb28240b4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"type\": \"0\",\n \"import_name\": \"\",\n \"key\": \"\",\n \"post_action\": false,\n \"set_status\": \"1\",\n \"format\": \"csv\",\n \"mapping_id\": 0,\n \"mappings\": [\n {\n \"key\": \"code\",\n \"value\": \"\",\n \"is_fixed_value\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//import-export/imports/start","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	—
`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	—

Path parameters

\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
`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\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).

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

Options: asc, desc

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"key":"includes_count","value":""},{"disabled":true,"key":"page","value":""},{"disabled":true,"key":"per_page","value":""},{"key":"company_id","value":""},{"key":"import_id","value":""}],"variable":[{"id":"de7ef8df-ee52-4dbc-99b7-09cf513bb4bf","type":"any","value":"","key":"importID"}]}},"response":[],"_postman_id":"827991b3-7a43-4312-af45-1138fcea6730"},{"name":"Import export mappings list","id":"3c19de99-dcc1-4991-adf3-6ce1961d712e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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).

Options: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17

\n","type":"text/plain"},"key":"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\". Options: asc, 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":"3c19de99-dcc1-4991-adf3-6ce1961d712e"},{"name":"Import export mappings create","id":"422fd128-7e25-4a58-92d4-04f00716aa0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"name\": \"\",\n \"type\": \"0\",\n \"mappings\": [\n {\n \"key\": \"code\",\n \"value\": \"\",\n \"is_fixed_value\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

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	—

Path parameters

\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	—
`mappings`	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
`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`

Options: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17

\n","type":"text/plain"},"key":"type","value":""}],"variable":[{"id":"74985a9c-0ec9-4f20-8266-95e42ab523ff","type":"any","value":"","key":"type"}]}},"response":[],"_postman_id":"7665ab8d-2c1a-4bc8-8e64-9cb6a12d6448"},{"name":"Import export mappings types","id":"b049183b-1779-4075-820f-d448a83e64b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//import-export/mappings/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
`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`	—

","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","","import-export","mappings",":mappingID"],"host":["https://dcv7.test/api/v2"],"query":[{"disabled":true,"key":"includes_count","value":""}],"variable":[{"id":"1ad38da4-b136-482e-a51b-80d38585c339","type":"any","value":"","key":"mappingID"}]}},"response":[],"_postman_id":"7a083cc1-6bdb-4680-b2e6-4533557e412a"},{"name":"Import export mappings update put","id":"92c44289-ad18-4ca2-93c3-d6e224d7afa4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"type\": \"0\",\n \"mapping_id\": 0,\n \"name\": \"\",\n \"mappings\": [\n {\n \"key\": \"code\",\n \"value\": \"\",\n \"is_fixed_value\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//import-export/mappings/:mappingID","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
`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

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	—

","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","","import-export","mappings",":mappingID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"9c689e6e-da1a-4c1f-a4af-e638ab739a54","type":"any","value":"","key":"mappingID"}]}},"response":[],"_postman_id":"92c44289-ad18-4ca2-93c3-d6e224d7afa4"},{"name":"Import export mappings update","id":"d8f01d95-e340-4253-8bb0-c2c83cc157af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"type\": \"0\",\n \"mapping_id\": 0,\n \"name\": \"\",\n \"mappings\": [\n {\n \"key\": \"code\",\n \"value\": \"\",\n \"is_fixed_value\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//import-export/mappings/:mappingID","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
`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

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	—

Path parameters

\n\n\n\n\n\n\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":"85ed1183-e059-4750-9c7f-8b5d05bc835d","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 list","id":"2304dca7-fef8-4d79-b02e-66598d17cd85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//inventory","description":"

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 _from / _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
\n
meta.description
\n
meta.customsDescription
\n
meta.country
\n
meta.packageTemplate
\n
meta.taxGroup
\n
dimension
\n
groupItems
\n
groupItems.inventory
\n
groupItems.inventory.meta
\n
groupItems.inventoryItem
\n
groupItems.inventoryItem.meta
\n
category
\n
category.category
\n
category.category.parent
\n
courierService
\n
courierService.courierService
\n
courierService.courierService.courier
\n
tags
\n
tags.tag
\n
customFields
\n
customFields.customFieldOption
\n
settings
\n
shelf
\n
shelf.shelf
\n
stocks
\n
stocks.location
\n
stocks.location.settings
\n
linkedChannelProduct
\n
linkedChannelProduct.channel
\n
linkedChannelProduct.channel.settings
\n
barcodes
\n
inventorySuppliers
\n
inventorySuppliers.inventoryContainer
\n
inventorySuppliers.supplier
\n
inventorySuppliers.supplier.contact
\n
associatedGroup
\n
associatedGroup.inventory.meta
\n
purchaseOrderControl
\n
primarySupplier
\n
primarySupplier.supplier
\n
primarySupplier.supplier.contact
\n
primarySupplier.supplier.fileManager
\n
family
\n
family.family
\n
openInventoryChekItems
\n
exportValues
\n
exportValues.countries
\n
exportValues.countries.country
\n
groupItems.inventoryItem.exportValues
\n
groupItems.inventoryItem.exportValues.countries
\n
groupItems.inventoryItem.exportValues.countries.country
\n
containers
\n
exportValues
\n
exportValues.countries
\n
exportValues.countries.country
\n
groupItems.inventoryItem.exportValues
\n
groupItems.inventoryItem.exportValues.countries
\n
groupItems.inventoryItem.exportValues.countries.country
\n
groupItems.inventoryItem.dimension
\n
groupItems.inventoryItem.serials
\n
batches
\n
batches.location
\n
serials
\n
groupItems.inventoryItem.dimension
\n
groupItems.inventoryItem.settings
\n

Sorting & pagination

Sorting: sort_by= with sort_direction=asc|desc.
\n
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

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\". Options: asc, 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":"2304dca7-fef8-4d79-b02e-66598d17cd85"},{"name":"Inventory create","id":"af273b9f-e9b0-4072-8b2a-0d5d554e1973","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"code\": \"\",\n \"name\": \"\",\n \"inventory_type_id\": \"1\",\n \"batching_type\": \"1\",\n \"courier_service_id\": 0,\n \"tax_group_id\": 0,\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\": 0,\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\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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	—
`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	—
`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	—
`quantity`	number	yes	—
`country_id`	integer \| null	no	—
`hs_code`	number \| null	no	—
`customs_description`	string \| null	no	—
`customs_value`	number \| null	no	—
`description`	string \| null	no	—
`cost_price`	number \| null	no	—
`price`	number \| null	no	—
`tags`	array \| null	no	—
`barcodes`	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\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

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
`inventory_ids`	array	yes	—

","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","","inventory","bulk-archive"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d3827d5-d91d-4756-8835-1e28cb68850f"},{"name":"Inventory bulk create","id":"9daba50f-cd10-4f7e-98c8-c5cb00a61ec5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"inventories\": [\n {\n \"code\": \"\",\n \"name\": \"\",\n \"inventory_type_id\": \"1\",\n \"quantity\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/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

Field	Type	Required	Description
`inventories`	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	—

Path parameters

\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
`inventories`	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

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

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\". Options: asc, 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":"f5721f05-6f67-44a2-87a7-0124ec6593c4"},{"name":"Inventory category create","id":"5b28966c-853b-4e6b-9b5a-acfa994b740c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"parent_id\": 0,\n \"description\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

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
`inventories`	array	yes	—

","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","","inventory","category","bulk-attach"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"4ec0039d-aa6b-4f29-ba6c-66489871af35"},{"name":"Inventory category bulk create","id":"cbb04fcc-9d20-40db-bcaf-18c0d97be1a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"categories\": [\n {\n \"name\": \"\",\n \"parent_id\": 0,\n \"description\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/category/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

Field	Type	Required	Description
`categories`	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
`inventories`	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
`categories`	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
`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

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
`term`	—
`ignore_ids[]`	—
`is_archived`	—

Path parameters

\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

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\". Options: asc, 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":"df9135cf-90ea-4427-b1d5-d0da26ea45cb"},{"name":"Inventory ext tags list","id":"445638d5-f901-4295-99cd-d371765a0c16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//inventory/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
`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\". Options: asc, 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":"445638d5-f901-4295-99cd-d371765a0c16"},{"name":"Inventory types","id":"a3f870f5-3d61-48c6-a138-512664e95299","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//inventory/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
`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":"17d18417-6839-4759-9560-a0b90633af66","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"3156b1a8-64ad-4e71-9b07-81c88153f6b2"},{"name":"Inventory update","id":"b2c65c26-a9f5-409c-ab4a-98991309897c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"name\": \"\",\n \"courier_service_id\": 0,\n \"tax_group_id\": 0,\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}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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 \| 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	—

Path parameters

\n\n\n\n\n\n\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

Path parameters

\n\n\n\n\n\n\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\". Options: asc, 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":"96bcd2fb-5f90-4893-8cea-6bdbb9c54a68","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"e24ecba5-5d07-4b39-b6a2-70f5f3e424f2"},{"name":"Inventory barcodes list","id":"48f1b8ff-3287-4885-abc0-b9824f9c2053","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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\". Options: asc, 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":"80478320-cf5d-42b6-8c08-7c8b82e26267","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"48f1b8ff-3287-4885-abc0-b9824f9c2053"},{"name":"Inventory barcodes create","id":"48a95104-65c6-4806-89a1-173303d30b7e","protocolProfileBehavior":{"disableBodyPruning":true},"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\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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	—

","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","","inventory",":inventoryID","barcodes"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"09aac399-e9c8-4a7b-a222-273f73e51ecc","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"48a95104-65c6-4806-89a1-173303d30b7e"},{"name":"Inventory ext barcodes update","id":"bc739f6d-17ae-476f-bb1e-7a45ba49eb94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"inventory_barcode_type_id\": \"1\",\n \"value\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/barcodes/:barcodeID","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
`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

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\". Options: asc, 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":"b38bc890-5637-4aff-bf7e-e2d2adda54d3","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"30dd691a-1e5c-4a9a-9162-e06a671eb194"},{"name":"Inventory batches create","id":"cc722888-3fb0-4586-ae10-a4edf0d77f9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"location_id\": 0,\n \"quantity\": 0,\n \"batch_number\": \"\",\n \"expiry_date\": \"2024-01-01T00:00:00Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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	—

","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","","inventory",":inventoryID","batches"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"750451ea-8c7d-418a-a3f1-13f47239f9ad","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"cc722888-3fb0-4586-ae10-a4edf0d77f9c"},{"name":"Inventory batches bulk store","id":"4be21268-f834-40ab-8985-f6ec5c503977","protocolProfileBehavior":{"disableBodyPruning":true},"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\": 0,\n \"quantity\": 0,\n \"batch_number\": \"\",\n \"expiry_date\": \"2024-01-01T00:00:00Z\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

Field	Type	Required	Description
`batches`	array	yes	—

","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","","inventory",":inventoryID","batches","bulk"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"fe30f92c-9cd3-4c9a-a6a8-489704a9a245","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"4be21268-f834-40ab-8985-f6ec5c503977"},{"name":"Inventory batches bulk upsert","id":"e3385d7d-aa06-4cb2-9afa-1f5dca5f7539","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"deleted_ids\": [\n 0\n ],\n \"batches\": [\n {\n \"id\": 0,\n \"location_id\": 0,\n \"quantity\": 0,\n \"batch_number\": \"\",\n \"expiry_date\": \"2024-01-01T00:00:00Z\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

Field	Type	Required	Description
`deleted_ids`	array	no	—
`batches`	array	no	—

","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","","inventory",":inventoryID","batches","bulk"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"84cd5924-ee44-4540-9c8f-aaf471af69e4","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"e3385d7d-aa06-4cb2-9afa-1f5dca5f7539"},{"name":"Inventory batches update","id":"dd4edbce-1bd2-4b52-baa3-8047448c7375","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"location_id\": \"\",\n \"quantity\": 0,\n \"batch_number\": \"\",\n \"expiry_date\": \"2024-01-01T00:00:00Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/batches/:batchID","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
`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

Path parameters

\n\n\n\n\n\n\n\n\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

","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","","inventory",":inventoryID","category",":categoryID","attach"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"f9863ccb-15b7-402e-851e-25660ccac9e2","type":"any","value":"","key":"inventoryID"},{"id":"94ea634f-0b74-43d6-9186-cf4ae8ef0511","type":"any","value":"","key":"categoryID"}]}},"response":[],"_postman_id":"ee110409-8c46-4008-b88b-a3b1ddc4f485"},{"name":"Inventory category detach","id":"0fc7323b-91ca-4628-90d0-87f49be0e95a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/category/:categoryID/detach","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
`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

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\". Options: asc, 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":"343dd6c8-4c57-4b48-a5b6-8130558aebf8","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"fbf8c6fa-54ae-4047-8fb0-b9b9332efa67"},{"name":"Inventory ext containers create","id":"37cf4e1a-16be-4e6c-afcc-13ea97fdf166","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"containers\": [\n {\n \"id\": 0,\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://dcv7.test/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

Field	Type	Required	Description
`containers`	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
`inventoryID`	integer	yes
`containerID`	integer	yes

","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","","inventory",":inventoryID","containers",":containerID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"40cbe1cd-6cde-4702-b49b-0a0eedf52532","type":"any","value":"","key":"inventoryID"},{"id":"7087975e-8f43-424a-b735-e84e83e7647e","type":"any","value":"","key":"containerID"}]}},"response":[],"_postman_id":"9426c412-4986-499f-87ee-aea0ef80c2d8"},{"name":"Inventory ext courier service create","id":"52f21dc8-4d1a-491f-8f61-da0445718e6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"courier_service_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/courier-service","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
`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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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`	—

","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","","inventory",":inventoryID","customs-information"],"host":["https://dcv7.test/api/v2"],"query":[{"disabled":true,"key":"includes_count","value":""}],"variable":[{"id":"135ba494-5091-4ca2-bab4-546cba38a5f7","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"d4dc424b-5202-46e0-872d-2c8f72b0b049"},{"name":"Inventory ext customs information update","id":"561be77e-d420-4fd1-88ba-9030ea164092","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"country_id\": 0,\n \"hs_code\": 0,\n \"description\": \"\",\n \"customs_value\": 0,\n \"export_values\": [\n {\n \"country_ids\": [\n 0\n ],\n \"value\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/customs-information","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
`country_id`	integer \| null	no	—
`hs_code`	number \| null	no	—
`description`	string \| null	no	—
`customs_value`	number \| null	no	—
`export_values`	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

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\". Options: asc, 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":"17389190-24a9-4f96-92b4-4b72f6d17fb3","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"d0e78de9-de73-45be-98ac-20c8b3b2c74e"},{"name":"Inventory ext export values sync","id":"44b50fac-8b8f-4e90-b4ea-774c69651bc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"items\": [\n {\n \"country_ids\": [\n 0\n ],\n \"value\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/export-values/sync","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
`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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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

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

","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","","inventory",":inventoryID","families",":familyID","attach"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"1692068f-b5cc-41e8-a59a-b16793533722","type":"any","value":"","key":"inventoryID"},{"id":"cfe1f9bc-7c93-4267-9625-7bb76861f2d4","type":"any","value":"","key":"familyID"}]}},"response":[],"_postman_id":"bc8b52e9-a058-47a1-8ddd-e1773f81fe7e"},{"name":"Inventory ext item families detach","id":"f4473362-84e3-45ab-87a1-85019536fb9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/families/:familyID/detach","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
`inventoryID`	integer	yes
`familyID`	integer	yes

","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","","inventory",":inventoryID","families",":familyID","detach"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"fead4145-ff98-4c1e-84ff-826de6cb766a","type":"any","value":"","key":"inventoryID"},{"id":"47be9dc6-8070-43bb-b1f9-5af8eed6de62","type":"any","value":"","key":"familyID"}]}},"response":[],"_postman_id":"f4473362-84e3-45ab-87a1-85019536fb9b"},{"name":"Inventory ext group items sync","id":"7e00294e-6f8d-4d99-9dd3-a5252985e928","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"removed_inventory_ids\": [\n 0\n ],\n \"items\": [\n {\n \"quantity\": 0,\n \"group_item_id\": 0,\n \"inventory_item_id\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/group-items/sync","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
`removed_inventory_ids`	array \| null	no	—
`items`	array	yes	—

","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","","inventory",":inventoryID","group-items","sync"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"549d669c-9f3b-431a-a9a7-4e8c3e5e35c7","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"7e00294e-6f8d-4d99-9dd3-a5252985e928"},{"name":"Inventory ext group items update quantity","id":"e0d339d9-5c86-4994-84ba-f5435a099c89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"quantity\": 0,\n \"inventory_item_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/group-items/:inventoryItemID/update-quantity","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
`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

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\". Options: asc, 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":"eb47baad-54b7-43ac-885d-e6b42ce6f211","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"4605ca03-8c38-4b85-a8c7-0838a0643d5e"},{"name":"Inventory items bulk attach","id":"7c746935-ab9b-4d29-8fc6-ab8c55e1416f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"items\": [\n {\n \"quantity\": 0,\n \"inventory_item_id\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

Field	Type	Required	Description
`items`	array	yes	—

","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","","inventory",":inventoryID","items","bulk-attach"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"5ae13727-ddca-4113-a86e-31fb4f621f23","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"7c746935-ab9b-4d29-8fc6-ab8c55e1416f"},{"name":"Inventory items bulk detach","id":"f42c64cc-0682-4972-81a5-78e134b9c3c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"items\": [\n 0\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/items/bulk-detach","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
`items`	array	yes	—

","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","","inventory",":inventoryID","items","bulk-detach"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"ab26efa6-5eab-4155-a998-7b0cb43b5834","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"f42c64cc-0682-4972-81a5-78e134b9c3c4"},{"name":"Inventory items bulk update","id":"54886b3d-a3d5-429d-9e86-3443f7a3245c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"items\": [\n {\n \"quantity\": 0,\n \"inventory_item_id\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/items/bulk-update","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
`items`	array	yes	—

","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","","inventory",":inventoryID","items","bulk-update"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"33d91d26-3925-4be5-80e4-0b2edfd55b45","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"54886b3d-a3d5-429d-9e86-3443f7a3245c"},{"name":"Inventory items update","id":"cc66dc77-3fea-4973-a886-303de6ca58e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"quantity\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/items/:inventoryItemID","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
`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	—

","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","","inventory",":inventoryID","items",":inventoryItemID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"8a2d7783-d27a-430b-934a-b58d80bc1236","type":"any","value":"","key":"inventoryID"},{"id":"909f39cc-9e43-40ec-b1e9-0fdde1c2c255","type":"any","value":"","key":"inventoryItemID"}]}},"response":[],"_postman_id":"cc66dc77-3fea-4973-a886-303de6ca58e9"},{"name":"Inventory items attach","id":"c0808232-3b7d-4afd-bc9a-c248b8607972","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"quantity\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/items/:inventoryItemID/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\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	—

","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","","inventory",":inventoryID","items",":inventoryItemID","attach"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"a220f428-c11f-4f4a-8c7e-4fef58de7fa5","type":"any","value":"","key":"inventoryID"},{"id":"8e02ca60-7643-4baa-a5f0-4d0d4852e84a","type":"any","value":"","key":"inventoryItemID"}]}},"response":[],"_postman_id":"c0808232-3b7d-4afd-bc9a-c248b8607972"},{"name":"Inventory items detach","id":"025ed9ae-fe32-403d-8012-b8a023e7a759","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/items/:inventoryItemID/detach","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
`inventoryID`	integer	yes
`inventoryItemID`	integer	yes

","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","","inventory",":inventoryID","items",":inventoryItemID","detach"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"c32919b0-2122-4405-a5a7-35b52204bfd9","type":"any","value":"","key":"inventoryID"},{"id":"7d0c5130-cf0f-4455-905b-b77286c945e9","type":"any","value":"","key":"inventoryItemID"}]}},"response":[],"_postman_id":"025ed9ae-fe32-403d-8012-b8a023e7a759"},{"name":"Inventory ext product dimension list","id":"8c714f84-18e1-495a-b1c5-bbd3d95063dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/product-dimension","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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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`	—

","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","","inventory",":inventoryID","product-dimension"],"host":["https://dcv7.test/api/v2"],"query":[{"disabled":true,"key":"includes_count","value":""}],"variable":[{"id":"4b02c04a-42a4-44c7-befc-b1f3854cf3ad","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"8c714f84-18e1-495a-b1c5-bbd3d95063dd"},{"name":"Inventory ext product dimension update","id":"652ae183-1905-4ded-bfa9-3ed3098a9689","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"height\": 0,\n \"weight\": 0,\n \"width\": 0,\n \"length\": 0,\n \"nest_height\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/product-dimension","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
`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`	—

","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","","inventory",":inventoryID","product-information"],"host":["https://dcv7.test/api/v2"],"query":[{"disabled":true,"key":"includes_count","value":""}],"variable":[{"id":"0b06ade6-c94d-466e-a749-1d2dcdd58fba","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"6729533d-404c-4786-8457-8445a73a5bd3"},{"name":"Inventory ext product information update","id":"8f24ee0b-fdef-45be-9aa0-dbc9ad748949","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"location\": \"\",\n \"cost_price\": 0,\n \"price\": 0,\n \"name\": \"\",\n \"description\": \"\",\n \"shelf\": \"\",\n \"tax_group_id\": 0,\n \"count_period\": \"1\",\n \"batching_type\": \"1\",\n \"expiry_lead_time_days\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/product-information","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
`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`	—

","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","","inventory",":inventoryID","purchase-order-controls","detail"],"host":["https://dcv7.test/api/v2"],"query":[{"disabled":true,"key":"includes_count","value":""}],"variable":[{"id":"6cd3d498-d05c-44df-b435-b438c38f20ad","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"c4bfee22-ef5b-4c6e-ac7c-dabc8d9df6b3"},{"name":"Inventory ext purchase order controls find inventory suppliers","id":"3b1a3fe2-2900-4816-a3fb-aadbc60b31dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/purchase-order-controls/find-inventory-suppliers?type=","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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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`

Options: 1, 3

\n","type":"text/plain"},"key":"type","value":""}],"variable":[{"id":"89c3fe1b-90b9-46d5-8e86-39f439083604","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"3b1a3fe2-2900-4816-a3fb-aadbc60b31dd"},{"name":"Inventory ext purchase order controls update","id":"058a64e0-be06-4a13-a76e-e2e47e002bba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"ordering_method\": \"1\",\n \"is_warning_open\": false,\n \"warning_level\": 0,\n \"days_of_stock_required\": 0,\n \"maximum_level\": 0,\n \"exclude_zero_sale_days\": false,\n \"calculation_method\": \"1\",\n \"calculation_timeframe\": \"1\",\n \"trigger_level\": \"\",\n \"target_level\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/purchase-order-controls/update","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
`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
`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

Path parameters

\n\n\n\n\n\n\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\". Options: asc, 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":"e714eff7-d895-4670-8e8d-35f04f4ea9aa","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"913871eb-b581-43cd-b6c2-db9ec2e00a68"},{"name":"Inventory serials create","id":"7d94c588-8d70-4bc2-870e-f6283c1ed6e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"serial_number\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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	—

","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","","inventory",":inventoryID","serials"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"39fda2cd-fd33-4023-bf6a-a1824773a478","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"7d94c588-8d70-4bc2-870e-f6283c1ed6e1"},{"name":"Inventory serials bulk store","id":"87bd62ae-9702-4ee4-9e63-f67ffe60b3f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"serials\": [\n {\n \"serial_number\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/serials/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

Field	Type	Required	Description
`serials`	array	yes	—

","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","","inventory",":inventoryID","serials","bulk"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"0f947f63-b503-4399-9bba-9351bb07d877","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"87bd62ae-9702-4ee4-9e63-f67ffe60b3f3"},{"name":"Inventory serials bulk upsert","id":"2bb4a96d-3568-4ddb-90ff-205d61c8dbcd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"deleted_ids\": [\n 0\n ],\n \"serials\": [\n {\n \"id\": 0,\n \"serial_number\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/serials/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

Field	Type	Required	Description
`deleted_ids`	array	no	—
`serials`	array	no	—

","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","","inventory",":inventoryID","serials","bulk"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"bf164238-aed3-4ce3-ac15-5bb021f39557","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"2bb4a96d-3568-4ddb-90ff-205d61c8dbcd"},{"name":"Inventory serials update","id":"c4427f20-06b1-4b9b-8dbd-0aef7f5c1c94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"serial_number\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/serials/:serialID","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
`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

","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","","inventory",":inventoryID","serials",":serialID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"e1142f07-5701-49a7-9f09-78cda8aac9e5","type":"any","value":"","key":"inventoryID"},{"id":"f376b481-d23b-4b7a-b3be-349f5e78e030","type":"any","value":"","key":"serialID"}]}},"response":[],"_postman_id":"9ec1dbcb-e0a7-46bf-af64-ac552d4d7ceb"},{"name":"Inventory ext settings update","id":"f602fe42-a68a-436d-8db6-5df8a1cffaaa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"is_packaging_item\": false,\n \"not_for_resale\": false,\n \"single_parcel_per_item\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/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
`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	—

","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","","inventory",":inventoryID","settings"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"f80151da-7525-47e1-bb6c-ce7ee327e2b3","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"f602fe42-a68a-436d-8db6-5df8a1cffaaa"},{"name":"Inventory ext shelves create","id":"212ffce4-ab4d-47fd-9920-cfbe7f892e12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

Path parameters

\n\n\n\n\n\n\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\". Options: asc, 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":"88221dfa-ef84-4643-9c0e-49444526e22b","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"552cf06a-781a-45ca-a1e6-9890cc885935"},{"name":"Inventory stocks create","id":"88bda8f4-4809-4bc3-93fb-309e001dbbd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"location_id\": 0,\n \"quantity\": 0,\n \"job_reason_id\": 0,\n \"max_level\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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	—

","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","","inventory",":inventoryID","stocks"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"211b1606-ebbe-49ae-9bcd-24d6507daf5b","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"88bda8f4-4809-4bc3-93fb-309e001dbbd5"},{"name":"Inventory stocks basic","id":"1b949e5b-0052-408b-8540-ca560e547434","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"quantity\": 0,\n \"trigger_level\": 0,\n \"stock_change_reason\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/stocks/basic","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
`quantity`	integer	yes	—
`trigger_level`	integer \| null	no	—
`stock_change_reason`	string \| null	no	—

","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","","inventory",":inventoryID","stocks","basic"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"e7e8bf53-bdb0-4dbf-a563-1f062780f172","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"1b949e5b-0052-408b-8540-ca560e547434"},{"name":"Inventory stocks change priorities","id":"cb277015-37f7-4f18-a36b-542c2f3027ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"priorities\": [\n {\n \"stock_id\": 0,\n \"priority\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/stocks/change-priorities","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
`priorities`	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

Path parameters

\n\n\n\n\n\n\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\". Options: asc, 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":"457a6dea-9c29-436b-817d-f33bee0873d7","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"480d4e5a-9bed-449b-b928-a531d3d6c097"},{"name":"Inventory stocks update","id":"b87ce83b-9343-4ab2-9a81-88559cd3d922","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"quantity\": 0,\n \"stock_change_reason\": \"\",\n \"max_level\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/stocks/:stockID","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
`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

","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","","inventory",":inventoryID","stocks",":stockID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"ad2dc91c-597d-438a-ba47-87967e1884ac","type":"any","value":"","key":"inventoryID"},{"id":"065ee70c-a675-40ed-bb66-3b8583093da2","type":"any","value":"","key":"stockID"}]}},"response":[],"_postman_id":"b75bc2ff-ba91-4078-9584-5b39c8cfd06f"},{"name":"Inventory ext stocks replenishment update","id":"2fb9a4ff-c388-4159-8238-4cc5fa85aa53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"replenishment_type\": \"1\",\n \"replenishment_level\": 0,\n \"replenishment_container_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/stocks/:stockID/replenishment","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
`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\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\". Options: asc, 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":"711cd970-a597-4ee4-85db-b19b85f29b46","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"f86f40a0-1ca1-4011-94d8-a3c2b188b141"},{"name":"Inventory suppliers create","id":"6eca1523-a2cf-4dd0-9caf-3df7946994c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"suppliers\": [\n {\n \"id\": 0,\n \"supplier_id\": 0,\n \"currency_id\": 0,\n \"supplier_code\": \"\",\n \"item_cost\": 0,\n \"lead_time\": 0,\n \"lead_time_type\": \"1\",\n \"minimum_order_quantity\": 0,\n \"inventory_container_id\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

Field	Type	Required	Description
`suppliers`	array	yes	—

","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","","inventory",":inventoryID","suppliers"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"c6e3c8a0-6079-46e9-93ea-0e78b5c323bf","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"6eca1523-a2cf-4dd0-9caf-3df7946994c7"},{"name":"Inventory suppliers bulk delete","id":"454459d3-e1be-4720-a888-405d2d888b7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"inventory_suppliers\": [\n 0\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/suppliers/bulk-delete","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
`inventory_suppliers`	array	yes	—

","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","","inventory",":inventoryID","suppliers","bulk-delete"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"a7a6aaeb-c782-4822-ac13-efdb5dec72c1","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"454459d3-e1be-4720-a888-405d2d888b7a"},{"name":"Inventory suppliers sorting","id":"6e69bfea-7fed-4490-a1bc-17dd0d2b94f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sorting\": [\n {\n \"id\": 0,\n \"priority\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

Field	Type	Required	Description
`sorting`	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
`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\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`	—

","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","","inventory",":inventoryID","tags"],"host":["https://dcv7.test/api/v2"],"query":[{"disabled":true,"key":"includes_count","value":""}],"variable":[{"id":"f0062f4a-0d75-4ac2-aa8d-1893b3cf5010","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"64163c69-ec63-4d18-a6d6-081eb35808dd"},{"name":"Inventory ext item tags create","id":"1a5ca56f-ffad-4e26-b4fe-fdb3e8b048eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/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
`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

","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","","inventory",":inventoryID","tags",":tagID","detach"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"facec304-9f7e-4298-b4c5-1f30f61705cb","type":"any","value":"","key":"inventoryID"},{"id":"f7611da4-0306-449c-93c5-ff4eec5c18f2","type":"any","value":"","key":"tagID"}]}},"response":[],"_postman_id":"d04418a6-46c6-4fa7-ad0b-c41b37e33c49"},{"name":"Inventory ext update auto sync stock","id":"be7dfb0c-298f-4e16-8250-f74dd7bc09f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"auto_sync_stock\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/update-auto-sync-stock","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
`auto_sync_stock`	boolean	yes	—

","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","","inventory",":inventoryID","update-auto-sync-stock"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"e71eeded-965a-4377-ad09-3d055dbc6afe","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"be7dfb0c-298f-4e16-8250-f74dd7bc09f6"},{"name":"Inventory ext update meta","id":"5450a38e-3cb8-4d3b-ab1e-73c2116d09d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"package_template_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventoryID/update/meta","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
`package_template_id`	integer \| null	no	—

","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","","inventory",":inventoryID","update","meta"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"5e5c0c0a-2399-4a3a-b4e9-a0c890f64002","type":"any","value":"","key":"inventoryID"}]}},"response":[],"_postman_id":"5450a38e-3cb8-4d3b-ab1e-73c2116d09d7"},{"name":"Inventory stocks bulk create","id":"59b1c105-7927-4d5b-b9ab-043c8e112ed6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"stocks\": [\n {\n \"location_id\": 0,\n \"quantity\": 0,\n \"max_level\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventory_id/stocks/bulk-create","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
`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
`stocks`	array	yes	—

","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","","inventory",":inventory_id","stocks","bulk-create"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"b10e7e31-710d-4daf-bc50-178635243840","type":"any","value":"","key":"inventory_id"}]}},"response":[],"_postman_id":"59b1c105-7927-4d5b-b9ab-043c8e112ed6"},{"name":"Inventory stocks bulk delete","id":"89e34329-a4de-4249-9980-d943dabe2e5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"stock_ids\": [\n 0\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventory_id/stocks/bulk-delete","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
`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	—

","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","","inventory",":inventory_id","stocks","bulk-delete"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"6f01bf47-f509-42dd-baa5-040baee1add3","type":"any","value":"","key":"inventory_id"}]}},"response":[],"_postman_id":"89e34329-a4de-4249-9980-d943dabe2e5a"},{"name":"Inventory stocks bulk update","id":"4dcbd01e-1fa3-4646-b3f3-4495c30b87b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"stocks\": [\n {\n \"stock_id\": 0,\n \"quantity\": 0,\n \"stock_change_reason\": \"\",\n \"max_level\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory/:inventory_id/stocks/bulk-update","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
`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
`stocks`	array	yes	—

Endpoint to list pickable and non-pickable storage location stock levels for inventories.

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: quantity, location_code

\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":"c51b36d0-8029-41e0-bfdd-c3465a37368d"}],"id":"8e5f2c70-514c-421f-a328-520ebc97012f","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":"8e5f2c70-514c-421f-a328-520ebc97012f","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":"991809f7-074a-4e27-a692-3a5b79932194","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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":"92ac31a8-7a56-413e-94ca-bd5ec2180b23","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 show","id":"d1a230dc-f4b7-4f21-a08e-1e29f4d9f231","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//inventory-check-transaction/:transactionID","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

Path parameters

\n\n\n\n\n\n\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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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).

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

Options: asc, desc

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"key":"includes_count","value":""},{"disabled":true,"key":"page","value":""},{"disabled":true,"key":"per_page","value":""},{"disabled":true,"key":"status","value":""}],"variable":[{"id":"1dba1fce-611a-4a3b-b250-421f9dc2c99f","type":"any","value":"","key":"transactionID"}]}},"response":[],"_postman_id":"60b9028b-0b91-48b0-a971-dd01ac703612"}],"id":"db1dea8e-c711-4743-abbf-4a9af8d0e9e0","description":"

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":"db1dea8e-c711-4743-abbf-4a9af8d0e9e0","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":"ac5a6c77-c1f9-4a35-86ac-04f41fb12bae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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 _from / _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
\n
items.inventory
\n
items.inventory.meta
\n
items.inventory.barcodes
\n
items.inventory.stocks
\n
items.inventory.stocks.location
\n
items.location
\n
assignedUser
\n
assignedUser.user
\n
assignedUser.user.fileManager
\n
assignedUser.timeTracking
\n
assignedUsers
\n
assignedUsers.user
\n
assignedUsers.user.fileManager
\n
assignedUsers.timeTracking
\n
tags
\n
tags.tag
\n

Sorting & pagination

Sorting: sort_by= with sort_direction=asc|desc.
\n
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

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\". Options: asc, 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":"ac5a6c77-c1f9-4a35-86ac-04f41fb12bae"},{"name":"Inventory checks create","id":"66936fb3-f69c-48bb-8876-ec1aad97f695","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"is_bulk\": false,\n \"clear_zero_stock_locations\": false,\n \"inventory_list\": [\n {\n \"inventory_id\": 0\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://dcv7.test/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

Field	Type	Required	Description
`company_id`	integer	yes	—
`is_bulk`	boolean	yes	—
`clear_zero_stock_locations`	boolean \| null	no	—
`inventory_list`	array \| null	no	—
`split`	object	yes	—
`filters`	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\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).

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

Options: asc, desc

\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"key":"includes_count","value":""},{"disabled":true,"key":"page","value":""},{"disabled":true,"key":"per_page","value":""},{"key":"company_id","value":""},{"disabled":true,"key":"search","value":""},{"disabled":true,"key":"name","value":""}],"variable":[]}},"response":[],"_postman_id":"621a1d19-67cb-43d0-80f9-2a06eb7879eb"},{"name":"Inventory checks show","id":"8c771b3c-d7e4-4ada-8393-533834451d95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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":"5f16a664-b075-46c1-bb5b-31a5501c45b0","type":"any","value":"","key":"inventoryCheckID"}]}},"response":[],"_postman_id":"8c771b3c-d7e4-4ada-8393-533834451d95"},{"name":"Inventory checks update","id":"1ce043a0-f98a-4104-8c37-318f7597c180","protocolProfileBehavior":{"disableBodyPruning":true},"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\": \"\",\n \"notes\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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":"058eab54-60e9-4751-82cf-2e320ee41a6c","type":"any","value":"","key":"inventoryCheckID"}]}},"response":[],"_postman_id":"1ce043a0-f98a-4104-8c37-318f7597c180"},{"name":"Inventory checks delete","id":"a14fb0dd-d316-4988-9a42-40f109f40f3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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

","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","","inventory-checks",":inventoryCheckID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"a4ec41d8-a74c-4c79-91e7-9e32f2fef66a","type":"any","value":"","key":"inventoryCheckID"}]}},"response":[],"_postman_id":"a14fb0dd-d316-4988-9a42-40f109f40f3d"},{"name":"Inventory checks archive","id":"7d44c631-800e-49d1-89e8-ea9b8072ed4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"inventory_check_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory-checks/:inventoryCheckID/archive","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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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\". Options: asc, 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":"3862a1f0-d210-489a-a60f-0396ce15e02a","type":"any","value":"","key":"inventoryCheckID"}]}},"response":[],"_postman_id":"1a278d04-69d4-4d2b-847e-cb392a6a5fad"},{"name":"Inventory checks assigned users update","id":"fd061467-36ea-4558-8f4c-ac7d68fffcb6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"inventory_check_id\": 0,\n \"user_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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":"7f3d4649-afd6-4d7b-b5b2-7dca9ff79e7f","type":"any","value":"","key":"inventoryCheckID"},{"id":"a62459ba-411c-484d-8324-0d001d8321c4","type":"any","value":"","key":"userID"}]}},"response":[],"_postman_id":"7f6cb345-ada0-44ed-862a-d39d2c9c3e8e"},{"name":"Inventory checks items list","id":"5d59e49c-3e32-40a7-a06c-d050ec483ae0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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\". Options: asc, 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":"3a84b7b2-6ad6-49f3-835a-dffecaadb4a6","type":"any","value":"","key":"inventoryCheckID"}]}},"response":[],"_postman_id":"5d59e49c-3e32-40a7-a06c-d050ec483ae0"},{"name":"Inventory checks items create","id":"b520ff82-ab05-411f-9be3-2d1a501c2710","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"inventory_check_id\": 0,\n \"items\": [\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

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[]`	—

","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","","inventory-checks",":inventoryCheckID","items","deletable"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"company_id","value":""},{"key":"inventory_check_id","value":""},{"key":"ids[]","value":""}],"variable":[{"id":"55114776-a591-464b-8c24-6ae9ee5890fd","type":"any","value":"","key":"inventoryCheckID"}]}},"response":[],"_postman_id":"eaacdff0-1e15-42eb-80f2-9dd947919f69"},{"name":"Inventory checks items resettable","id":"64604a88-4019-42bb-abe9-0aab1332b377","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//inventory-checks/:inventoryCheckID/items/resettable?company_id=&inventory_check_id=&ids[]=","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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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[]`	—

","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","","inventory-checks",":inventoryCheckID","items","resettable"],"host":["https://dcv7.test/api/v2"],"query":[{"key":"company_id","value":""},{"key":"inventory_check_id","value":""},{"key":"ids[]","value":""}],"variable":[{"id":"5aac6506-db94-49d5-b27e-6dc543f5b3c0","type":"any","value":"","key":"inventoryCheckID"}]}},"response":[],"_postman_id":"64604a88-4019-42bb-abe9-0aab1332b377"},{"name":"Inventory checks items delete","id":"3b9f5a2e-5010-465c-b262-0d48cf96c42f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//inventory-checks/:inventoryCheckID/items/:itemID","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
`inventoryCheckID`	integer	yes
`itemID`	integer	yes

","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","","inventory-checks",":inventoryCheckID","items",":itemID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"9cb02eb6-e95c-439b-875b-d083035e180a","type":"any","value":"","key":"inventoryCheckID"},{"id":"52bb41d7-fd3a-4207-9944-cf721575d010","type":"any","value":"","key":"itemID"}]}},"response":[],"_postman_id":"3b9f5a2e-5010-465c-b262-0d48cf96c42f"},{"name":"Inventory checks items update action qty","id":"4252d698-c722-4e40-b983-474ec1ee4157","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"action_quantity\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory-checks/:inventoryCheckID/items/:itemID/update-action-qty","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
`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	—

","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","","inventory-checks",":inventoryCheckID","items",":itemID","update-action-qty"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"51538803-99ca-4898-ae59-02607ad14cd3","type":"any","value":"","key":"inventoryCheckID"},{"id":"e3cce434-1a62-448d-bb3f-1980fae5415a","type":"any","value":"","key":"itemID"}]}},"response":[],"_postman_id":"4252d698-c722-4e40-b983-474ec1ee4157"},{"name":"Inventory checks publish","id":"39a3bf4d-5252-433c-8115-681f35379fbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"inventory_check_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory-checks/:inventoryCheckID/publish","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	—

","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","","inventory-checks",":inventoryCheckID","publish"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"eadf1ffc-96f4-44b0-bdcd-06d992cbca06","type":"any","value":"","key":"inventoryCheckID"}]}},"response":[],"_postman_id":"39a3bf4d-5252-433c-8115-681f35379fbb"},{"name":"Inventory checks restore archive","id":"258921e2-e3e3-4fca-9d93-fcb16a453a26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"inventory_check_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory-checks/:inventoryCheckID/restore-archive","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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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).

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

Options: asc, desc

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":"81aa4b6d-87f1-4e9b-b1da-3923391fe6d5","type":"any","value":"","key":"inventoryCheckID"}]}},"response":[],"_postman_id":"4ba45d61-3885-418c-b53d-186589440a92"},{"name":"Inventory checks tags create","id":"2856ea71-e26a-4c42-91a2-9affcc14669f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"inventory_check_id\": 0,\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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	—

","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","","inventory-checks",":inventoryCheckID","tags"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"d242c7d5-6fda-4275-94ea-246ced672425","type":"any","value":"","key":"inventoryCheckID"}]}},"response":[],"_postman_id":"2856ea71-e26a-4c42-91a2-9affcc14669f"},{"name":"Inventory checks tags attach","id":"3a5046d3-a2f5-442b-9a1f-8acd1a0b8ef6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"inventory_check_id\": 0,\n \"tag_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory-checks/:inventoryCheckID/tags/:tagID/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\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	—

","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","","inventory-checks",":inventoryCheckID","tags",":tagID","attach"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"ca6b45bb-7722-43a4-9f8b-cc9853502120","type":"any","value":"","key":"inventoryCheckID"},{"id":"ac551aa5-5e0a-48ab-b80d-8c4ec46f05a8","type":"any","value":"","key":"tagID"}]}},"response":[],"_postman_id":"3a5046d3-a2f5-442b-9a1f-8acd1a0b8ef6"},{"name":"Inventory checks tags detach","id":"809299be-6094-453a-aea4-f412ac5291b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"inventory_check_id\": 0,\n \"tag_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory-checks/:inventoryCheckID/tags/:tagID/detach","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
`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	—

","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","","inventory-checks",":inventoryCheckID","tags",":tagID","detach"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"5f494b99-8601-4d92-96af-c2260f83e8b7","type":"any","value":"","key":"inventoryCheckID"},{"id":"2f863f12-efaf-4bf7-9ed5-f9c06a529954","type":"any","value":"","key":"tagID"}]}},"response":[],"_postman_id":"809299be-6094-453a-aea4-f412ac5291b4"},{"name":"Inventory checks time tracking start","id":"aad9b3c0-b91d-4317-806e-3aefaec922ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"inventory_check_id\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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	—

","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","","inventory-checks",":inventoryCheckID","time-tracking","start"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"970859a4-6749-41d2-af70-71ac94437812","type":"any","value":"","key":"inventoryCheckID"}]}},"response":[],"_postman_id":"aad9b3c0-b91d-4317-806e-3aefaec922ab"},{"name":"Inventory checks time tracking stop","id":"cc39201b-231b-438f-85fe-155705ba97ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"inventory_check_id\": 0,\n \"stopped_at\": \"2024-01-01T00:00:00Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory-checks/:inventoryCheckID/time-tracking/stop","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	—
`stopped_at`	string \| null	no	—

","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","","inventory-checks",":inventoryCheckID","time-tracking","stop"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"d5ff649a-be42-4aa1-8acc-29cf65704a41","type":"any","value":"","key":"inventoryCheckID"}]}},"response":[],"_postman_id":"cc39201b-231b-438f-85fe-155705ba97ef"},{"name":"Inventory Checks attachment create","id":"bec6a523-f1c5-469a-b514-5859a07ac5fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"file_manager_id\": {{file_manager_id}}\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory-checks/{{inventory_check_id}}/items/{{item_id}}/attachments","description":"

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.

\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","","inventory-checks","{{inventory_check_id}}","items","{{item_id}}","attachments"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[]}},"response":[{"id":"c9c11326-0192-4b14-ae6b-fbd6b5784645","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"file_manager_id\": 512\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory-checks/{{inventory_check_id}}/items/{{item_id}}/attachments"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 88,\n \"inventory_check_id\": 1,\n \"inventory_check_item_id\": 1,\n \"location_id\": 42,\n \"file_manager_id\": 512,\n \"image\": \"https://private-bucket.example/inventory-check/abc123.jpg?signature=...\",\n \"created_at\": \"2026-07-03T10:15:00.000000Z\"\n }\n}"}],"_postman_id":"bec6a523-f1c5-469a-b514-5859a07ac5fc"},{"name":"Inventory Checks attachment update","id":"05b9427b-5f49-4ddb-86f7-37ef27e6d260","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"file_manager_id\": {{file_manager_id}}\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory-checks/{{inventory_check_id}}/items/{{item_id}}/attachments/{{attachment_id}}","description":"

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.

\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","","inventory-checks","{{inventory_check_id}}","items","{{item_id}}","attachments","{{attachment_id}}"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[]}},"response":[{"id":"765bf45c-6abd-499b-813e-730b3c1c1022","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"file_manager_id\": 777\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory-checks/{{inventory_check_id}}/items/{{item_id}}/attachments/{{attachment_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 88,\n \"inventory_check_id\": 1,\n \"inventory_check_item_id\": 1,\n \"location_id\": 42,\n \"file_manager_id\": 777,\n \"image\": \"https://private-bucket.example/inventory-check/def456.jpg?signature=...\",\n \"created_at\": \"2026-07-03T10:15:00.000000Z\"\n }\n}"}],"_postman_id":"05b9427b-5f49-4ddb-86f7-37ef27e6d260"},{"name":"Inventory Checks attachment deletes","id":"605baaa1-11f8-46c3-afa2-64f76283f40a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/api/v2/companies//inventory-checks/{{inventory_check_id}}/items/{{item_id}}/attachments/{{attachment_id}}","description":"

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":"058feee8-ba3f-4a3b-ae19-6a9f1c55178f","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 list","id":"9741d1c8-c66f-41c6-95e2-013ef7f8daec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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\". Options: asc, 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":"9741d1c8-c66f-41c6-95e2-013ef7f8daec"},{"name":"Inventory ext families create","id":"f9a34aff-9e52-415e-8de7-b386aa1e4361","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"parent_id\": 0,\n \"description\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

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
`families`	array	yes	—

","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","","inventory-families","bulk-create"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"11652547-090a-4274-8a41-e1e33e261fce"},{"name":"Inventory ext families bulk sync","id":"016d196b-8a9f-4177-be8c-be2e2ce68045","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"families\": [\n {\n \"id\": 0,\n \"name\": \"\",\n \"parent_id\": 0,\n \"description\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//inventory-families/bulk-sync","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
`families`	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
`families`	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
`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":"e77b6f8b-81cd-48b0-9ce3-9667bdaacdfc","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 list","id":"0182b872-4810-4b88-aacd-e15e7d7ac8cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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

Filters

Pass these as flat query-string parameters (e.g. ?status=2&created_at_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\". Options: asc, 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":"0182b872-4810-4b88-aacd-e15e7d7ac8cb"},{"name":"Job reasons create","id":"dc572af0-29f4-4132-95e6-2429a2b198b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"\",\n \"order_number\": 0,\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://dcv7.test/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	—

","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","","job-reasons"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"dc572af0-29f4-4132-95e6-2429a2b198b8"},{"name":"Job reasons bulk create","id":"142a3a07-e4c0-45ec-bc4b-26169ff85854","protocolProfileBehavior":{"disableBodyPruning":true},"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\": \"\",\n \"channels\": [\n 0\n ],\n \"order_number\": 0,\n \"is_active\": false,\n \"image_status\": \"1\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/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

Field	Type	Required	Description
`job_reasons`	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
`job_reason_ids`	array	yes	—

","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","","job-reasons","bulk-delete"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"d89a3633-9224-46b8-a318-41319d99e6be"},{"name":"Job reasons bulk update","id":"29c497dc-24ae-4c6c-ad51-5d9bcd434b3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"job_reasons\": [\n {\n \"id\": 0,\n \"reason_types\": [\n \"1\"\n ],\n \"reason\": \"\",\n \"channels\": [\n 0\n ],\n \"order_number\": 0,\n \"is_active\": false,\n \"image_status\": \"1\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//job-reasons/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

Field	Type	Required	Description
`job_reasons`	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
`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":"c8dd88dd-44f4-4c4d-b42b-77cb8410cc95","type":"any","value":"","key":"jobReasonID"}]}},"response":[],"_postman_id":"918b9f81-d527-406e-89d9-9d14c9b83c73"},{"name":"Job reasons update","id":"a6b48758-7f98-42c8-8d87-7b4eb3882e7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"\",\n \"order_number\": 0,\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://dcv7.test/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

","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","","job-reasons",":jobReasonID"],"host":["https://dcv7.test/api/v2"],"query":[],"variable":[{"id":"c5242daa-7ef5-4d98-852e-4511816275de","type":"any","value":"","key":"jobReasonID"}]}},"response":[],"_postman_id":"d59d4740-19fd-483a-b9d9-96c7f8d673c8"},{"name":"Job reasons status update","id":"886eb2ae-c8a2-4368-9d79-a841d1fa8d27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"company_id\": 0,\n \"job_reason_id\": 0,\n \"is_active\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://dcv7.test/api/v2/companies//job-reasons/:jobReasonID/status","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

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":"f42bc97e-1826-4eb9-b29a-d436a92030b8","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":"757cdb71-574f-4e4b-881d-c0f297164390","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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\". Options: asc, 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":"757cdb71-574f-4e4b-881d-c0f297164390"},{"name":"Display the specified language","id":"7aa0871f-f42c-4bc0-aa46-08ac1c31b05a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dcv7.test/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":"b74e8bae-f063-4d5d-bd20-deb28b53046e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"

Field	Type	Required	Description
`company_id`	integer	yes	—
`mail_provider`	string	yes	Allowed: `helm`, `mailgun`, `amazon_ses`, `brevo`
`name`	string	yes	—

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

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	—

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	—

Parameter	Type	Required
`companyID`	integer	yes
`movementID`	integer	yes
`userID`	integer	yes

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	—

Field	Type	Required	Description
`movement_id`	integer	yes	—
`assigned_user`	integer	yes	—
`filter`	array	no	—
`ids`	array \| null	no	—

Parameter	Description
`includes_count`	—
`filter[ids][]`	—
`store_id`	Filter by Store Id.
`channel_id`	Filter by Channel Id.
`order_number`	Filter by Order Number.
`status`	Filter by Status.
`id`	Filter by Id.
`ids`	Filter by Ids.
`excepted_ids`	Filter by Excepted Ids.
`ignore_ids`	Filter by Ignore Ids.

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	—

Parameter	Type	Required
`companyID`	integer	yes
`orderID`	integer	yes
`orderAttachmentID`	integer	yes

Parameter	Description
`company_id`	—
`order_id`	—
`order_item_ids[]`	—
`service_charge_ids[]`	—

Parameter	Description
`company_id`	—
`order_id`	—
`order_item_id`	—
`order_child_item_id`	—

Field	Type	Required	Description
`company_id`	integer	yes	—
`package_templates`	array	yes	—
`sort_number`	array	no	—

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	—

Field	Type	Required	Description
`name`	string	yes	—
`pick_type`	string	yes	Allowed: `1`, `2`, `3`
`order_filters`	array \| null	no	—
`settings`	object	yes	—

Field	Type	Required	Description
`name`	string	yes	—
`split_picks`	boolean \| null	no	—
`split_per_zone`	boolean \| null	no	—
`maximum_lines`	integer \| null	no	—

Parameter	Type	Required
`companyID`	integer	yes
`pickRoutineID`	integer	yes
`pickRoutineTemplateID`	integer	yes

Field	Type	Required	Description
`picked_location_id`	integer	yes	—
`completion_status`	string \| null	no	CompletionStatus values: - `1` = PICKED - `2` = SORTING Allowed: `1`, `2`

Parameter	Type	Required
`companyID`	integer	yes
`pickID`	integer	yes
`pickItemID`	integer	yes

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	—

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	—

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

Field	Type	Required	Description
`company_id`	integer	yes	—
`printing_queue_id`	integer	yes	—
`status`	string	yes	Allowed: `0`, `1`, `2`, `3`, `4`

Parameter	Description
`company_id`	—
`type`	Options: `1`, `2`, `3`
`priority_supplier_only`	—
`supplier_name`	—

Parameter	Type	Required
`companyID`	integer	yes
`purchaseOrderID`	integer	yes
`purchaseOrderCommentID`	integer	yes

Parameter	Description
`company_id`	—
`purchase_order_id`	—
`purchase_order_comment_id`	—

Parameter	Description
`company_id`	—
`purchase_order_id`	—
`purchase_order_item_id`	—

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	—

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	—
`recipients`	array	yes	—

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.