Helm is The Despatch Company's order, inventory and despatch platform.
\nThis collection documents every endpoint exposed by the Helm Public API. Each request includes a description, a list of accepted filters and body fields with their types, sort options, pagination notes, and at least one example response.
\nSet the collection variable base_url to your tenant URL (e.g. https://your-company.myhelm.app/public-api).
Open the Auth → Login request and put your dashboard email and password into the JSON body. Run the request — on success the response token is automatically saved to the auth_token collection variable, and every other request is pre-configured to use it as a Bearer token.
From there you can run any other request directly. For requests that need a record ID (an order, an inventory item, etc.) update the corresponding placeholder collection variable (order_id, inventory_id, …) before sending.
All endpoints (other than the login endpoint itself) require a valid JWT access token, sent as a Bearer token in the Authorization header:
Authorization: Bearer eyJhbGciOi...\n\nTokens are issued by POST /auth/login and remain valid until invalidated by the server. To check whether a token is still good, call GET /auth/verify.
The API enforces user permission levels. Most endpoints require Supervisor level or above. A small number of administrative endpoints (user management) require Admin level. Some endpoints are blocked for fulfilment-client users — these are flagged in the request description with Not available to fulfilment-client users.
List endpoints accept filters via query parameters using bracket notation:
\nGET /orders?filters[status][]=2&filters[status][]=3\nGET /inventory?filters[search]=red widget&filters[search_field]=search_product_name\n\nSingle value: filters[]=
Multiple values: filters[][]=&filters[][]= (combined with OR within the field)
Multiple filters on the same request are combined with AND.
\nA handful of filters use literal separators inside a single value — the most common is the inventory multiple_sku filter which uses ||, e.g. filters[multiple_sku]=SKU-A||SKU-B||SKU-C. These are called out per-endpoint where they apply.
Search filters use | (single pipe) to OR multiple terms inside one search box, e.g. filters[search]=red|blue matches records containing either term.
Every list endpoint is paginated. Two parameter names are used across the API depending on the endpoint:
\npage — current page number, 1-based (always supported).
limit (used by Orders) or per_page (used by everything else) — items per page. The exact name is documented on each endpoint.
List responses are wrapped:
\n{\n \"total\": 1280,\n \"per_page\": 50,\n \"current_page\": 1,\n \"last_page\": 26,\n \"next_page_url\": \"https://your-company.myhelm.app/public-api/orders?&page=2\",\n \"prev_page_url\": null,\n \"from\": 0,\n \"to\": 50,\n \"data\": [ /* records */ ]\n}\n\nList endpoints accept a sort query parameter that takes a named sort option, not a column name. Each list endpoint has its own enum of valid sort options — see the per-endpoint description. Common pattern: _az / _za for alphabetical, _hl / _lh for high-to-low / low-to-high, _pr / _rp for past-to-recent / recent-to-past.
Date-range filters are passed as a single comma-separated string. Two formats are used in the API depending on the endpoint:
\nDD/MM/YYYY,DD/MM/YYYY — used by order date filters (received_date_range, dispatched_date_range, ship_by_date_range, last_updated_date_range).
, — used by log and shipment date filters (date_range, last_updated_date_range).
The per-endpoint description always states which format applies.
\nEvery endpoint is rate-limited per IP address. Each response includes:
\nX-RateLimit-Capacity — total requests allowed in the current window.
X-RateLimit-RefillTimeLeft — seconds remaining before the window resets.
When the limit is hit you receive HTTP 429 with the message above. Back off and retry after the indicated number of seconds.
Authenticates a Helm user with their dashboard credentials and returns a JWT access token to be used as the Bearer token for all subsequent API calls.
\nNo prior authentication needed. The user must exist in Helm and have Supervisor level or above; users below Supervisor are rejected with 401.
order_id so other requests authenticate without further setup.2fa_code receives a 407 Proof Authentication Required response with {\"error\": \"2FA code required\"} — at which point you should prompt for the code and resubmit.401 (the API does not distinguish between them, to avoid leaking which usernames exist).Verifies that the current Bearer token is still valid and returns the user it belongs to.
\nAny authenticated user. Returns 401 if the token is missing, malformed, expired, or belongs to a user whose permission level dropped below Supervisor.
Authentication endpoints. Call Login first to obtain a JWT access token; the response handler automatically stores the token into the auth_token collection variable so all subsequent requests use it.
Returns the running Helm version and the profile of the user that the current Bearer token belongs to. A lightweight all-in-one health check.
\nstaff_level and fulfilment_client_id to decide which UI features to show in your integration.Any authenticated user (Supervisor+).
\nServer-side meta endpoints — version reporting and the active user's profile under the current token.
\n","_postman_id":"c1f04200-b33a-4bd8-8395-f6f50819475b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}}},{"name":"Settings","item":[{"name":"Get Setting Parameters","id":"c4f684c5-2113-4f5f-9e6d-b5577c186284","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://your-company.myhelm.app/public-api/settings/parameters/sales_channels","description":"Fetches a tenant-level configuration list by key. The same endpoint serves several different lists; the last path segment is the key that selects which list you get back.
\nAny authenticated user (Supervisor+).
\nsettingKeyMust be exactly one of the values below — anything else returns 422.
{ \"data\": [ /* array of records — shape depends on the key */ ] }\nsales_channels and accounting_channels, when the request is made by a fulfilment-client user, results are automatically scoped to that client.filters and sort query parameters are accepted but currently have no effect on the returned data — do not rely on them. Use the chosen key to determine which list you get.One of: accounting_channels, accounting_options, sales_channels, inventory_location_indexes.
Read-only access to a small set of tenant-level configuration lists. Useful when you need IDs (sales channel IDs, accounting channel IDs, etc.) for use in other endpoints.
\n","_postman_id":"955df126-1cc4-4cc5-a7d8-b4e14f8fe36e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}}},{"name":"Logs","item":[{"name":"Get Time Tracking Logs","id":"4a28d8b0-717a-4cdf-9509-eb8cc011ec77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://your-company.myhelm.app/public-api/logs/time_tracking?page=1&per_page=50","description":"Returns warehouse staff activity records — scans, pause events, location movements and any other action recorded by the workforce/picking app. Source for productivity reports.
\nduration per user_id for a given date range.pick_header_id or order_summary_id.warehouse_id + date_range.sort=date_desc).Any authenticated user (Supervisor+).
\npage (default 1) and per_page (default 50).
1-based page number. Default 1.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Records per page. Default 50.
\n","type":"text/plain"},"key":"per_page","value":"50"},{"disabled":true,"description":{"content":"One of: date_asc | date_desc | duration_asc | duration_desc | newest | oldest. Default date_desc (most recent action_date first).
\n","type":"text/plain"},"key":"sort","value":"date_desc"},{"disabled":true,"description":{"content":"Match by activity action. Use a single pipe | between values to OR multiple. Values seen in production include SCAN and OTHER. Additional values may exist for future activity types — match exactly what the workforce app records.
Match by activity type. Use a single pipe | between values to OR multiple. Values seen in production include ITEM_SCAN, LOCATION_SCAN, TOTE_SCAN, PAUSE_SCAN, CUSTOM_SCAN. Additional values may exist.
Internal user ID — show only activity by this user.
\n","type":"text/plain"},"key":"filters[user_id]","value":"4"},{"disabled":true,"description":{"content":"Warehouse location ID — show only activity at this warehouse.
\n","type":"text/plain"},"key":"filters[warehouse_id]","value":"6"},{"disabled":true,"description":{"content":"Order ID — show only activity recorded against this order.
\n","type":"text/plain"},"key":"filters[order_summary_id]","value":"6308"},{"disabled":true,"description":{"content":"Pick ID — show only activity recorded against this pick.
\n","type":"text/plain"},"key":"filters[pick_header_id]","value":"15"},{"disabled":true,"description":{"content":"Purchase order ID — show only activity recorded against this PO.
\n","type":"text/plain"},"key":"filters[purchase_order_summary_id]","value":""},{"disabled":true,"description":{"content":"Specific bin/location ID — show only activity scoped to this location.
\n","type":"text/plain"},"key":"filters[location_id]","value":"1"},{"disabled":true,"description":{"content":"Inventory item ID — show only activity involving this SKU.
\n","type":"text/plain"},"key":"filters[inventory_id]","value":"1"},{"disabled":true,"description":{"content":"Pick-line inventory ID — narrow activity to a specific line on a pick.
\n","type":"text/plain"},"key":"filters[pick_inventory_id]","value":""},{"disabled":true,"description":{"content":"Polymorphic model ID — used internally to link an activity to a non-standard parent record. Most integrations will not use this.
\n","type":"text/plain"},"key":"filters[model_id]","value":""},{"disabled":true,"description":{"content":"Filter by action_date. Format: <start_unix>,<end_unix> (two unix timestamps in seconds, comma-separated, no spaces). Inclusive on both ends.
Returns the audit trail of every change to physical stock at a location. Each record captures the inventory, location, action, prior quantity, new quantity, and the human-readable note explaining why it changed.
\nsku and date_range and read the note column to see what triggered each change.note typically contains Order ID: ...).sku = the SKU you're showing).note text.Any authenticated user (Supervisor+). Fulfilment-client users automatically only see logs for their own inventory and only entries explicitly flagged as visible to them.
\npage (default 1). The page size is fixed by the tenant's Items per page setting and is not controllable from the request.
1-based page number. Default 1.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"One of: inventoruy_name_az | inventoruy_name_za | sku_az | sku_za | createdat_pr. Default: created_at descending. NOTE: the inventory-name sort keys are spelt inventoruy_* in the API — this is intentional, send them exactly as written.
Free-text search. A single pipe | between terms ORs them together; each term LIKE-matches against inventory SKU, inventory name, and location name.
Two unix timestamps joined by a comma. Filters on the log entry created_at. The end timestamp is inclusive plus 24 hours (so ..,1746000000 covers up to the end of that day).
Single pipe | between values to OR multiple. Production values: increase, decrease.
Match by exact SKU. Single pipe | between values to OR multiple.
Match by fulfilment client. Send numeric IDs separated by |. Use the literal string null (or 0) to match items not assigned to any fulfilment client.
Returns the audit trail of every change to allocated (reserved) stock against orders or picks. Each record captures the inventory, location, action, prior allocated quantity, new allocated quantity, and the note explaining why the allocation changed.
\nsku and date_range and read the note column.decrease rows on a particular SKU/date.Any authenticated user (Supervisor+). Fulfilment-client users see only their own inventory's logs that are explicitly flagged as visible to them.
\npage (default 1). The page size is fixed by the tenant's Items per page setting and is not controllable from the request.
Identical to Get Stock Transaction Logs — see that endpoint's description for the full reference.
\nIdentical schema to Get Stock Transaction Logs, with the single difference that log_type is 2 (allocation) instead of 1 (transaction).
1-based page number. Default 1.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"One of: inventoruy_name_az | inventoruy_name_za | sku_az | sku_za | createdat_pr. Default: created_at descending. NOTE: the inventory-name sort keys are spelt inventoruy_* in the API — send them exactly as written.
Free-text search. Single pipe | between terms ORs them together; each term LIKE-matches against inventory SKU, inventory name, and location name.
Two unix timestamps joined by a comma. Filters on the log entry created_at. The end timestamp is inclusive plus 24 hours.
Single pipe | between values to OR multiple. Production values: increase, decrease.
Match by exact SKU. Single pipe | between values to OR multiple.
Match by fulfilment client. Send numeric IDs separated by |. Use the literal string null (or 0) to match items not assigned to any fulfilment client.
Read-only audit-log endpoints. Three different log streams are exposed:
\nBoth stock log endpoints share a common filter set; the time-tracking endpoint has its own richer filter set keyed off the activity model.
\n","_postman_id":"d916c53e-7a20-451d-93a4-e301b907fed6","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}}},{"name":"Orders","item":[{"name":"List Orders","id":"048a1f98-e708-4ca9-b149-134ee44139b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://your-company.myhelm.app/public-api/orders?page=1&limit=20","description":"Returns a paginated list of orders with their inventory and shipment info embedded.
\nfilters[status][]=3 (Despatch Ready).filters[last_updated_date_range]=....filters[search] + filters[search_field].sales_channel.Any authenticated user (Supervisor+). Fulfilment-client users automatically only see orders that belong to their client.
\npage (default 1) and limit (default tenant setting, typically 20). NOTE: orders use limit, not per_page.
Paginated envelope with the standard total/per_page/current_page/etc. wrapping a data[] array. Each order in data[] includes:
order_summary fields.status — the human-readable status name.inventory[] — every order line, with the line's per-unit price/tax/discount and any product attributes.shipment — the shipment record if the order has been despatched, otherwise [].total_weight — recalculated from inventory.customer_* fields (customer_vat_number, customer_eori_number, customer_tax_id, customer_ioss_number, customer_ukims_number) — pulled from the linked contact for convenience.custom_fields — object with any tenant-defined custom fields.1-based page number. Default 1.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Records per page. Default is the tenant's Items per page setting (typically 20). NOTE: orders use limit, not per_page.
One of: name_az | name_za | totalpaid_hl | totalpaid_lh | datereceived_pr | datereceived_rp | datedispatched_pr | datedispatched_rp | zone_az | zone_za. Default: created_at descending. _pr = past→recent (ASC), _rp = recent→past (DESC), _hl = high→low, _lh = low→high.
Order status ID. Send multiple times for OR. See the folder description for the full status enum.
\n","type":"text/plain"},"key":"filters[status][]","value":"3"},{"disabled":true,"description":{"content":"Order summary ID. Send multiple times for OR.
\n","type":"text/plain"},"key":"filters[order_id][]","value":"6310"},{"disabled":true,"description":{"content":"Free-text search. Use a single pipe | between terms to OR them. Pair with filters[search_field] to narrow scope; otherwise the API uses auto which searches order ID, channel-alt ID, customer name, email, and tracking code.
One of: auto | search_order_id | search_channel_alt_id | search_name | search_email | search_postcode | search_country | search_iso | search_shipping | search_shipping_tracking_code | search_sku | search_product_name | search_dc_code. Defines what filters[search] looks at.
Filter by date_received. Format: DD/MM/YYYY,DD/MM/YYYY (UK format, comma-separated, no spaces).
Filter by date_dispatched. Format: DD/MM/YYYY,DD/MM/YYYY.
Filter by ship_by_date. Format: DD/MM/YYYY,DD/MM/YYYY.
Filter by updated_at. Format: DD/MM/YYYY,DD/MM/YYYY.
Sales channel ID. Send multiple times for OR. Use Settings → Get Setting Parameters with key sales_channels to list valid IDs.
LIKE-match on the sales channel name.
\n","type":"text/plain"},"key":"filters[sales_channel_name]","value":""},{"disabled":true,"description":{"content":"Exact match on channel_username (the per-marketplace seller name on a channel record). Send multiple times for OR.
(Use via filters[search]=...&filters[search_field]=search_channel_alt_id instead — there is no dedicated channel_alt_id filter.)
Tag name (exact match). Send multiple times for OR. The API auto-tags every manually-created order with API.
Location ID — return orders that have inventory allocated at this warehouse location. Send multiple times for OR.
\n","type":"text/plain"},"key":"filters[location][]","value":"1"},{"disabled":true,"description":{"content":"Match by shipping_method_requested. Send multiple times for OR.
Order shape: SIG (Single Item Single Qty), SIM (Single Item Multi Qty), MIM (Multi Item Multi Qty), ZIO (Zero Item Order). Send multiple times for OR.
Filter by total inventory quantity. Plain integer for exact match (5); >5 for >= 5; <5 for <= 5.
Fulfilment client ID. Send multiple times for OR. Visible to back-office users only.
\n","type":"text/plain"},"key":"filters[fulfilment_clients][]","value":""},{"disabled":true,"description":{"content":"Send any value (e.g. 1) to include archived orders. By default archived orders are excluded.
Returns the full record for a single order, including its inventory lines, tags, total weight, and the linked contact's compliance numbers (VAT/EORI/IOSS/UKIMS).
\nAny authenticated user (Supervisor+). Fulfilment-client users can only retrieve orders that belong to their client; otherwise 401 Unauthorised.
inventory_id — internal order ID (the integer id field on the order).The full order_summary record plus:
status — the human-readable status name.tags[] — array of { id, tag }.inventory[] — every order line.total_weight — recalculated from inventory.custom_fields — object.customer_* fallbacks from the linked contact.Returns 404 Not Found if the order doesn't exist or has been soft-deleted.
Returns the batch numbers / serial numbers picked for each line of an order. Only relevant for SKUs with batch- or serial-tracking enabled.
\nAny authenticated user (Supervisor+).
\nArray of objects; each object lists the batch values selected for one order line. Returns [] if the order has no batch-tracked items or has not been picked yet.
Creates a new order without inventory lines. Use this when you want to create the order header now and add line items later via Add Inventory to Order.
\nIf you already know the line items at creation time, prefer Create Order with Inventory (a single round-trip) or Create Order with Shipment (creates the order and attaches a pre-generated label in one call).
\nAny authenticated user (Supervisor+).
\nIf the supplied email matches an existing contact (customer), the order is auto-linked to that contact's id and any missing fields (phone_one, etc.) are pulled from the contact. To force a fresh contact pass a unique email.
API.500 — payment_method was sent as null (or omitted). Send \"\" instead.422 — discount higher than total_paid, invalid date_received, multiple manual channels with no manual_channel_id, blocked status_id, or invalid custom_fields.Creates an order and its inventory lines in a single request. Use this when you already know the line items at order-creation time — it's one round-trip instead of an order-create followed by an add-inventory call.
\nstatus_id: 5).Any authenticated user (Supervisor+).
\n{\n \"order\": { ... order header fields ... },\n \"order_inventory\": [ { ... line item ... }, ... ]\n}\norder fieldsIdentical to the body of Create Order with one important difference: status_id is restricted to one of 1 (Draft), 3 (Despatch Ready), or 5 (Despatched). Sending 2800 (New Order) is rejected.
If you set status_id: 5, the order is recorded as already-despatched: allocations are deducted, despatch emails are queued, and rule-processing is skipped.
order_inventory[] fieldsline_total_discount.API.status_id == 5 (Despatched), the system skips rule-processing.422 — empty order, invalid status_id (not 1/3/5), missing required address fields, or any of the Create Order validation conditions.Creates an order, its inventory lines, and a pre-generated shipping label in a single call. Use this for the despatch-elsewhere flow: when the label was generated outside Helm and you want to record the result.
\nAny authenticated user (Supervisor+).
\n{\n \"order\": { ... order header fields ... },\n \"order_inventory\": [ { ... line item ... }, ... ],\n \"shipment\": { ... pre-generated label ... }\n}\norder and order_inventory[]Same as Create Order with Inventory above. status_id must be 1 (Draft), 3 (Despatch Ready), or 5 (Despatched).
shipment fieldsAPI - PREGEN.status_id == 5 (Despatched), the system stamps shipment_id, date_dispatched, deducts allocations, and skips rule-processing.422 — empty order, missing required shipment fields, invalid shipping_label_type, courier service not found, or any Create Order validation issue.Attaches a pre-generated label to an existing order and marks the order as despatched. Use this when the order already exists in Helm (was created earlier) but the label was generated externally and now needs to be recorded.
\nAny authenticated user (Supervisor+). Fulfilment-client users can only despatch their own orders.
\npregenerated_label flag is set to 1.422 — order not found, order not fully allocated, missing required shipment fields, invalid shipping_label_type, courier service not found.Updates editable fields on an existing order. Send only the fields you want to change — anything omitted stays as-is.
\nAny authenticated user (Supervisor+). Fulfilment-client users can only edit orders that belong to them.
\ninventory_id — internal order ID.All optional. The same fields documented under Create Order, plus:
\nstatus_id — see status enum in the folder description.notes — array of strings; replaces all existing notes on the order.custom_fields — object; replaces existing custom-field values.status_id to 5 (Despatched) via this endpoint — book a shipment or use Despatch with Tracking Code instead. Trying to do so returns 422.status_id to 2800 (New Order).pregenerated_label = 1 only allow updates to status_id and notes. Any other field is silently ignored and the response includes a warning message.total_discount cannot exceed total_paid — 422 otherwise.3000) cannot be updated at all — 422.auto_calculate_tax from 1 → 0 resets total_tax to 0. Setting it 1 triggers tax recalculation.vat_number / eori_number / tax_id / ioss_number / ukims_number are also written to the contact.The updated order record. If a pregenerated-label restriction was hit, the response includes a top-level message field explaining what was ignored.
Cancels an order — sets its status to 6 (Cancelled).
Any authenticated user (Supervisor+).
\nstatus_id == 5) — 422 otherwise.status_id == 3000) — 422 otherwise.{ \"status\": \"success\" }\nUse the Cancel Shipping Label endpoint first if the order has been despatched; that returns the order to a cancellable state.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["order","inventory_id","cancel"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"3f383f33-65e0-4cb7-b953-bc32ca40215c","name":"200 — cancelled","originalRequest":{"method":"POST","header":[],"url":"https://your-company.myhelm.app/public-api/order/6311/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"055af9af-1597-4d88-bd64-a9c82060caf1"},{"name":"Cancel Shipping Label","id":"3aed3d7d-3e42-41c8-b70e-c987f1ea19ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://your-company.myhelm.app/public-api/order/inventory_id/cancel_label","description":"Cancels the shipping label of a despatched order, with the courier where supported, and returns the order to a pre-despatch state. Use this before Cancel Order when the order has already been despatched.
\nAny authenticated user (Supervisor+).
\nshipment_id AND status_id == 5 (Despatched). Otherwise 422.{\n \"status\": \"success\" | \"fail\",\n \"ref\": string|null,\n \"message\": string|null\n}\nA fail status indicates the courier rejected the cancellation request — the message field carries the reason.
Soft-deletes an order. The order remains in the database (audit trail) but is filtered out of all listing endpoints.
\nAny authenticated user (Supervisor+). Fulfilment-client users can only delete their own orders.
\nstatus_id == 3000).{ \"id\": <order_id> }\nAdds one or more inventory line items to an existing order.
\nAny authenticated user (Supervisor+).
\ninventory_id — internal order ID.4 (Picking), 10 (Picked), 6 (Cancelled), 5 (Despatched), or 3000 (Merged). Otherwise 422.{\n \"status\": \"success\" | \"partial_success\" | \"fail\",\n \"result\": {\n \"items\": [ ...created order_inventory rows... ],\n \"errors\": [ { \"input\": {...}, \"error\": \"...\" } ]\n }\n}\npartial_success is returned when some items succeeded and some failed (per-item validation, missing inventory, etc.).
Updates a single inventory line on an order. Pass the order line's id (NOT the inventory ID) as order_inventory_id.
Any authenticated user (Supervisor+).
\n4 / 10 / 6 / 5 / 3000.The updated order_inventory record.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["order","inventory_id","update_inventory"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"3eeef52a-4537-4bb3-9961-350a21925814","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_inventory_id\": 21148,\n \"name\": \"Updated line name\",\n \"quantity\": 2,\n \"unit_price\": 1.50,\n \"unit_tax\": 0.30,\n \"line_total_discount\": 0.00,\n \"options\": {},\n \"notes\": \"\",\n \"hs_code\": \"\",\n \"country_of_origin\": \"GB\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/order/inventory_id/update_inventory","description":"Updates a single inventory line on an order. Pass the order line's `id` (NOT the inventory ID) as `order_inventory_id`.\n\n### Permissions\nAny authenticated user (Supervisor+).\n\n### Body fields\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| `order_inventory_id` | int | yes | The `id` of the order line to update (from the `inventory[]` array on the order detail). |\n| `name` / `quantity` / `unit_price` / `unit_tax` / `line_total_discount` / `options` / `notes` / `hs_code` / `country_of_origin` | mixed | no | Only these fields can be updated. Anything else is ignored. |\n\n### Constraints\n- Order status must not be `4` / `10` / `6` / `5` / `3000`.\n- Pre-generated label orders are read-only on inventory.\n\n### Response\nThe updated order_inventory record.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 21151,\n \"inventory_id\": 1,\n \"order_summary_id\": 6312,\n \"merge_order_summary_id\": null,\n \"sales_channel_item_id\": null,\n \"channel_product_sku\": null,\n \"sku\": \"ha_product_test_1\",\n \"kit_sku\": null,\n \"quantity\": 5,\n \"kit_quantity\": null,\n \"name\": \"Updated line - HA Product Test 1\",\n \"unit_price\": \"4.5000\",\n \"unit_tax\": \"0.9000\",\n \"line_total_discount\": \"1.0000\",\n \"price\": \"21.5000\",\n \"options\": \"\",\n \"selected_batches\": null,\n \"notes\": \"Updated by test\",\n \"hs_code\": \"950300\",\n \"country_of_origin\": \"GB\",\n \"customs_description\": null,\n \"allocated_location_list\": null,\n \"temp_identifier\": null,\n \"created_at\": \"2026-04-30 13:07:37\",\n \"updated_at\": \"2026-04-30 13:07:58\"\n}"}],"_postman_id":"c7c4a879-a4bb-468a-8c2c-5c2ba5dc13f4"},{"name":"Remove Inventory from Order","id":"b0b21514-5071-4e2a-89fc-aae9d68b55a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_inventory_id\": 21148\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/order/inventory_id/remove_inventory","description":"Removes a single inventory line from an order.
\norder_inventory_id (int, required) — the id of the order line, not the inventory ID.Same as Update Order Inventory Item — order status not in [4, 10, 6, 5, 3000], no pre-generated label.
{ \"id\": <order_inventory_id> }\nAllocates available stock to an order from a specific warehouse — full allocation if there's enough stock, partial otherwise. If the order already has allocations, they are removed before re-allocating.
\nallocation_status_id = 0.Any authenticated user (Supervisor+) who has access to the warehouse.
\n422.{\n \"status\": \"success\",\n \"message\": \"Order fully allocated successfully.\" | \"Order partially allocated successfully.\",\n \"order\": { ...order_summary... },\n \"allocations\": [ ... ]\n}\nBulk-allocates a batch of orders matched by filters. Operates either synchronously (direct allocation) or asynchronously by enqueuing the work — the is_direct_allocation flag in the response tells you which mode was used.
Any authenticated user (Supervisor+) with warehouse access.
\n{\n \"status\": \"success\",\n \"result\": {\n \"is_direct_allocation\": true|false,\n \"reference\": \"<batch ref>\",\n \"direct_allocation_result\": { ... } // only if is_direct_allocation is true\n }\n}\nEndpoints for managing orders — listing, retrieving detail, creating manual orders (with or without inventory or shipment labels), updating, cancelling, allocating, and managing line items.
\nstatus_id field and filters[status])Custom statuses created by your tenant will appear with their own IDs above 80; query the Settings → Get Setting Parameters endpoint with no specific key support, or read them from your dashboard.
filters[type])Returns a paginated list of distinct tag names with how many (non-deleted) orders carry each one.
\nAny authenticated user (Supervisor+). Fulfilment-client users only see tags from their own orders.
\npage (default 1). Page size is fixed by tenant Items per page setting.
List envelope; each data[] item is { tag, order_count }.
1-based page number. Default 1.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"One of: name_az | name_za. Default: tag A→Z.
LIKE-search on tag name. Single pipe | between terms ORs them.
Returns the order count for a specific tag plus its data payload (rarely populated; reserved for plugin metadata).
{\n \"id\": <integer of the first matching tag row>,\n \"tag\": \"<tag name>\",\n \"data\": {} | { ... },\n \"order_count\": <integer>\n}\nReturns 404 if no order carries that tag.
Creates a tag attachment between an order and a tag name. If the tag did not exist before this call, it implicitly comes into existence (tags are derived from attachments).
\ninventory_id — the order to attach it to.422.The newly-created orders__tags record.
422 — tag too short.404 — order not found.401 — fulfilment-client user attempting to tag another client's order.Removes a single tag from a single order. The tag itself remains on other orders that still carry it.
\ninventory_id — the order to detach it from.The deleted attachment record.
\n404 — order not found, or the tag wasn't attached to that order.Deletes a tag from every non-deleted order it's attached to. The tag effectively ceases to exist after this call returns.
\nUse with care — this is a global operation.
\n{ \"tag\": \"<tag name>\" }\nReturns 404 if no order currently carries the tag.
Read, attach, detach, and delete order tags. Tags are free-text labels grouped by tag value across all orders — there is no separate \"tag definition\" table; a tag exists if at least one order has it.
Examples of tags created automatically by other parts of the system:
\nAPI — added to every order created via the public API.API - PREGEN — added to API orders created with a pre-generated shipping label.Direct To Print Plugin, PLUGIN - PREGEN — added by various plugins.BAT-<timestamp> — batch-creation markers.Tag names must be at least 3 alphanumeric characters when attached.
\n","_postman_id":"89d59f3f-628b-4787-8906-cac77f09de74","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}}},{"name":"Inventory","item":[{"name":"Stock Locations","item":[{"name":"Create Inventory Location","id":"4fbe0952-2092-42ef-bac6-943a72531841","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"location_id\": 1,\n \"stock_level\": 0,\n \"stock_warn_level\": 1,\n \"note\": \"Initial setup\",\n \"auto_allocate\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/inventory/contact_id/create_inventory_location","description":"Adds a new warehouse location to an inventory item, optionally seeding it with an initial stock level.
\nNot available to fulfilment-client users. The user must have access to the warehouse that owns location_id.
{ \"status\": \"success\" }\nIncreases, decreases, or sets the stock level of an inventory item at a specific warehouse location.
\nnote is mandatory; missing/empty returns 422.decrease is rejected — use Scrap Stock instead so a reason can be recorded.set and decrease cannot bring the stock level below already-allocated quantities.Not available to fulfilment-client users. Warehouse access required.
\n{ \"status\": \"success\" }\nMoves stock of an inventory item between two warehouse locations atomically.
\nNot available to fulfilment-client users. The user must have access to both warehouses.
\n{ \"status\": \"success\" }\nRemoves (scraps) stock from inventory at a specific location, recording the reason for audit. Only available when the Inventory Scrapping feature is enabled on the tenant.
\nNot available to fulfilment-client users. Warehouse access required.
\n{ \"status\": \"success\" }\nRemoves a warehouse location from an inventory item.
\ncontact_id — the inventory item.purchase_order_id — the warehouse location to remove.stock_level must be 0.Not available to fulfilment-client users.
\n{ \"status\": \"success\" }\nManage where the SKU lives in the warehouse and how much of it is at each location. All endpoints in this folder are blocked for fulfilment-client users (Not available to fulfilment-client users).
Links a supplier contact to an inventory item, recording the supplier's reference, MOQ, and cost.
\n{ \"supplier_link\": { ... inventory_supplier_link record ... } }\nUpdates an existing inventory↔supplier link.
\n{ \"id\": <link_id> }\nRemoves an inventory↔supplier link. The supplier contact itself is not deleted.
\ninventory_supplier_link_id (int, required).{ \"id\": <link_id> }\nLink inventory items to supplier contacts so PO creation, MOQ tracking, and supplier-cost reporting can work.
\n","_postman_id":"6b5062d7-68b1-4303-97ce-19d004739c55","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}}},{"name":"Inventory Links","item":[{"name":"Create Inventory Link","id":"fca37989-3daf-4813-a363-03be69253ef8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"inventory_id\": 42,\n \"quantity\": 1,\n \"packing_option\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/inventory/contact_id/create_inventory_link","description":"Adds a child inventory link under the parent identified by contact_id.
{ \"inventory_link\": { ... inventory_to_inventory_link record ... } }\nUpdates an existing inventory link.
\ninventory_inventory_link_id (int, required) — the link to update.inventory_id (int, optional) — replace the child inventory.quantity (int, optional).packing_option (int, optional).{ \"id\": <link_id> }\nRemoves an inventory link.
\ninventory_inventory_link_id (int, required).{ \"id\": <link_id> }\nCompose inventory items out of other inventory items (kits / groups / dynamic components). A parent item links to one or more children; per-link quantity says how many of the child go into one of the parent.
\n","_postman_id":"3e524d89-883b-4412-bcb7-4034827adf98","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}}},{"name":"Batches & Serials","item":[{"name":"Add Inventory Batch","id":"dde6acfe-a49d-4f58-a289-3502b7c0ef15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"location_id\": 1, // must be a location with an existing inventory_location_link for the inventory\n \"batch_values\": [\n { \"value\": \"BATCH-2026-04-001\", \"expire_date\": \"2027-04-30\", \"quantity\": 50 },\n { \"value\": \"BATCH-2026-04-002\", \"expire_date\": \"2027-04-30\", \"quantity\": 50 }\n ]\n}\n// The inventory must have batching_type=1 (serial) or batching_type=2 (batch).","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/inventory/contact_id/add_inventory_batch","description":"Adds one or more batch / serial-number rows to an inventory item, each with their own quantity and (optionally) expiry date.
\nbatching_type != 0.batching_type = 1 (Serial Number) every value must be globally unique within the SKU — duplicates across the request or against existing serials are rejected.batching_type = 2 (Batch Number) duplicate values are allowed but (value + location + expiry) must be unique.{\n \"success\": [ ...created batch records... ],\n \"errors\": { // present only if some serials failed validation\n \"unique_serial_number_values\": [ \"...\" ],\n \"unique_serial_number_errors\": \"<message>\"\n }\n}\nUpdates a single batch / serial-number row.
\nbatch_id (int, required).value (string, optional) — must be unique under the same uniqueness rules as Add Inventory Batch.expire_date (string, optional).quantity (int, optional) — cannot be reduced below already-allocated stock. If the Inventory Scrapping feature is enabled, you cannot reduce quantity at all (use Scrap Stock).{ \"id\": <batch_id> }\nRemoves a batch/serial row entirely. Use this when the batch is no longer in the warehouse and no allocation refers to it.
\nbatch_id (int, required).{ \"id\": <batch_id> }\nManage individual batch / serial-number stock rows for inventory items configured with batching_type != 0. Use these endpoints to record initial intake, correct mistakes, or remove batches that are no longer in the warehouse.
Adds a new package configuration to an inventory item.
\n{ \"package_configuration\": { ... inventory_box_link record ... } }\nUpdates a package configuration.
\npackage_configuration_id (int, required).type, quantity, weight, height, width, length (optional).{ \"id\": <package_configuration_id> }\nDeletes a package configuration.
\npackage_configuration_id (int, required).{ \"id\": <package_configuration_id> }\nEach inventory item can declare one or more package configurations — \"if you put N of this SKU in a box, the box has these dimensions and weight\". Used by the cartonisation engine when generating shipments.
\n","_postman_id":"dc35410a-345b-493b-842b-4f3d2d92c398","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}}},{"name":"Categories","item":[{"name":"Add Category to Inventory","id":"20c718c3-24ee-4889-abfc-b86bfa528654","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"category_id\": \n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/inventory/contact_id/create_inventory_category","description":"Assigns an existing inventory category to an inventory item.
\ncategory_id (int, required) — see Inventory Categories → List Categories for valid IDs.{ \"status\": \"success\" }\nRemoves a category assignment from an inventory item.
\ninventory_category_id (int, required) — note the field name is inventory_category_id, not category_id.{ \"id\": <link_id> }\nAttach and detach inventory categories on an item. To create or rename categories themselves, see the top-level Inventory Categories folder.
\n","_postman_id":"121685fe-b2db-4b9d-ad70-b438d6684709","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}}},{"name":"List Inventory","id":"97196286-777c-4661-a4e8-f997e07bca8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-company.myhelm.app/public-api/inventory?page=1&per_page=20","description":"Returns a paginated list of inventory items with their per-location stock figures embedded.
\nsort=stockwarn_hl).Any authenticated user (Supervisor+). Fulfilment-client users only see their own SKUs.
\npage (default 1), per_page (default tenant setting).
name_az / _za, sku_az / _za, stock_level_available_hl / _lh, stock_level_open_hl / _lh, stockwarn_hl / _lh, syncstock_yn / _ny, productweight_hl / _lh, updated_at_pr / _rp. _hl = high→low, _lh = low→high, _pr = past→recent (ASC), _rp = recent→past (DESC), _yn = enabled→disabled.
List envelope. Each data[] item is the full inventory record with:
locations[] — every warehouse location the SKU is stocked at, with stock_level, stock_level_available, etc.image / images[] — thumbnail and gallery URLs.accounting_options[] — assigned accounting codes, if any.custom_fields — object.1-based page number. Default 1.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Records per page. Default is the tenant's Items per page setting.
\n","type":"text/plain"},"key":"per_page","value":"20"},{"disabled":true,"description":{"content":"One of: name_az | name_za | sku_az | sku_za | stock_level_available_hl | stock_level_available_lh | stock_level_open_hl | stock_level_open_lh | stockwarn_hl | stockwarn_lh | syncstock_yn | syncstock_ny | productweight_hl | productweight_lh | updated_at_pr | updated_at_rp. Default: updated_at descending.
LIKE-search on name, SKU, and the five barcode fields. Use a single pipe | between terms to OR them.
Exact-match SKU. Send multiple times for OR.
\n","type":"text/plain"},"key":"filters[sku][]","value":""},{"disabled":true,"description":{"content":"Bulk SKU filter using a literal || separator inside the value. Useful when the SKU list is too long for the array-bracket form.
Single inventory type ID. See folder description for values.
Multi-value version of product_type. Send multiple times for OR.
Warehouse location ID. Send multiple times for OR.
\n","type":"text/plain"},"key":"filters[location][]","value":"1"},{"disabled":true,"description":{"content":"Fulfilment client ID. Send multiple times for OR. Visible to back-office users only.
\n","type":"text/plain"},"key":"filters[fulfilment_clients][]","value":""},{"disabled":true,"description":{"content":"Filter by ghost-asset flag (0 = real, 1 = ghost). Send multiple times for OR.
Returns the full record for a single inventory item, including every location's stock figures, suppliers, batches/serials, package configurations, inventory links, and assigned categories.
\ncontact_id — internal inventory ID.Full inventory record. The shape mirrors List Inventory plus deeper relations (suppliers, links, batches if applicable). Returns 404 if the inventory doesn't exist or has been deleted.
Creates a new inventory item (SKU). Stock at locations is added separately via Stock Locations → Create Inventory Location (or via batches).
\nAny authenticated user (Supervisor+). Fulfilment-client users have fulfilment_client_id auto-set to their own client.
type = 3 (Group) and batching_type together is not allowed — batching_type is forced to 0 and is_serial_numbered to 0.default_packaging_id, if set, must reference a valid Packaging (type 4) inventory item; otherwise it's reset to 0.The full created inventory record (same shape as Get Inventory Detail).
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["inventory","create"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"bf2c2be1-b9b2-40cc-b5ec-5bef2e8c4e88","name":"200 — created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"name\":\"API Test Product\",\"sku\":\"API-TEST-001\",\"type\":1,\"unit_price\":9.99,\"cost_price\":5.00,\"product_weight\":0.5,\"country_of_origin\":\"GB\",\"item_barcode\":\"5012345678901\"}"},"url":"https://your-company.myhelm.app/public-api/inventory/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": 744,\n \"type\": 1,\n \"batching_type\": 0,\n \"is_serial_numbered\": 0,\n \"sku\": \"API-TEST-001\",\n \"sku_hash\": \"111737164e1baae0654fb56c888944c5\",\n \"vendor_sku\": null,\n \"stock_level\": 0,\n \"stock_level_open\": 0,\n \"stock_level_global_available\": 0,\n \"stock_level_available\": 0,\n \"stock_warn_level\": 0,\n \"item_barcode\": \"5012345678901\",\n \"name\": \"API Test Product\",\n \"product_weight\": \"0.500\",\n \"product_height\": \"5.0\",\n \"product_width\": \"10.0\",\n \"product_length\": \"15.0\",\n \"product_box_type\": 5,\n \"product_box_quantity\": 1,\n \"default_packaging_id\": 0,\n \"description\": \"Created via API for testing\",\n \"country_of_origin\": \"GB\",\n \"hs_code\": \"\",\n \"unit_price\": \"9.9900\",\n \"cost_price\": \"5.0000\",\n \"shipping_service_id\": 0,\n \"vat_rate_percentage\": \"20.0000\",\n \"custom_fields\": {},\n \"is_archived\": 0,\n \"created_at\": \"2026-04-30 11:50:19\",\n \"updated_at\": \"2026-04-30 11:50:19\",\n \"accounting_options\": [],\n \"images\": [],\n \"hs_codes\": []\n}"}],"_postman_id":"753b7b4f-db29-45ab-af20-ca351973f924"},{"name":"Update Inventory Item","id":"8ad9bab7-e12d-4f72-8dd7-d71adc3d43a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Updated name\",\n \"unit_price\": 12.99,\n \"cost_price\": 6.00,\n \"description\": \"Updated description\",\n \"product_weight\": 0.6,\n \"hs_code\": \"\",\n \"country_of_origin\": \"GB\",\n \"stock_warn_level\": 10,\n \"custom_fields\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/inventory/contact_id/update","description":"Updates editable fields on an existing inventory item. Send only the fields you want to change.
\nAll optional. Mostly the same set as Create Inventory Item, plus:
\nstock_warn_level — global low-stock threshold for this SKU.type cannot be changed if the item has any active stock or location records — 422 with \"The inventory type field cannot be changed.\".batching_type cannot be changed for Group items — 422 with \"Batching type cannot be changed for group products.\".batching_type or is_serial_numbered while the item has active stock returns 422 with \"Cannot process this request due to active stock/locations. To proceed all stock and and locations must be removed.\".The updated inventory record.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["inventory","contact_id","update"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"639e4288-db45-42c6-a308-e0a23de600fb","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Updated name\",\n \"unit_price\": 12.99,\n \"cost_price\": 6.00,\n \"description\": \"Updated description\",\n \"product_weight\": 0.6,\n \"hs_code\": \"\",\n \"country_of_origin\": \"GB\",\n \"stock_warn_level\": 10,\n \"custom_fields\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/inventory/contact_id/update","description":"Updates editable fields on an existing inventory item. Send only the fields you want to change.\n\n### Body fields\nAll optional. Mostly the same set as **Create Inventory Item**, plus:\n- `stock_warn_level` — global low-stock threshold for this SKU.\n\n### Important constraints\n- `type` cannot be changed if the item has any active stock or location records — `422` with \"The inventory type field cannot be changed.\".\n- `batching_type` cannot be changed for Group items — `422` with \"Batching type cannot be changed for group products.\".\n- Changing `batching_type` or `is_serial_numbered` while the item has active stock returns `422` with \"Cannot process this request due to active stock/locations. To proceed all stock and and locations must be removed.\".\n- Custom-field values are validated against the tenant's inventory custom-field schema.\n\n### Response\nThe updated inventory record.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 745,\n \"legacy_id\": null,\n \"type\": 1,\n \"batching_type\": 0,\n \"is_serial_numbered\": 0,\n \"service_id\": 0,\n \"dropshipping_type\": 0,\n \"sync_stock\": 1,\n \"include_component_stock_level\": 0,\n \"fulfilment_client_id\": null,\n \"sku\": \"POSTMAN-G2-TEST\",\n \"secondary_sku\": \"\",\n \"sku_hash\": \"d89a7ef1f8d2fbd57f65b89e36647428\",\n \"vendor_sku\": null,\n \"chapi_id\": null,\n \"stock_level\": 0,\n \"stock_level_open\": 0,\n \"stock_level_global_available\": 0,\n \"stock_level_available\": 0,\n \"stock_warn_level\": 10,\n \"item_barcode\": \"\",\n \"item_barcode_2\": \"\",\n \"item_barcode_3\": \"\",\n \"item_barcode_4\": \"\",\n \"item_barcode_5\": \"\",\n \"thumbnail_url\": null,\n \"single_parcel_per_item\": 0,\n \"name\": \"Updated Postman G2 Test Item\",\n \"product_weight\": \"0.600\",\n \"product_height\": \"5.0\",\n \"product_width\": \"10.0\",\n \"product_length\": \"15.0\",\n \"product_box_type\": 5,\n \"product_box_quantity\": 1,\n \"picking_by_packaging\": 0,\n \"default_packaging_id\": 0,\n \"description\": \"Updated description from Postman test\",\n \"country_of_origin\": \"GB\",\n \"hs_code\": \"\",\n \"customs_description\": \"\",\n \"unit_price\": \"12.9900\",\n \"cost_price\": \"6.0000\",\n \"shipping_service_id\": 0,\n \"zone\": \"\",\n \"multiplier\": 1,\n \"include_po_stock\": 0,\n \"custom_fields\": {},\n \"dynamic_components_type\": 0,\n \"is_archived\": 0,\n \"archived_sync_stock\": null,\n \"temp_image_url\": null,\n \"ghost_asset\": 0,\n \"master_dropshipping\": 0,\n \"include_po_level\": 0,\n \"fabric_content\": \"\",\n \"low_stock_email_sent_time\": 0,\n \"vat_rate_percentage\": \"20.0000\",\n \"stock_update_scheduled_at\": \"2026-04-30 13:12:47\",\n \"created_at\": \"2026-04-30 13:12:42\",\n \"updated_at\": \"2026-04-30 12:12:47\",\n \"dont_sync_until\": null,\n \"assembly_notes\": null,\n \"customs_value\": null,\n \"accounting_options\": [],\n \"images\": [],\n \"hs_codes\": []\n}"}],"_postman_id":"8ad9bab7-e12d-4f72-8dd7-d71adc3d43a4"},{"name":"Delete Inventory Item","id":"b5159e08-5617-4f10-a3e4-e3eccd2cac4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://your-company.myhelm.app/public-api/inventory/contact_id/delete","description":"Soft-deletes an inventory item. The record stays in the database for audit but is filtered out of all listing endpoints.
\n{ \"id\": <inventory_id> }\nEndpoints for managing inventory (SKUs) and everything attached to them — stock at locations, suppliers, inventory-to-inventory links, batches/serial numbers, package configurations, and category assignments.
\ntype referencebatching_type referenceSee the collection-level description for filters[...] syntax. The inventory-list filter multiple_sku uses a literal || separator inside a single value, e.g. filters[multiple_sku]=SKU-A||SKU-B||SKU-C. Other multi-value filters use the standard array form filters[<key>][]=.
Returns a paginated list of inventory categories. Categories support a parent_category_id for tree structures.
page (default 1). Page size is fixed by tenant settings.
Fixed: id ascending. There is no sort parameter.
List envelope. Each data[] item is a inventory_category record. When there are no categories, data is null (not []).
1-based page number.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"LIKE-search on category_name.
Returns a single category. If the category has a parent_category_id, the parent record is embedded as parent (recursive).
{\n \"id\": <int>,\n \"category_name\": \"<string>\",\n \"parent_category_id\": <int|null>,\n \"parent\": { ... } // present only when parent_category_id is set\n}\nReturns 404 if the category doesn't exist or has been deleted.
Creates a new inventory category.
\ncategory_name (string, required).parent_category_id (int, optional) — for nested categories. Send null (or omit) for a root category.The created inventory_category record.
Updates a category. Send only the fields you want to change — fields with empty values are ignored.
\ncategory_name (string, optional).parent_category_id (int, optional).The updated inventory_category record.
Soft-deletes a category. Inventory items previously assigned to it are no longer linked.
\n{ \"id\": <category_id> }\nManage the categories themselves (create / rename / delete). To assign a category to an inventory item, see Inventory → Categories.
\n","_postman_id":"06851f7a-f586-4474-98a1-5af259c2bd72","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}}},{"name":"Inventory Scrapping Reasons","item":[{"name":"List Reasons","id":"48d1776e-43b4-47c1-8060-cfffae98327a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-company.myhelm.app/public-api/inventory_scrapping_reasons?page=1","description":"Returns a paginated list of scrapping reasons.
\npage (default 1). Page size is fixed by tenant settings.
Fixed: id ascending.
List envelope. Each data[] item is { id, reason, ... }. When there are no reasons, data is null.
1-based page number.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"LIKE-search on reason.
Returns a single scrapping reason. 404 if it doesn't exist.
Creates a new scrapping reason.
\nreason (string, required).The created record. The created record is returned.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["inventory_scrapping_reasons","create"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"c1f576fc-9fd0-4a46-adf3-b55319d30150","name":"200 — created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"reason\":\"Damaged in transit\"}"},"url":"https://your-company.myhelm.app/public-api/inventory_scrapping_reasons/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"reason\": \"\",\n \"created_at\": \"2026-04-30 11:47:59\",\n \"updated_at\": \"2026-04-30 11:47:59\"\n}"}],"_postman_id":"5b3853b0-90a6-458d-bab6-33f7a5be6490"},{"name":"Update Reason","id":"7956010b-f729-4320-9a53-b9075e606ffc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"Damaged on receipt\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/inventory_scrapping_reasons//update","description":"Updates a scrapping reason. Empty values are ignored.
\nreason (string, optional).The updated record.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["inventory_scrapping_reasons","","update"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"7eec301d-134e-4097-9f81-ead1f698b659","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"Damaged on receipt\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/inventory_scrapping_reasons//update","description":"Updates a scrapping reason. Empty values are ignored.\n\n### Body field\n- `reason` (string, optional).\n\n### Response\nThe updated record.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 3,\n \"reason\": \"Damaged on receipt - updated\",\n \"created_at\": \"2026-04-30 13:13:02\",\n \"updated_at\": \"2026-04-30 13:13:09\"\n}"}],"_postman_id":"7956010b-f729-4320-9a53-b9075e606ffc"},{"name":"Delete Reason","id":"2f1611d6-7bc8-4b00-87da-46f295037cc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://your-company.myhelm.app/public-api/inventory_scrapping_reasons//delete","description":"Soft-deletes a scrapping reason.
\n{ \"id\": <reason_id> }\nA short list of reasons users can pick from when scrapping stock (for example: Damaged, Expired, Quality control reject). Use Inventory → Stock Locations → Scrap Stock to actually scrap stock against a reason.
Returns a paginated list of customers.
\npage (default 1). Page size is fixed by tenant settings.
List envelope. Each data[] item is a contact record with full address, compliance numbers (VAT/EORI/IOSS/UKIMS), payment metadata, and custom_fields decoded into an object.
1-based page number.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"One of: name_az | name_za | updated_at_pr | updated_at_rp. Default: created_at descending.
LIKE-search on shipping_name, shipping_name_company, invoice_name, invoice_name_company, and email. Single pipe | between terms ORs them.
Exact match on email.
Fulfilment client ID. Send multiple times for OR. Visible to back-office users only.
\n","type":"text/plain"},"key":"filters[fulfilment_clients][]","value":""}],"variable":[]}},"response":[{"id":"a5eb7793-684c-49a5-8cdd-936cdb58a177","name":"200 — page of customers","originalRequest":{"method":"GET","header":[],"url":"https://your-company.myhelm.app/public-api/customers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"total\": 11,\n \"per_page\": \"100\",\n \"current_page\": 1,\n \"last_page\": 1,\n \"next_page_url\": null,\n \"prev_page_url\": null,\n \"from\": 0,\n \"to\": 100,\n \"data\": [\n {\n \"id\": 5789,\n \"contact_type\": 1,\n \"is_archived\": 0,\n \"fulfilment_client_id\": null,\n \"shipping_name\": \"Customer Name\",\n \"shipping_address_line_one\": \"1 Example Street\",\n \"shipping_address_city\": \"Test City\",\n \"shipping_address_country\": \"United Kingdom\",\n \"shipping_address_postcode\": \"YO25 9FQ\",\n \"shipping_address_iso\": \"GB\",\n \"invoice_name\": \"Customer Name\",\n \"email\": \"customer@example.com\",\n \"custom_fields\": {}\n }\n ]\n}"}],"_postman_id":"620438b0-ee7e-47c9-975b-7fb68541a1e6"},{"name":"List Suppliers","id":"c834b71b-c020-4483-91ed-1d41f969c102","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-company.myhelm.app/public-api/suppliers?page=1","description":"Returns a paginated list of suppliers. Same filter set, sort options, and response shape as List Customers.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["suppliers"],"host":["https://your-company.myhelm.app/public-api"],"query":[{"description":{"content":"1-based page number.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"One of: name_az | name_za | updated_at_pr | updated_at_rp. Default: created_at descending.
LIKE-search on shipping/invoice name+company and email. Single pipe | between terms ORs them.
Exact match on email.
Fulfilment client ID. Send multiple times for OR.
\n","type":"text/plain"},"key":"filters[fulfilment_clients][]","value":""}],"variable":[]}},"response":[{"id":"aad377f6-ab23-4a1c-9f00-a5d6e9991dc6","name":"200 — page of suppliers","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://your-company.myhelm.app/public-api/suppliers?page=1","host":["https://your-company.myhelm.app/public-api"],"path":["suppliers"],"query":[{"key":"page","value":"1","description":"1-based page number."},{"key":"sort","value":"name_az","description":"One of: `name_az` | `name_za` | `updated_at_pr` | `updated_at_rp`. Default: `created_at` descending.","disabled":true},{"key":"filters[search]","value":"","description":"LIKE-search on shipping/invoice name+company and email. Single pipe `|` between terms ORs them.","disabled":true},{"key":"filters[email]","value":"","description":"Exact match on `email`.","disabled":true},{"key":"filters[fulfilment_clients][]","value":"","description":"Fulfilment client ID. Send multiple times for OR.","disabled":true}]},"description":"Returns a paginated list of suppliers. Same filter set, sort options, and response shape as **List Customers**.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 1,\n \"per_page\": \"100\",\n \"current_page\": 1,\n \"last_page\": 1,\n \"next_page_url\": null,\n \"prev_page_url\": null,\n \"from\": 0,\n \"to\": 100,\n \"data\": [\n {\n \"id\": 5779,\n \"contact_type\": 2,\n \"is_archived\": 0,\n \"fulfilment_client_id\": null,\n \"shipping_name_company\": \"Hidayet Arasan\",\n \"shipping_name\": \"Hidayet Arasan\",\n \"shipping_address_line_one\": \"1 Sandwash Business Park\",\n \"shipping_address_line_two\": \"Sandwash Close Rainford\",\n \"shipping_address_city\": \"St. Helens\",\n \"shipping_address_county\": \"\",\n \"shipping_address_country\": \"United Kingdom\",\n \"shipping_address_postcode\": \"WA11 8SZ\",\n \"shipping_address_iso\": \"\",\n \"invoice_name_company\": \"Hidayet Arasan\",\n \"invoice_name\": \"Hidayet Arasan\",\n \"invoice_address_line_one\": \"1 Sandwash Business Park\",\n \"invoice_address_line_two\": \"Sandwash Close Rainford\",\n \"invoice_address_city\": \"St. Helens\",\n \"invoice_address_county\": \"\",\n \"invoice_address_country\": \"United Kingdom\",\n \"invoice_address_postcode\": \"WA11 8SZ\",\n \"invoice_address_iso\": \"\",\n \"trade_terms\": 0,\n \"email\": \"Hidayet.Arasan@thedespatchcompany.com\",\n \"email_shipping\": null,\n \"email_cc_1\": \"Hidayet.Arasan@thedespatchcompany.com\",\n \"email_cc_2\": \"Hidayet.Arasan@thedespatchcompany.com\",\n \"phone_one\": \"05555555555\",\n \"phone_two\": null,\n \"notes\": null,\n \"custom_fields\": {},\n \"vat_number\": null,\n \"eori_number\": null,\n \"ioss_number\": null,\n \"ukims_number\": null,\n \"account_number\": null,\n \"tax_id\": null,\n \"accounts_id\": null,\n \"payment_currency\": \"GBP\",\n \"default_delivery_instructions\": null,\n \"created_at\": \"2026-02-25 13:51:31\",\n \"updated_at\": \"2026-02-25 13:51:47\"\n }\n ]\n}"}],"_postman_id":"c834b71b-c020-4483-91ed-1d41f969c102"},{"name":"Get Contact Detail","id":"43ddc951-da4e-44de-b7e3-071e0bf07edf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-company.myhelm.app/public-api/contact/location_id","description":"Returns the full record for a single contact (customer or supplier).
\nlocation_id — numeric contact ID.The full contact record with custom_fields decoded into an object. Returns 404 if not found, 401 if a fulfilment-client user requests another client's contact.
Creates a new customer contact (contact_type = 1).
The created contact record with custom_fields decoded. Includes a few extra fields not shown in the request: trade_terms, accounts_id, default_delivery_instructions, email_shipping.
Creates a new supplier contact (contact_type = 2).
Same set as Create Customer. The only difference is the resulting record is flagged as a supplier and becomes selectable when creating purchase orders or linking suppliers to inventory.
\nThe created contact record.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["suppliers","create"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"db2cfc20-fe93-4df3-92c9-f985df3da3ce","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"supplier@example.com\",\n \"phone_one\": \"+44 1234 567890\",\n\n \"shipping_name_company\": \"Acme Supplies Ltd\",\n \"shipping_name\": \"Sales Contact\",\n \"shipping_address_line_one\": \"5 Industrial Estate\",\n \"shipping_address_city\": \"Manchester\",\n \"shipping_address_country\": \"United Kingdom\",\n \"shipping_address_postcode\": \"M1 1AA\",\n \"shipping_address_iso\": \"GB\",\n\n \"invoice_name_company\": \"Acme Supplies Ltd\",\n \"invoice_name\": \"Accounts\",\n \"invoice_address_line_one\": \"5 Industrial Estate\",\n \"invoice_address_city\": \"Manchester\",\n \"invoice_address_country\": \"United Kingdom\",\n \"invoice_address_postcode\": \"M1 1AA\",\n \"invoice_address_iso\": \"GB\",\n\n \"vat_number\": \"\",\n \"account_number\": \"SUP-001\",\n \"notes\": \"\",\n \"payment_currency\": \"GBP\",\n\n \"custom_fields\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/suppliers/create","description":"Creates a new supplier contact (`contact_type = 2`).\n\n### Body fields\nSame set as **Create Customer**. The only difference is the resulting record is flagged as a supplier and becomes selectable when creating purchase orders or linking suppliers to inventory.\n\n### Response\nThe created contact record.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 5795,\n \"contact_type\": 2,\n \"is_archived\": 0,\n \"fulfilment_client_id\": null,\n \"shipping_name_company\": \"Postman Test Supplies Ltd\",\n \"shipping_name\": \"Sales Contact\",\n \"shipping_address_line_one\": \"5 Industrial Estate\",\n \"shipping_address_line_two\": \"\",\n \"shipping_address_city\": \"Manchester\",\n \"shipping_address_county\": \"\",\n \"shipping_address_country\": \"United Kingdom\",\n \"shipping_address_postcode\": \"M1 1AA\",\n \"shipping_address_iso\": \"GB\",\n \"invoice_name_company\": \"Postman Test Supplies Ltd\",\n \"invoice_name\": \"Accounts\",\n \"invoice_address_line_one\": \"5 Industrial Estate\",\n \"invoice_address_line_two\": \"\",\n \"invoice_address_city\": \"Manchester\",\n \"invoice_address_county\": \"\",\n \"invoice_address_country\": \"United Kingdom\",\n \"invoice_address_postcode\": \"M1 1AA\",\n \"invoice_address_iso\": \"GB\",\n \"trade_terms\": 0,\n \"email\": \"postman-supplier@example.com\",\n \"email_shipping\": null,\n \"email_cc_1\": \"\",\n \"email_cc_2\": \"\",\n \"phone_one\": \"+44 1234 567890\",\n \"phone_two\": \"\",\n \"notes\": \"\",\n \"custom_fields\": {},\n \"vat_number\": \"\",\n \"eori_number\": \"\",\n \"ioss_number\": \"\",\n \"ukims_number\": \"\",\n \"account_number\": \"POSTMAN-SUP-001\",\n \"tax_id\": \"\",\n \"accounts_id\": null,\n \"payment_currency\": \"GBP\",\n \"default_delivery_instructions\": null,\n \"created_at\": \"2026-04-30 13:15:51\",\n \"updated_at\": \"2026-04-30 13:15:51\"\n}"}],"_postman_id":"f297350d-bf0a-47e9-813b-313906c9b0c3"},{"name":"Update Contact","id":"26d1205d-e424-4777-95fc-828989915a06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"updated@example.com\",\n \"phone_one\": \"+44 1234 999999\",\n \"shipping_address_line_one\": \"New Address\",\n \"vat_number\": \"GB123456789\",\n \"custom_fields\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/contact/location_id/update","description":"Updates an existing contact (works for both customers and suppliers — type is not changeable).
\nAll optional. Send only the fields you want to change. Same set as Create Customer minus contact_type and fulfilment_client_id.
401.The updated contact record.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["contact","location_id","update"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"bc484390-bac9-4f31-934b-1a989871f389","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"updated@example.com\",\n \"phone_one\": \"+44 1234 999999\",\n \"shipping_address_line_one\": \"New Address\",\n \"vat_number\": \"GB123456789\",\n \"custom_fields\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/contact/location_id/update","description":"Updates an existing contact (works for both customers and suppliers — type is not changeable).\n\n### Body fields\nAll optional. Send only the fields you want to change. Same set as **Create Customer** *minus* `contact_type` and `fulfilment_client_id`.\n\n### Notes\n- Empty values are ignored — to clear a field, send a single space or follow up with another approach.\n- Custom fields are validated against the contact custom-field schema.\n- Fulfilment-client users can only update their own contacts; otherwise `401`.\n\n### Response\nThe updated contact record.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 5795,\n \"contact_type\": 2,\n \"is_archived\": 0,\n \"fulfilment_client_id\": null,\n \"shipping_name_company\": \"Postman Test Supplies Ltd\",\n \"shipping_name\": \"Sales Contact\",\n \"shipping_address_line_one\": \"New Address Line\",\n \"shipping_address_line_two\": \"\",\n \"shipping_address_city\": \"Manchester\",\n \"shipping_address_county\": \"\",\n \"shipping_address_country\": \"United Kingdom\",\n \"shipping_address_postcode\": \"M1 1AA\",\n \"shipping_address_iso\": \"GB\",\n \"invoice_name_company\": \"Postman Test Supplies Ltd\",\n \"invoice_name\": \"Accounts\",\n \"invoice_address_line_one\": \"5 Industrial Estate\",\n \"invoice_address_line_two\": \"\",\n \"invoice_address_city\": \"Manchester\",\n \"invoice_address_county\": \"\",\n \"invoice_address_country\": \"United Kingdom\",\n \"invoice_address_postcode\": \"M1 1AA\",\n \"invoice_address_iso\": \"GB\",\n \"trade_terms\": 0,\n \"email\": \"updated-postman-supplier@example.com\",\n \"email_shipping\": null,\n \"email_cc_1\": \"\",\n \"email_cc_2\": \"\",\n \"phone_one\": \"+44 1234 999999\",\n \"phone_two\": \"\",\n \"notes\": \"\",\n \"custom_fields\": {},\n \"vat_number\": \"GB123456789\",\n \"eori_number\": \"\",\n \"ioss_number\": \"\",\n \"ukims_number\": \"\",\n \"account_number\": \"POSTMAN-SUP-001\",\n \"tax_id\": \"\",\n \"accounts_id\": null,\n \"payment_currency\": \"GBP\",\n \"default_delivery_instructions\": null,\n \"created_at\": \"2026-04-30 13:15:51\",\n \"updated_at\": \"2026-04-30 13:15:51\"\n}"}],"_postman_id":"26d1205d-e424-4777-95fc-828989915a06"},{"name":"Delete Contact","id":"02f313d0-469d-41ca-bc57-67d641e013e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://your-company.myhelm.app/public-api/contact/location_id/delete","description":"Soft-deletes a contact.
\n{ \"id\": <contact_id> }\nContacts cover both customers (people who place orders) and suppliers (companies that supply purchase orders). The two share the same record type and the same detail/update/delete endpoints — only the list and create endpoints split by type.
\ncontact_type = 1 → Customercontact_type = 2 → SupplierFulfilment-client users only see contacts that belong to their own client.
\n","_postman_id":"56634ee8-ff9f-4fcd-b81a-057830a9bf30","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}}},{"name":"Locations","item":[{"name":"List Locations","id":"b9fe86fc-6dac-4603-9027-6778a2b36aa2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-company.myhelm.app/public-api/locations?page=1&per_page=20","description":"Returns a paginated list of warehouse locations.
\npage (default 1), per_page (default tenant setting).
Fixed: id ascending. There is no sort parameter.
Fulfilment-client users only see locations linked to their client.
\nList envelope. Each data[] item is a location record with location_name, barcode, warehouse_id, parent_location_id, type_id, priority, pickable, etc.
1-based page number.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Records per page. Default tenant setting.
\n","type":"text/plain"},"key":"per_page","value":"20"},{"disabled":true,"description":{"content":"LIKE-search on location_name and barcode.
Filter by parent warehouse ID. Returns only bins/shelves inside that warehouse.
\n","type":"text/plain"},"key":"filters[warehouse_id]","value":""},{"disabled":true,"description":{"content":"Filter by type_id (location type — warehouse / bin / shelf / etc.).
Returns a single location with its address(es) and (recursively) its parent location.
\nThe location record plus:
address — array of address records linked to this location (shipment + invoice).parent — the parent location, recursively (only present if parent_location_id is set).Fulfilment-client users can only fetch locations their client is linked to.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["location","purchase_order_id"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"7a2c51f5-e518-432d-8427-ec94590cd36c","name":"200 — location found","originalRequest":{"method":"GET","header":[],"url":"https://your-company.myhelm.app/public-api/location/purchase_order_id","description":"Returns a single location with its address(es) and (recursively) its parent location.\n\n### Response\nThe `location` record plus:\n- `address` — array of `address` records linked to this location (shipment + invoice).\n- `parent` — the parent location, recursively (only present if `parent_location_id` is set).\n\n### Permissions\nFulfilment-client users can only fetch locations their client is linked to.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"type_id\": null,\n \"parent_location_id\": null,\n \"legacy_id\": null,\n \"location_name\": \"Default\",\n \"priority\": 1000,\n \"pickable\": 1,\n \"allow_box_splitting\": 1,\n \"allow_negative\": 0,\n \"on_hand_stock\": 1,\n \"warehouse_id\": 6,\n \"deleted\": 0,\n \"deleted_at\": null,\n \"pm_plugin_capacity_type\": 2,\n \"pm_plugin_capacity_value\": 1,\n \"pm_plugin_current_capacity\": 0,\n \"pm_plugin_allow_mixed_products\": 1,\n \"pm_plugin_not_in_use\": 0,\n \"pm_plugin_has_mixed_product\": 0,\n \"created_at\": \"0000-00-00 00:00:00\",\n \"updated_at\": \"2026-02-25 12:00:20\",\n \"iso_countries\": \"\",\n \"barcode\": \"Default\",\n \"address\": false\n}"}],"_postman_id":"5e4663d7-dabb-43b3-9fcb-6d9c97c37cdd"},{"name":"Create Location","id":"ec14681f-9c9a-43bd-a539-9ca85c3c9bc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n // ----- For a CHILD location (bin / shelf inside a warehouse) -----\n \"warehouse_id\": 6, // the parent warehouse's location ID — REQUIRED for children\n \"type_id\": 5, // location type ID (5 = bin in default seed)\n \"parent_location_id\": 1, // optional direct parent for hierarchical layouts\n \"location_name\": \"A-101-200\", // REQUIRED display name\n \"barcode\": \"A-101-200\", // optional scannable barcode\n \"allow_negative\": false, // bool, default false\n \"pickable\": true, // bool, default true\n \"on_hand_stock\": true, // bool, default true\n \"priority\": 1000, // int, default 1\n\n // ----- Optional address blocks (creates address records linked to the location) -----\n \"shipment_address\": {\n \"company_name\": \"\",\n \"line_one\": \"\",\n \"line_two\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"country\": \"\",\n \"postcode\": \"\",\n \"iso\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"vat_number\": \"\",\n \"company_number\": \"\",\n \"eori_number\": \"\",\n \"xeori_number\": \"\"\n },\n \"invoice_address\": null // same shape as shipment_address; or null to skip\n\n // ----- For a ROOT WAREHOUSE -----\n // Omit warehouse_id (or send null), set type_id to the warehouse type ID, and supply a unique location_name.\n // Example: { \"type_id\": 4, \"location_name\": \"Branch Warehouse\", \"barcode\": \"WH-2\", \"priority\": 1, \"pickable\": true, \"on_hand_stock\": true }\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/locations/create","description":"Creates a new location. Use this for both root warehouses and child bins/shelves.
\nNot available to fulfilment-client users.
\ntype_id must be a valid location type — invalid IDs return 422.location_name.The created location record.
Updates an existing location. Send only the fields you want to change.
\nNot available to fulfilment-client users.
\nAll optional. Same set as Create Location (minus the address blocks). Empty values are ignored.
\nwarehouse_id must reference a valid WAREHOUSE_TYPE record.The updated location record.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["location","purchase_order_id","update"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"72bf6355-82f4-4116-88b9-ec6f02c23a87","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"location_name\": \"A-101-200 (renamed)\",\n \"barcode\": \"A-101-200\",\n \"priority\": 900,\n \"pickable\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/location/purchase_order_id/update","description":"Updates an existing location. Send only the fields you want to change.\n\n### Permissions\nNot available to fulfilment-client users.\n\n### Body fields\nAll optional. Same set as **Create Location** (minus the address blocks). Empty values are ignored.\n\n### Constraints\n- Cannot move a warehouse under another warehouse.\n- The new `warehouse_id` must reference a valid `WAREHOUSE_TYPE` record.\n\n### Response\nThe updated location record.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 80,\n \"type_id\": 5,\n \"parent_location_id\": 1,\n \"legacy_id\": null,\n \"location_name\": \"POSTMAN-G3-BIN-UPDATED\",\n \"priority\": 900,\n \"pickable\": true,\n \"allow_box_splitting\": 1,\n \"allow_negative\": 0,\n \"on_hand_stock\": 1,\n \"warehouse_id\": 6,\n \"deleted\": 0,\n \"deleted_at\": null,\n \"pm_plugin_capacity_type\": 2,\n \"pm_plugin_capacity_value\": 1,\n \"pm_plugin_current_capacity\": 0,\n \"pm_plugin_allow_mixed_products\": 1,\n \"pm_plugin_not_in_use\": 0,\n \"pm_plugin_has_mixed_product\": 0,\n \"created_at\": \"2026-04-30 13:15:59\",\n \"updated_at\": \"2026-04-30 13:16:00\",\n \"iso_countries\": \"\",\n \"barcode\": \"POSTMAN-G3-BIN-V2\"\n}"}],"_postman_id":"5a74e138-632e-4740-94a7-a5e3dfbc7efb"},{"name":"Delete Location","id":"f99f10b7-1b2e-4b5c-9491-5ce5942d32cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://your-company.myhelm.app/public-api/location/purchase_order_id/delete","description":"Soft-deletes a location.
\nNot available to fulfilment-client users.
\nstock_level_available across inventory; otherwise an error is returned.{ \"id\": <location_id> }\nManage warehouse locations — both root warehouses and bins/shelves inside them. Locations form a tree via parent_location_id; the root of each tree is a WAREHOUSE_TYPE location.
The location-create / -update / -delete endpoints are not available to fulfilment-client users (Not available to fulfilment-client users). The list and detail endpoints are available, but for fulfilment-client users they're auto-scoped to locations the client is linked to.
Returns a paginated list of purchase orders.
\npage (default 1). Page size is fixed by tenant settings.
List envelope. Each data[] item is a PO summary with supplier metadata, totals, status, and custom_fields.
One of: name_az | name_za | totalpaid_hl | totalpaid_lh | createdat_pr. Default: created_at descending.
LIKE-search on PO ID, supplier name/email, and shipping/invoice postcodes.
\n","type":"text/plain"},"key":"filters[search]","value":""},{"disabled":true,"description":{"content":"Two unix timestamps joined by a comma. Filters on created_at.
PO status ID. See folder description.
\n","type":"text/plain"},"key":"filters[status][]","value":"13"},{"disabled":true,"description":{"content":"PO tag name. Send multiple times for OR.
\n","type":"text/plain"},"key":"filters[order_tags][]","value":""},{"disabled":true,"description":{"content":"Return only POs containing this inventory ID.
\n","type":"text/plain"},"key":"filters[inventory_id]","value":""},{"disabled":true,"description":{"content":"Fulfilment client ID.
\n","type":"text/plain"},"key":"filters[fulfilment_clients][]","value":""}],"variable":[]}},"response":[{"id":"08316b79-6884-4ec7-8033-850ef44c232f","name":"200 — page of POs","originalRequest":{"method":"GET","header":[],"url":"https://your-company.myhelm.app/public-api/purchase_orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"total\": 2,\n \"per_page\": \"100\",\n \"current_page\": 1,\n \"last_page\": 1,\n \"data\": [\n {\n \"id\": 2,\n \"location_id\": 6,\n \"purchase_order_id\": \"PO-28939\",\n \"status_id\": 11,\n \"supplier_id\": 5779,\n \"shipping_name_company\": \"Supplier Company\",\n \"shipping_address_postcode\": \"AB15 4DL\",\n \"shipping_address_iso\": \"GB\",\n \"invoice_name_company\": \"Supplier Invoice Company\",\n \"custom_fields\": {}\n }\n ]\n}"}],"_postman_id":"a3f53a7e-63ff-46d8-a0aa-da5c2221371a"},{"name":"Get Purchase Order Detail","id":"ff7874ab-7215-4d98-8a1f-5372690c4cbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-company.myhelm.app/public-api/purchase_order/purchase_order_delivery_id","description":"Returns the full PO record including line items (inventory[]) and custom_fields. Returns 404 if the PO doesn't exist.
Creates a new purchase order in Draft status (status_id = 11).
payment_currency is taken from the supplier or the tenant default.The created PO record with status_description and custom_fields. Address blocks (shipping/invoice/supplier) are pre-filled from the supplier contact and the warehouse record.
Updates a purchase order. Send only the fields you want to change.
\nAll optional:
\nstatus_id — see PO status enum in folder description.location_id — must be a valid WAREHOUSE_TYPE location.payment_currency, description, expected_delivery_date.supplier_email, supplier_email_cc_1, supplier_email_cc_2, phone_one, phone_two.shipping_address_line_one/two, shipping_address_city, shipping_address_county, shipping_address_country, shipping_address_postcode, shipping_address_iso.custom_fields — object.location_id, if sent, must be a non-null valid warehouse the user has access to. null is rejected.The updated PO record.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["purchase_order","purchase_order_delivery_id","update"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"854cff9a-e861-43ff-9899-f2f397c37af3","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status_id\": 13,\n \"description\": \"\",\n \"expected_delivery_date\": \"2026-05-20\",\n \"supplier_email\": \"sales@supplier.com\",\n \"phone_one\": \"\",\n \"phone_two\": \"\",\n\n \"shipping_address_line_one\": \"\",\n \"shipping_address_postcode\": \"\",\n\n \"invoice_address_line_one\": \"\",\n \"invoice_address_postcode\": \"\",\n\n \"custom_fields\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/purchase_order/purchase_order_delivery_id/update","description":"Updates a purchase order. Send only the fields you want to change.\n\n### Body fields\nAll optional:\n- `status_id` — see PO status enum in folder description.\n- `location_id` — must be a valid `WAREHOUSE_TYPE` location.\n- `payment_currency`, `description`, `expected_delivery_date`.\n- `supplier_email`, `supplier_email_cc_1`, `supplier_email_cc_2`, `phone_one`, `phone_two`.\n- Supplier contact info: company / name fields.\n- Shipping address fields: `shipping_address_line_one/two`, `shipping_address_city`, `shipping_address_county`, `shipping_address_country`, `shipping_address_postcode`, `shipping_address_iso`.\n- Invoice address fields: same shape as shipping.\n- `custom_fields` — object.\n\n### Constraints\n- `location_id`, if sent, must be a non-null valid warehouse the user has access to. `null` is rejected.\n\n### Response\nThe updated PO record.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 4,\n \"location_id\": 6,\n \"purchase_order_id\": \"POSTMAN-G4-PO-TEST\",\n \"description\": \"Updated PO description from Postman test\",\n \"status_id\": 13,\n \"supplier_id\": 5779,\n \"dropship_order_id\": null,\n \"dropship_tracking_code\": null,\n \"dropship_tracking_url\": null,\n \"fulfilment\": 0,\n \"fulfilment_client_id\": null,\n \"shipping_name_company\": \"Hidayet's Shipment Company\",\n \"shipping_name\": \"\",\n \"shipping_address_line_one\": \"Flat 11\",\n \"shipping_address_line_two\": \"22 King's Gate\",\n \"shipping_address_city\": \"Aberdeen\",\n \"shipping_address_county\": \"\\u0130zmir\",\n \"shipping_address_country\": \"United Kingdom\",\n \"shipping_address_postcode\": \"AB15 4DL\",\n \"shipping_address_iso\": \"GB\",\n \"shipping_phone_number\": \"05555555555\",\n \"invoice_name_company\": \"Hidayet's Invoice Company\",\n \"invoice_name\": \"\",\n \"invoice_address_line_one\": \"Apartment 11\",\n \"invoice_address_line_two\": \"22 Legge Lane\",\n \"invoice_address_city\": \"Birmingham\",\n \"invoice_address_county\": \"\\u0130zmir\",\n \"invoice_address_country\": \"United Kingdom\",\n \"invoice_address_postcode\": \"B1 3LW\",\n \"invoice_address_iso\": \"GB\",\n \"invoice_phone_number\": \"05555555555\",\n \"supplier_email\": \"updated-supplier@example.com\",\n \"supplier_email_cc_1\": \"Hidayet.Arasan@thedespatchcompany.com\",\n \"supplier_email_cc_2\": \"Hidayet.Arasan@thedespatchcompany.com\",\n \"supplier_name\": \"Hidayet Arasan\",\n \"supplier_name_company\": \"Hidayet Arasan\",\n \"supplier_address_line_one\": \"1 Sandwash Business Park\",\n \"supplier_address_line_two\": \"Sandwash Close Rainford\",\n \"supplier_address_city\": \"St. Helens\",\n \"supplier_address_county\": \"\",\n \"supplier_address_country\": \"United Kingdom\",\n \"supplier_address_postcode\": \"WA11 8SZ\",\n \"supplier_address_iso\": \"\",\n \"phone_one\": \"+44 99 999 9999\",\n \"phone_two\": null,\n \"deleted\": 0,\n \"tax_paid\": \"0.0000\",\n \"total_paid\": \"97.5000\",\n \"payment_currency\": \"GBP\",\n \"account_number\": null,\n \"po_notes\": null,\n \"delivery_instructions\": null,\n \"user_id\": 4,\n \"custom_fields\": {},\n \"expected_delivery_date\": \"2026-05-25\",\n \"submitted_at\": \"2026-04-30 13:18:57\",\n \"completed_at\": null,\n \"average_delivery_date\": null,\n \"overall_deviation\": 1,\n \"is_printed\": 0,\n \"sent_to_supplier_by\": null,\n \"is_bopis\": 0,\n \"is_processing\": 0,\n \"created_at\": \"2026-04-30 13:18:32\",\n \"updated_at\": \"2026-04-30 13:18:57\",\n \"po_completed_email_status\": 0,\n \"status_description\": \"Submitted\"\n}"}],"_postman_id":"053ceba0-63a0-4a4e-ae10-8d550829edcb"},{"name":"Delete Purchase Order","id":"afdc5586-e811-4ccc-8aa2-ce71c6e9f619","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://your-company.myhelm.app/public-api/purchase_order/purchase_order_delivery_id/delete","description":"Soft-deletes a purchase order.
\n15) or Partially Completed (14) status — 422.{ \"id\": <po_id> }\nAdds one or more line items to a purchase order.
\nEach inventory item must be linked to the same supplier as the purchase order before it can be added. If a SKU is not linked to the PO's supplier, the response is partial_success with a per-item error: \"You cannot add a product to a purchase order that is not supplied by the same supplier as the product.\"
Use Inventory → Suppliers → Add Supplier on the SKU first (passing the PO's supplier_id), then retry the add.
{\n \"status\": \"success\" | \"partial_success\" | \"fail\",\n \"result\": {\n \"items\": [ ...created lines... ],\n \"errors\": [ { \"input\": {...}, \"error\": \"...\" } ]\n }\n}\nPO totals are recalculated automatically.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["purchase_order","purchase_order_delivery_id","add_inventory"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"7af3b5ab-8985-457b-a252-8b2824958ccf","name":"200 — partial_success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"items\":[{\"inventory_id\":744,\"sku\":\"API-TEST-001\",\"name\":\"API Test Product\",\"quantity\":100,\"unit_price\":5.00}]}"},"url":"https://your-company.myhelm.app/public-api/purchase_order/3/add_inventory"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"partial_success\",\n \"result\": {\n \"items\": [],\n \"errors\": [\n {\n \"input\": {\n \"inventory_id\": 744,\n \"sku\": \"API-TEST-001\",\n \"name\": \"API Test Product\",\n \"quantity\": 100,\n \"unit_price\": 5\n },\n \"error\": \"You cannot add a product to a purchase order that is not supplied by the same supplier as the product.\"\n }\n ]\n }\n}"}],"_postman_id":"1a0721b9-8edc-46f4-9568-556dedb14db4"},{"name":"Update PO Inventory Item","id":"c2fde7f3-1d46-4cae-b49d-7c1b4c7b394b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"purchase_order_inventory_id\": 100,\n \"quantity\": 150,\n \"unit_price\": 0.45,\n \"line_total_discount\": 0.00,\n \"notes\": \"Updated\",\n \"expected_delivery_date\": \"2026-05-20\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/purchase_order/purchase_order_delivery_id/update_inventory","description":"Updates a single PO line item.
\npurchase_order_inventory_id (int, required).inventory_id, name, sku, vendor_sku, quantity, unit_price, line_total_discount, notes, expected_delivery_date (all optional).is_delivered = 1) — 422.The updated line item record. PO totals are recalculated.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["purchase_order","purchase_order_delivery_id","update_inventory"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"77cc9a54-b4c6-4ca0-adaa-f1c83efb5b2f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"purchase_order_inventory_id\": 100,\n \"quantity\": 150,\n \"unit_price\": 0.45,\n \"line_total_discount\": 0.00,\n \"notes\": \"Updated\",\n \"expected_delivery_date\": \"2026-05-20\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/purchase_order/purchase_order_delivery_id/update_inventory","description":"Updates a single PO line item.\n\n### Body fields\n- `purchase_order_inventory_id` (int, required).\n- `inventory_id`, `name`, `sku`, `vendor_sku`, `quantity`, `unit_price`, `line_total_discount`, `notes`, `expected_delivery_date` (all optional).\n\n### Constraints\n- The line cannot be updated once it has been delivered (`is_delivered = 1`) — `422`.\n\n### Response\nThe updated line item record. PO totals are recalculated.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 5,\n \"purchase_order_summary_id\": 4,\n \"inventory_id\": 1,\n \"is_delivered\": 0,\n \"quantity\": 200,\n \"delivered_quantity\": 0,\n \"remaining_quantity\": 150,\n \"unit_price\": 0.45,\n \"price\": 90,\n \"discount\": \"0.0000\",\n \"line_total_discount\": 0.5,\n \"sku\": \"ha_product_test_1\",\n \"name\": \"HA Product Test - 1 - line 2\",\n \"vendor_sku\": null,\n \"notes\": \"Updated by Postman\",\n \"expected_delivery_date\": \"2026-05-25\",\n \"delivered_at\": null,\n \"created_at\": \"2026-04-30 13:18:33\",\n \"updated_at\": \"2026-04-30 12:18:33\"\n}"}],"_postman_id":"c2fde7f3-1d46-4cae-b49d-7c1b4c7b394b"},{"name":"Remove PO Inventory Item","id":"a392b30f-628c-42f0-abb7-d3bd6ab15174","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"purchase_order_inventory_id\": 100\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/purchase_order/purchase_order_delivery_id/remove_inventory","description":"Removes a PO line item.
\npurchase_order_inventory_id (int, required).422.{ \"id\": <line_id> }\nRecords a goods-in delivery against a PO. Increments stock at the receiving location, creates stock-transaction logs, and updates the PO's delivery progress (transitions to Partially Completed or Completed).
13) or Partially Completed (14).batch_data is required with batch_values[].1.The created purchase_order_delivery record.
Bulk variant of Create PO Delivery — receive across multiple POs in a single call. Each entry follows the same shape as the single-PO endpoint, with the addition of purchase_order_id to identify which PO each entry belongs to.
Processed delivery results, per delivery.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["purchase_order","create_deliveries"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"44eba543-31af-49fe-910f-d6e6be8d4782","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"deliveries\": [\n {\n \"purchase_order_id\": 1,\n \"purchase_order_inventory_id\": [101],\n \"quantity\": [50],\n \"reference\": \"GRN-001\",\n \"delivered_at_all\": \"2026-04-30\",\n \"location_id_all\": 1\n },\n {\n \"purchase_order_id\": 2,\n \"purchase_order_inventory_id\": [102],\n \"quantity\": [30],\n \"reference\": \"GRN-002\",\n \"delivered_at_all\": \"2026-04-30\",\n \"location_id_all\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/purchase_order/create_deliveries","description":"Bulk variant of **Create PO Delivery** — receive across multiple POs in a single call. Each entry follows the same shape as the single-PO endpoint, with the addition of `purchase_order_id` to identify which PO each entry belongs to.\n\n### Response\nProcessed delivery results, per delivery.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"delivery_list\": [],\n \"warning_list\": []\n}"}],"_postman_id":"ca4efdb3-a1d6-4566-b970-c71c60dd0e9f"},{"name":"List PO Deliveries","id":"160cd408-95c2-4afd-bbaa-1b428d363d43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-company.myhelm.app/public-api/purchase_order_deliveries?page=1","description":"Returns a paginated list of all PO deliveries (goods-in records) across all POs. Each entry embeds delivery_inventory[] with nested inventory[] references back to the source PO line items.
Search by parent PO ID.
\n","type":"text/plain"},"key":"filters[search]","value":""},{"disabled":true,"description":{"content":"Two unix timestamps comma-joined. Filters on delivered_at.
Two unix timestamps comma-joined. Filters on created_at.
Returns a single PO delivery with delivery_inventory[] and nested PO line item references.
Returns every internal note attached to a PO.
\nArray of purchase_orders_notes records: { id, purchase_order_summary_id, note, user_id, created_at }.
Adds an internal note to a PO.
\nnote (string, required, non-empty).The created note record.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["purchase_order","purchase_order_delivery_id","add_note"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"f71e71e8-7f24-4ac7-9c37-315f54c82b2b","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note\": \"Supplier confirmed shipment will arrive next week.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/purchase_order/purchase_order_delivery_id/add_note","description":"Adds an internal note to a PO.\n\n### Body field\n- `note` (string, required, non-empty).\n\n### Response\nThe created note record.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"purchase_order_summary_id\": 4,\n \"user_id\": \"4\",\n \"note\": \"Supplier confirmed shipment will arrive next week.\",\n \"created_at\": \"2026-04-30 13:19:09\"\n}"}],"_postman_id":"74a5dc09-86ed-41af-ab7d-d4dfbcdb5008"},{"name":"Delete PO Note","id":"26936f06-e280-4050-b9bc-809c78d8ee79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://your-company.myhelm.app/public-api/purchase_order/purchase_order_delivery_id/notes/{{note_id}}","description":"Deletes a single PO note. The note must belong to the named PO; otherwise 422.
{ \"id\": <note_id> }\nManage purchase orders (POs) — supplier ordering documents that track inventory coming into the warehouse, plus the deliveries (goods-in records) that fulfil them.
\nstatus_id referenceDeliveries can only be recorded against POs in Submitted (13) or Partially Completed (14) status.
\n","_postman_id":"d5021889-533f-4ae6-9d6b-6b0fc82195fa","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}}},{"name":"Purchase Order Tags","item":[{"name":"List PO Tags","id":"ed4a31f3-c854-4353-818e-9d9eab4c3df5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-company.myhelm.app/public-api/purchase_order_tags?page=1","description":"Returns each distinct tag with its PO count.
\nList envelope. Each data[] item is { tag, purchase_order_count }.
One of: name_az | name_za. Default: tag A→Z.
LIKE-search on tag name.
\n","type":"text/plain"},"key":"filters[search]","value":""}],"variable":[]}},"response":[{"id":"7edb1be4-f4d4-444d-a2be-67d2bd210c72","name":"200 — page of tags","originalRequest":{"method":"GET","header":[],"url":"https://your-company.myhelm.app/public-api/purchase_order_tags"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"total\": \"1\",\n \"per_page\": \"100\",\n \"current_page\": 1,\n \"last_page\": 1,\n \"data\": [\n { \"tag\": \"Under Delivered\", \"purchase_order_count\": \"2\" }\n ]\n}"}],"_postman_id":"ed4a31f3-c854-4353-818e-9d9eab4c3df5"},{"name":"Get PO Tag Detail","id":"51ec5a43-0a9f-4087-a6ab-20fb65fe96ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-company.myhelm.app/public-api/purchase_order_tags/","description":"Returns a single tag and the number of POs that carry it.
\n{ \"id\": <int>, \"tag\": \"<name>\", \"purchase_order_count\": <int> }\nAttaches a tag to a PO. Idempotent — returns the existing record if the tag is already attached.
\nThe attachment record.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["purchase_order_tags","","attach","purchase_order_delivery_id"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"395cf8bf-45c1-459f-8f40-63c75d1a2858","name":"Success","originalRequest":{"method":"POST","header":[],"url":"https://your-company.myhelm.app/public-api/purchase_order_tags//attach/purchase_order_delivery_id","description":"Attaches a tag to a PO. Idempotent — returns the existing record if the tag is already attached.\n\n### Constraints\n- Tag must be at least 3 alphanumeric characters.\n- PO must exist.\n\n### Response\nThe attachment record.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 4,\n \"purchase_order_summary_id\": 4,\n \"tag\": \"POSTMAN-PO-TEST-TAG\",\n \"created_at\": \"2026-04-30 13:19:10\",\n \"updated_at\": \"2026-04-30 13:19:10\"\n}"}],"_postman_id":"0acac6a0-af82-4b05-b759-5622e96b6256"},{"name":"Detach Tag from PO","id":"792f393e-71e9-4ee4-b476-d1dfad5aa1f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://your-company.myhelm.app/public-api/purchase_order_tags//detach/purchase_order_delivery_id","description":"Removes a tag attachment from a single PO.
\nThe deleted attachment record.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["purchase_order_tags","","detach","purchase_order_delivery_id"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"6a78ffd8-0e91-472d-a095-47c348104927","name":"Success","originalRequest":{"method":"POST","header":[],"url":"https://your-company.myhelm.app/public-api/purchase_order_tags//detach/purchase_order_delivery_id","description":"Removes a tag attachment from a single PO.\n\n### Response\nThe deleted attachment record.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 4,\n \"purchase_order_summary_id\": 4,\n \"tag\": \"POSTMAN-PO-TEST-TAG\",\n \"created_at\": \"2026-04-30 13:19:10\",\n \"updated_at\": \"2026-04-30 13:19:10\"\n}"}],"_postman_id":"792f393e-71e9-4ee4-b476-d1dfad5aa1f3"},{"name":"Delete PO Tag (Everywhere)","id":"100abb9c-49dc-4bae-87a9-eda5500a6ff5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://your-company.myhelm.app/public-api/purchase_order_tags//delete","description":"Removes the tag from every PO that carries it. Use with care — this is a global operation.
\n{ \"tag\": <tag object> }\nFree-text tags that group purchase orders. Same model as Order Tags — tags are derived from attachments, so they exist as long as at least one PO carries them. Tags must be at least 3 alphanumeric characters when attached.
\n","_postman_id":"ae10156c-23a7-46ea-bd04-4bae6217b9f5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}}},{"name":"Shipments","item":[{"name":"List Shipments","id":"0c6cb73d-fb8b-4387-bb34-cf4b9864b20b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-company.myhelm.app/public-api/shipments?page=1&per_page=20","description":"Returns a paginated list of outbound shipping labels. Return labels are excluded — query the order detail to see return shipments.
\nFulfilment-client users see only their own client's shipments.
\nList envelope of shipment records with courier, tracking, weight, cost, status and label-fetch flags.
Default tenant setting.
\n","type":"text/plain"},"key":"per_page","value":"20"},{"disabled":true,"description":{"content":"One of: total_value_hl | total_value_lh | created_at_pr | created_at_rp | updated_at_pr | updated_at_rp. Default: created_at descending.
Free-text search. Pair with filters[search_field] to scope. Single pipe | between terms ORs them.
One of: auto | search_order_id | search_shipping_name | search_shipping_email | search_shipping_postcode | search_shipping_country | search_shipping_iso | search_shipping_tracking_code | search_shipping_courier | search_shipping_request_id | search_dc_code.
Two unix timestamps comma-joined. Filters on created_at.
Two unix timestamps comma-joined. Filters on updated_at.
0 = active labels only, 1 = cancelled labels only.
Match on the parent channel_order_id (LIKE) or internal order ID (exact).
Returns a single shipment with embedded order print-process metadata, parcel details, the user/fulfilment client info, and any related return-label shipments.
\nFull shipment record plus:
order_print_process — embedded with merge/split metadata.pd_options[] — per-parcel detail (decoded from JSON), each containing the inventory packed in the parcel.user_name, user_id, fulfilment_client_name, fulfilment_client_id.return_shipments[] — any return labels generated against this shipment.Returns 404 if the shipment doesn't exist or the user is not authorised.
Generates a shipping label for an order, automatically packing its inventory into parcels and resolving courier-specific configuration.
\nshipping_informations.*) or substitute a different courier service from the one configured for the order.shipping_informations fieldsThe API takes the order's allocated inventory, groups it into parcels using the cartonisation engine (respecting per-SKU package configurations and per-courier weight/dimension limits), and emits one or more parcels per shipment. Each parcel auto-includes:
\ninventory_id, quantity, weight, p_length / p_width / p_height, HS code, country of origin)Where SKU dimensions are missing, the system falls back to the tenant defaults: DEFAULT_ITEM_LENGTH, DEFAULT_ITEM_WIDTH, DEFAULT_ITEM_HEIGHT, DEFAULT_ITEM_WEIGHT.
shipment record is created and linked to the order.5).{\n \"success\": true,\n \"shipment_id\": <int>,\n \"process_ref\": <int>,\n \"courier_service_name\": \"<string>\",\n \"sort_reference\": \"<string>\",\n \"package_weight\": <float>,\n \"package_value\": <float>,\n \"shipping_label\": \"<base64 or URL>\",\n \"shipping_label_type\": \"pdf\" | \"zpl\" | ...,\n \"shipping_tracking_code\": \"<string>\",\n \"shipping_tracking_urls\": [\"<url>\"],\n \"request_id\": \"<unique request id>\"\n}\n422 — order not eligible (status / allocation / inventory empty), courier service not found, currency mismatch, missing required address fields.Voids a previously-booked label and resets the order back to Despatch Ready (status_id = 3).
shipment_id (int, required).5) or Despatch Pending (2700).manifested = 0).<filename>_cancelled_{shipment_id}.pdf for audit.3.{\n \"message\": \"Label has been successfully canceled and the order has been reset.\",\n \"shipment_id\": <int>,\n \"order_id\": <int>\n}\nEndpoints for booking, listing, retrieving, and cancelling shipping labels. Shipments are anchored to a single order via order_summary_id and carry the courier, parcel, and tracking metadata for despatch.
Returns a paginated list of registered couriers (carriers).
\npage (default 1). Page size is fixed by tenant settings.
Fixed: created_at descending.
List envelope. Each data[] item is a courier record with platform, name, company_name, test_account, data (JSON config), is_smart_shipping.
Free-text search. Pair with filters[search_field]. Single pipe | between terms.
One of: auto | platform | name | company_name.
Filter by test-account flag. Send array form for OR (filters[test-account][]=0&filters[test-account][]=1).
Returns a paginated list of courier services (the actual sellable shipping options under each courier).
\nEach data[] item includes id, name, enabled, config (decoded JSON), courier_id, local_tracking, local_tracking_url, print_packing_list, print_gift_note_label, label_reference, reference_2, sort_reference, is_bbx, use_third_party_insurance, plus an embedded courier object for the parent courier.
LIKE-search on service name. Single pipe | between terms.
Filter by enabled flag (1 or 0). Array form for OR.
Filter by parent courier ID. Array form for OR.
\n","type":"text/plain"},"key":"filters[courier_id]","value":""}],"variable":[]}},"response":[{"id":"1d97ecc7-3253-42d6-9a03-14f738e53a3e","name":"200 — page of services","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://your-company.myhelm.app/public-api/couriers/services?page=1","host":["https://your-company.myhelm.app/public-api"],"path":["couriers","services"],"query":[{"key":"page","value":"1"},{"key":"filters[search]","value":"","description":"LIKE-search on service name. Single pipe `|` between terms.","disabled":true},{"key":"filters[enabled]","value":"1","description":"Filter by `enabled` flag (`1` or `0`). Array form for OR.","disabled":true},{"key":"filters[courier_id]","value":"","description":"Filter by parent courier ID. Array form for OR.","disabled":true}]},"description":"Returns a paginated list of courier services (the actual sellable shipping options under each courier).\n\n### Response\nEach `data[]` item includes `id`, `name`, `enabled`, `config` (decoded JSON), `courier_id`, `local_tracking`, `local_tracking_url`, `print_packing_list`, `print_gift_note_label`, `label_reference`, `reference_2`, `sort_reference`, `is_bbx`, `use_third_party_insurance`, plus an embedded `courier` object for the parent courier.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 5,\n \"per_page\": \"100\",\n \"current_page\": 1,\n \"last_page\": 1,\n \"next_page_url\": null,\n \"prev_page_url\": null,\n \"from\": 0,\n \"to\": 100,\n \"data\": [\n {\n \"id\": \"4\",\n \"name\": \"SmartGroupOne\",\n \"enabled\": \"1\",\n \"config\": null,\n \"courier_id\": \"2\",\n \"local_tracking\": \"0\",\n \"print_packing_list\": \"0\",\n \"print_gift_note_label\": \"0\",\n \"local_tracking_url\": \"\",\n \"label_reference\": \"0\",\n \"reference_2\": \"0\",\n \"sort_reference\": null,\n \"is_bbx\": \"0\",\n \"use_third_party_insurance\": \"0\",\n \"created_at\": \"2026-03-31 16:07:16\",\n \"updated_at\": \"2026-04-29 16:27:19\",\n \"courier\": {\n \"id\": 2,\n \"platform\": \"smart-shipping\",\n \"name\": \"Smart Shipping\",\n \"company_name\": \"\",\n \"test_account\": 0,\n \"data\": {\n \"active\": 1\n },\n \"is_smart_shipping\": 1,\n \"created_at\": \"2026-03-30 16:06:19\",\n \"updated_at\": \"2026-03-30 16:06:19\"\n }\n },\n {\n \"id\": \"5\",\n \"name\": \"Smart Rule One\",\n \"enabled\": \"1\",\n \"config\": null,\n \"courier_id\": \"2\",\n \"local_tracking\": \"0\",\n \"print_packing_list\": \"0\",\n \"print_gift_note_label\": \"0\",\n \"local_tracking_url\": \"\",\n \"label_reference\": \"0\",\n \"reference_2\": \"0\",\n \"sort_reference\": null,\n \"is_bbx\": \"0\",\n \"use_third_party_insurance\": \"0\",\n \"created_at\": \"2026-03-31 16:07:16\",\n \"updated_at\": \"2026-04-29 16:27:19\",\n \"courier\": {\n \"id\": 2,\n \"platform\": \"smart-shipping\",\n \"name\": \"Smart Shipping\",\n \"company_name\": \"\",\n \"test_account\": 0,\n \"data\": {\n \"active\": 1\n },\n \"is_smart_shipping\": 1,\n \"created_at\": \"2026-03-30 16:06:19\",\n \"updated_at\": \"2026-03-30 16:06:19\"\n }\n },\n {\n \"id\": \"6\",\n \"name\": \"Smart Rule Two\",\n \"enabled\": \"1\",\n \"config\": null,\n \"courier_id\": \"2\",\n \"local_tracking\": \"0\",\n \"print_packing_list\": \"0\",\n \"print_gift_note_label\": \"0\",\n \"local_tracking_url\": \"\",\n \"label_reference\": \"0\",\n \"reference_2\": \"0\",\n \"sort_reference\": null,\n \"is_bbx\": \"0\",\n \"use_third_party_insurance\": \"0\",\n \"created_at\": \"2026-03-31 16:07:16\",\n \"updated_at\": \"2026-04-29 16:27:19\",\n \"courier\": {\n \"id\": 2,\n \"platform\": \"smart-shipping\",\n \"name\": \"Smart Shipping\",\n \"company_name\": \"\",\n \"test_account\": 0,\n \"data\": {\n \"active\": 1\n },\n \"is_smart_shipping\": 1,\n \"created_at\": \"2026-03-30 16:06:19\",\n \"updated_at\": \"2026-03-30 16:06:19\"\n }\n },\n {\n \"id\": \"7\",\n \"name\": \"Smart Rule Three\",\n \"enabled\": \"1\",\n \"config\": null,\n \"courier_id\": \"2\",\n \"local_tracking\": \"0\",\n \"print_packing_list\": \"0\",\n \"print_gift_note_label\": \"0\",\n \"local_tracking_url\": \"\",\n \"label_reference\": \"0\",\n \"reference_2\": \"0\",\n \"sort_reference\": null,\n \"is_bbx\": \"0\",\n \"use_third_party_insurance\": \"0\",\n \"created_at\": \"2026-03-31 16:07:16\",\n \"updated_at\": \"2026-04-29 16:27:19\",\n \"courier\": {\n \"id\": 2,\n \"platform\": \"smart-shipping\",\n \"name\": \"Smart Shipping\",\n \"company_name\": \"\",\n \"test_account\": 0,\n \"data\": {\n \"active\": 1\n },\n \"is_smart_shipping\": 1,\n \"created_at\": \"2026-03-30 16:06:19\",\n \"updated_at\": \"2026-03-30 16:06:19\"\n }\n },\n {\n \"id\": \"1\",\n \"name\": \"CustomIntegrationTestAccountService\",\n \"enabled\": \"1\",\n \"config\": null,\n \"courier_id\": \"1\",\n \"local_tracking\": \"0\",\n \"print_packing_list\": \"0\",\n \"print_gift_note_label\": \"0\",\n \"local_tracking_url\": \"\",\n \"label_reference\": \"0\",\n \"reference_2\": \"0\",\n \"sort_reference\": null,\n \"is_bbx\": \"0\",\n \"use_third_party_insurance\": \"0\",\n \"created_at\": \"2026-02-25 12:11:28\",\n \"updated_at\": \"2026-02-25 12:11:28\",\n \"courier\": {\n \"id\": 1,\n \"platform\": \"Test\",\n \"name\": \"CustomIntegrationTest\",\n \"company_name\": \"CustomIntegrationTestCompany\",\n \"test_account\": 0,\n \"data\": {\n \"active\": \"1\",\n \"collection_time\": \"19:00\",\n \"collection_days\": []\n },\n \"is_smart_shipping\": 0,\n \"created_at\": \"2026-02-25 12:10:49\",\n \"updated_at\": \"2026-02-25 12:11:03\"\n }\n }\n ]\n}"}],"_postman_id":"91122a5d-5cbf-4c0c-8dea-0750c7de50ce"}],"id":"aa0ddff4-ca8c-4b30-9b9a-ba54fa5d6aaf","description":"Read-only endpoints listing the carriers and courier services configured on the tenant. Use these to look up the courier_service_id you need for Shipments → Book Shipment or Orders → Despatch with Tracking Code.
Not available to fulfilment-client users — both endpoints return 401 Unauthorised for them.
Returns every sales channel — integrated and manual — visible to the user. Fulfilment-client users see only their own channels.
\nEach data[] item is a sales_channel record with config decoded into an object. The auto_sync_offset field is omitted (internal use); fulfilment_client_id is omitted for fulfilment-client users.
Search on name and type.
Channel type — manual, amazon, ebay, shopify, woocommerce, aerocommerce, etc.
0 = integrated channels only, 1 = manual channels only.
Filter by fulfilment client ID.
\n","type":"text/plain"},"key":"filters[fulfilment_client][]","value":""}],"variable":[]}},"response":[{"id":"ef44eb53-637b-4a38-809e-c9ba7233e080","name":"200 — page of channels","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://your-company.myhelm.app/public-api/sales_channels?page=1","host":["https://your-company.myhelm.app/public-api"],"path":["sales_channels"],"query":[{"key":"page","value":"1"},{"key":"filters[search]","value":"","description":"Search on `name` and `type`.","disabled":true},{"key":"filters[type][]","value":"","description":"Channel type — `manual`, `amazon`, `ebay`, `shopify`, `woocommerce`, `aerocommerce`, etc.","disabled":true},{"key":"filters[manual][]","value":"","description":"`0` = integrated channels only, `1` = manual channels only.","disabled":true},{"key":"filters[fulfilment_client][]","value":"","description":"Filter by fulfilment client ID.","disabled":true}]},"description":"Returns every sales channel — integrated and manual — visible to the user. Fulfilment-client users see only their own channels.\n\n### Response\nEach `data[]` item is a `sales_channel` record with `config` decoded into an object. The `auto_sync_offset` field is omitted (internal use); `fulfilment_client_id` is omitted for fulfilment-client users.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 17,\n \"per_page\": \"100\",\n \"current_page\": 1,\n \"last_page\": 1,\n \"next_page_url\": null,\n \"prev_page_url\": null,\n \"from\": 0,\n \"to\": 100,\n \"data\": [\n {\n \"id\": \"36\",\n \"chapi_id\": \"\",\n \"fulfilment_client_id\": \"1\",\n \"name\": \"Manual\",\n \"type\": \"manual\",\n \"config\": {\n \"send_to_accounts\": \"\",\n \"invoice_template\": \"a4.default.invoice.tpl\",\n \"auto_print_invoice_at_terminal\": \"\",\n \"company_logo\": \"\",\n \"company_name\": \"\",\n \"company_return_address\": \"\",\n \"company_info\": \"\",\n \"company_phone\": \"\",\n \"commercial_invoice_template\": \"a4.default.commercial_invoice.tpl\",\n \"sender_company\": \"\",\n \"sender_address_line_one\": \"\",\n \"sender_address_line_two\": \"\",\n \"sender_address_line_three\": \"\",\n \"sender_address_line_four\": \"\",\n \"sender_vat_number\": \"\",\n \"sender_eori_number\": \"\",\n \"sender_company_number\": \"\",\n \"sender_contact_number\": \"\",\n \"email_status\": \"0\",\n \"email_subject\": \"\",\n \"email_message\": \"\",\n \"feedback_email_status\": \"0\",\n \"feedback_email_subject\": \"\",\n \"feedback_email_message\": \"\",\n \"feedback_email_send_days\": \"\",\n \"fulfilment_client_id\": 1,\n \"company_return_address_id\": 0,\n \"sender_address_id\": 0\n },\n \"data\": \"\",\n \"accounting_channel_id\": \"0\",\n \"is_local\": \"1\",\n \"warehouse_id\": null,\n \"created_at\": \"2026-03-05 19:26:40\",\n \"updated_at\": \"2026-03-05 19:26:40\"\n },\n {\n \"id\": \"34\",\n \"chapi_id\": \"451ffee8-646d-41fa-9aaa-b9f5a38060f1\",\n \"fulfilment_client_id\": \"0\",\n \"name\": \"Hidayet Local Manual\",\n \"type\": \"manual\",\n \"config\": {\n \"id\": \"34\",\n \"fulfilment_client_id\": \"0\",\n \"warehouse_id\": \"6\",\n \"auto_despatch_pos\": \"1\",\n \"insufficient_stocks_order_status\": \"1\",\n \"received_timeout_status\": \"2\",\n \"received_timeout_period\": \"2\",\n \"international_tax_calculations\": \"1\",\n \"name\": \"Hidayet Local Manual\",\n \"inventory_names_usage\": \"internal\",\n \"company_name\": \"Hidayet's Company\",\n \"company_return_address_id\": \"0\",\n \"company_info\": \"\",\n \"company_phone\": \"\",\n \"invoice_template\": \"4x6.default.invoice.tpl\",\n \"cheat_sheet_template\": \"6x9.default.cheat_sheet.tpl\",\n \"groupon_template\": \"\",\n \"commercial_invoice_template\": \"a4.default.commercial_invoice.tpl\",\n \"auto_print_invoice_at_terminal\": \"0\",\n \"sender_address_id\": \"0\",\n \"email_status\": \"0\",\n \"email_subject\": \"\",\n \"bcc_email\": \"\",\n \"template_selection\": \"sales_channel_specific\",\n \"despatch_from_name\": \"\",\n \"despatch_from_address\": \"\",\n \"email_message\": \"16\",\n \"feedback_email_status\": \"0\",\n \"feedback_email_subject\": \"\",\n \"feedback_bcc_email\": \"\",\n \"feedback_from_name\": \"\",\n \"feedback_from_address\": \"\",\n \"feedback_email_send_days\": \"\"\n },\n \"data\": \"\",\n \"accounting_channel_id\": \"0\",\n \"is_local\": \"1\",\n \"warehouse_id\": \"6\",\n \"created_at\": \"2026-02-25 12:16:13\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": \"2\",\n \"chapi_id\": \"d912310d-b9cb-41b1-8ba4-72ed7c2569e8\",\n \"fulfilment_client_id\": null,\n \"name\": \"asd\",\n \"type\": \"woocommerce\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": \"0\",\n \"is_local\": \"0\",\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": \"3\",\n \"chapi_id\": \"add72c4f-5e58-405e-b77e-241da806f2fb\",\n \"fulfilment_client_id\": null,\n \"name\": \"asdasdasdas\",\n \"type\": \"aerocommerce\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": \"0\",\n \"is_local\": \"0\",\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": \"4\",\n \"chapi_id\": \"8788ac0f-cb99-4467-8cfc-c554bac9749f\",\n \"fulfilment_client_id\": null,\n \"name\": \"AmzTest\",\n \"type\": \"amazonsp\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": \"0\",\n \"is_local\": \"0\",\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": \"5\",\n \"chapi_id\": \"5b20e46c-6585-4c9d-a1d2-e2cf6de3de61\",\n \"fulfilment_client_id\": null,\n \"name\": \"AmzEasy\",\n \"type\": \"amazoneasyship\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": \"0\",\n \"is_local\": \"0\",\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": \"6\",\n \"chapi_id\": \"06d614e6-d724-4077-89ef-4778f5dd8feb\",\n \"fulfilment_client_id\": \"0\",\n \"name\": \"Wocommerce Original Account\",\n \"type\": \"woocommerce\",\n \"config\": {\n \"fulfilment_client_id\": \"0\",\n \"warehouse_id\": \"6\",\n \"auto_despatch_pos\": \"1\",\n \"insufficient_stocks_order_status\": \"3\",\n \"received_timeout_status\": \"2\",\n \"received_timeout_period\": \"2\",\n \"international_tax_calculations\": \"0\",\n \"name\": \"\",\n \"inventory_names_usage\": \"internal\",\n \"company_logo\": \"\",\n \"company_name\": \"\",\n \"company_return_address_id\": \"0\",\n \"company_info\": \"\",\n \"company_phone\": \"\",\n \"invoice_template\": \"4x6.default.invoice.tpl\",\n \"packing_sheet_template\": \"\",\n \"picking_sheet_template\": \"\",\n \"cheat_sheet_template\": \"6x9.default.cheat_sheet.tpl\",\n \"groupon_template\": \"\",\n \"commercial_invoice_template\": \"a4.default.commercial_invoice.tpl\",\n \"auto_print_invoice_at_terminal\": \"0\",\n \"sender_address_id\": \"0\",\n \"email_status\": \"0\",\n \"email_subject\": \"\",\n \"bcc_email\": \"\",\n \"template_selection\": \"sales_channel_specific\",\n \"despatch_from_name\": \"\",\n \"despatch_from_address\": \"\",\n \"email_message\": \"16\",\n \"feedback_email_status\": \"0\",\n \"feedback_email_subject\": \"\",\n \"feedback_bcc_email\": \"\",\n \"feedback_from_name\": \"\",\n \"feedback_from_address\": \"\",\n \"feedback_email_message\": \"\",\n \"feedback_email_send_days\": \"\"\n },\n \"data\": \"\",\n \"accounting_channel_id\": \"0\",\n \"is_local\": \"0\",\n \"warehouse_id\": \"6\",\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:31\"\n },\n {\n \"id\": \"7\",\n \"chapi_id\": \"115cfe6a-e03b-4cd9-ab27-93c9ca5a7357\",\n \"fulfilment_client_id\": null,\n \"name\": \"Shopify Original Account\",\n \"type\": \"shopify\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": \"0\",\n \"is_local\": \"0\",\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": \"8\",\n \"chapi_id\": \"962a0dcd-1152-48e0-94a7-735658390f69\",\n \"fulfilment_client_id\": null,\n \"name\": \"Manual Channel Test\",\n \"type\": \"manual\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": \"0\",\n \"is_local\": \"0\",\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": \"9\",\n \"chapi_id\": \"9f5086bf-79e8-48b1-a9d5-47468dbe9a62\",\n \"fulfilment_client_id\": null,\n \"name\": \"Manual\",\n \"type\": \"manual\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": \"0\",\n \"is_local\": \"0\",\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": \"10\",\n \"chapi_id\": \"8a0b4c9e-48af-4085-8365-342d77cca01c\",\n \"fulfilment_client_id\": null,\n \"name\": \"Manual - Hidayet Client\",\n \"type\": \"manual\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": \"0\",\n \"is_local\": \"0\",\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": \"11\",\n \"chapi_id\": \"b2489a24-4941-481a-98ce-e3793f0790e4\",\n \"fulfilment_client_id\": null,\n \"name\": \"Alpha Channel - Alpha Client\",\n \"type\": \"manual\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": \"0\",\n \"is_local\": \"0\",\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": \"12\",\n \"chapi_id\": \"15e447cd-ad91-438e-bc08-9f243e253a97\",\n \"fulfilment_client_id\": null,\n \"name\": \"Manualbetaaa - Beta Client\",\n \"type\": \"manual\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": \"0\",\n \"is_local\": \"0\",\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": \"13\",\n \"chapi_id\": \"ccd3f85e-3854-4980-b4b3-c284b96e534f\",\n \"fulfilment_client_id\": null,\n \"name\": \"Billing Client Channel - Billing Test\",\n \"type\": \"manual\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": \"0\",\n \"is_local\": \"0\",\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": \"14\",\n \"chapi_id\": \"889ed316-29ab-4dd9-a847-bc4412c57708\",\n \"fulfilment_client_id\": null,\n \"name\": \"fffffff\",\n \"type\": \"manual\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": \"0\",\n \"is_local\": \"0\",\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": \"15\",\n \"chapi_id\": \"ee48932b-4c65-42dc-a879-97b3b5723192\",\n \"fulfilment_client_id\": null,\n \"name\": \"Manual - asd\",\n \"type\": \"manual\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": \"0\",\n \"is_local\": \"0\",\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": \"16\",\n \"chapi_id\": \"468aa95b-dd6a-40df-8fa2-595ce60777a9\",\n \"fulfilment_client_id\": null,\n \"name\": \"Manual - aaaaaa\",\n \"type\": \"manual\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": \"0\",\n \"is_local\": \"0\",\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n }\n ]\n}"}],"_postman_id":"da77aa2d-56ff-4d15-ac7a-1655e1806630"},{"name":"Get Manual Channel Param Schema","id":"778a2247-ba87-4f1d-9406-bfdded8a2987","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-company.myhelm.app/public-api/sales_channels/params","description":"Returns the parameter schema you need to build / update a manual channel — sender and return address fields, their types, requiredness, and descriptions. Use this to dynamically render UI forms.
\nObject keyed by parameter name (e.g. sender_company_name, sender_line_one, sender_iso, return_company_name, return_iso, …). Every key has { type, required, description }.
Quick-create endpoint for a basic manual channel — only name + warehouse_id (+ optional fulfilment client). Use Create Manual Sales Channel instead if you also need to capture sender/return addresses (which is required to print labels from orders on the channel).
name (string, required).warehouse_id (int, required).fulfilment_client_id (int, optional).The created sales_channel record (minimal config).
Returns only manual channels (where is_local = 1). Same response shape as List Sales Channels (All).
Search on name and type (always manual here).
Filter by fulfilment client ID.
\n","type":"text/plain"},"key":"filters[fulfilment_client][]","value":""}],"variable":[]}},"response":[{"id":"f63d4cb7-f042-414d-a6a0-5bea00f24968","name":"200 — page of manual channels","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://your-company.myhelm.app/public-api/sales_channels/manual?page=1","host":["https://your-company.myhelm.app/public-api"],"path":["sales_channels","manual"],"query":[{"key":"page","value":"1"},{"key":"filters[search]","value":"","description":"Search on `name` and `type` (always `manual` here).","disabled":true},{"key":"filters[fulfilment_client][]","value":"","description":"Filter by fulfilment client ID.","disabled":true}]},"description":"Returns only manual channels (where `is_local = 1`). Same response shape as **List Sales Channels (All)**.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 11,\n \"per_page\": \"100\",\n \"current_page\": 1,\n \"last_page\": 1,\n \"next_page_url\": null,\n \"prev_page_url\": null,\n \"from\": 0,\n \"to\": 100,\n \"data\": [\n {\n \"id\": 36,\n \"chapi_id\": \"\",\n \"fulfilment_client_id\": 1,\n \"name\": \"Manual\",\n \"type\": \"manual\",\n \"config\": {\n \"send_to_accounts\": \"\",\n \"invoice_template\": \"a4.default.invoice.tpl\",\n \"auto_print_invoice_at_terminal\": \"\",\n \"company_logo\": \"\",\n \"company_name\": \"\",\n \"company_return_address\": \"\",\n \"company_info\": \"\",\n \"company_phone\": \"\",\n \"commercial_invoice_template\": \"a4.default.commercial_invoice.tpl\",\n \"sender_company\": \"\",\n \"sender_address_line_one\": \"\",\n \"sender_address_line_two\": \"\",\n \"sender_address_line_three\": \"\",\n \"sender_address_line_four\": \"\",\n \"sender_vat_number\": \"\",\n \"sender_eori_number\": \"\",\n \"sender_company_number\": \"\",\n \"sender_contact_number\": \"\",\n \"email_status\": \"0\",\n \"email_subject\": \"\",\n \"email_message\": \"\",\n \"feedback_email_status\": \"0\",\n \"feedback_email_subject\": \"\",\n \"feedback_email_message\": \"\",\n \"feedback_email_send_days\": \"\",\n \"fulfilment_client_id\": 1,\n \"company_return_address_id\": 0,\n \"sender_address_id\": 0\n },\n \"data\": \"\",\n \"accounting_channel_id\": 0,\n \"is_local\": 1,\n \"warehouse_id\": null,\n \"created_at\": \"2026-03-05 19:26:40\",\n \"updated_at\": \"2026-03-05 19:26:40\"\n },\n {\n \"id\": 34,\n \"chapi_id\": \"451ffee8-646d-41fa-9aaa-b9f5a38060f1\",\n \"fulfilment_client_id\": 0,\n \"name\": \"Hidayet Local Manual\",\n \"type\": \"manual\",\n \"config\": {\n \"id\": \"34\",\n \"fulfilment_client_id\": \"0\",\n \"warehouse_id\": \"6\",\n \"auto_despatch_pos\": \"1\",\n \"insufficient_stocks_order_status\": \"1\",\n \"received_timeout_status\": \"2\",\n \"received_timeout_period\": \"2\",\n \"international_tax_calculations\": \"1\",\n \"name\": \"Hidayet Local Manual\",\n \"inventory_names_usage\": \"internal\",\n \"company_name\": \"Hidayet's Company\",\n \"company_return_address_id\": \"0\",\n \"company_info\": \"\",\n \"company_phone\": \"\",\n \"invoice_template\": \"4x6.default.invoice.tpl\",\n \"cheat_sheet_template\": \"6x9.default.cheat_sheet.tpl\",\n \"groupon_template\": \"\",\n \"commercial_invoice_template\": \"a4.default.commercial_invoice.tpl\",\n \"auto_print_invoice_at_terminal\": \"0\",\n \"sender_address_id\": \"0\",\n \"email_status\": \"0\",\n \"email_subject\": \"\",\n \"bcc_email\": \"\",\n \"template_selection\": \"sales_channel_specific\",\n \"despatch_from_name\": \"\",\n \"despatch_from_address\": \"\",\n \"email_message\": \"16\",\n \"feedback_email_status\": \"0\",\n \"feedback_email_subject\": \"\",\n \"feedback_bcc_email\": \"\",\n \"feedback_from_name\": \"\",\n \"feedback_from_address\": \"\",\n \"feedback_email_send_days\": \"\"\n },\n \"data\": \"\",\n \"accounting_channel_id\": 0,\n \"is_local\": 1,\n \"warehouse_id\": 6,\n \"created_at\": \"2026-02-25 12:16:13\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": 8,\n \"chapi_id\": \"962a0dcd-1152-48e0-94a7-735658390f69\",\n \"fulfilment_client_id\": null,\n \"name\": \"Manual Channel Test\",\n \"type\": \"manual\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": 0,\n \"is_local\": 0,\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": 9,\n \"chapi_id\": \"9f5086bf-79e8-48b1-a9d5-47468dbe9a62\",\n \"fulfilment_client_id\": null,\n \"name\": \"Manual\",\n \"type\": \"manual\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": 0,\n \"is_local\": 0,\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": 10,\n \"chapi_id\": \"8a0b4c9e-48af-4085-8365-342d77cca01c\",\n \"fulfilment_client_id\": null,\n \"name\": \"Manual - Hidayet Client\",\n \"type\": \"manual\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": 0,\n \"is_local\": 0,\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": 11,\n \"chapi_id\": \"b2489a24-4941-481a-98ce-e3793f0790e4\",\n \"fulfilment_client_id\": null,\n \"name\": \"Alpha Channel - Alpha Client\",\n \"type\": \"manual\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": 0,\n \"is_local\": 0,\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": 12,\n \"chapi_id\": \"15e447cd-ad91-438e-bc08-9f243e253a97\",\n \"fulfilment_client_id\": null,\n \"name\": \"Manualbetaaa - Beta Client\",\n \"type\": \"manual\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": 0,\n \"is_local\": 0,\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": 13,\n \"chapi_id\": \"ccd3f85e-3854-4980-b4b3-c284b96e534f\",\n \"fulfilment_client_id\": null,\n \"name\": \"Billing Client Channel - Billing Test\",\n \"type\": \"manual\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": 0,\n \"is_local\": 0,\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": 14,\n \"chapi_id\": \"889ed316-29ab-4dd9-a847-bc4412c57708\",\n \"fulfilment_client_id\": null,\n \"name\": \"fffffff\",\n \"type\": \"manual\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": 0,\n \"is_local\": 0,\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": 15,\n \"chapi_id\": \"ee48932b-4c65-42dc-a879-97b3b5723192\",\n \"fulfilment_client_id\": null,\n \"name\": \"Manual - asd\",\n \"type\": \"manual\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": 0,\n \"is_local\": 0,\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n },\n {\n \"id\": 16,\n \"chapi_id\": \"468aa95b-dd6a-40df-8fa2-595ce60777a9\",\n \"fulfilment_client_id\": null,\n \"name\": \"Manual - aaaaaa\",\n \"type\": \"manual\",\n \"config\": null,\n \"data\": \"\",\n \"accounting_channel_id\": 0,\n \"is_local\": 0,\n \"warehouse_id\": null,\n \"created_at\": \"2026-02-25 12:06:24\",\n \"updated_at\": \"2026-03-30 12:36:19\"\n }\n ]\n}"}],"_postman_id":"05d9a526-e24e-4977-b3a8-068b99319d9d"},{"name":"Get Manual Channel Detail","id":"5e95ac93-87a6-4ec0-8592-610064029491","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-company.myhelm.app/public-api/sales_channels/manual/{{sales_channel_id}}","description":"Returns a single manual channel with its full address block expanded.
\nsales_channel record with config containing every sender/return-address field. type, is_local, auto_sync_offset are omitted; fulfilment_client_id is omitted for fulfilment-client users.
Returns 404 if the channel doesn't exist or is not a manual channel.
Creates a manual channel with full sender + return address configuration.
\nconfig — sender addressProvide either sender_address_id (an existing address record) or every inline sender_* field:
sender_company_name, sender_line_one, sender_line_two, sender_city, sender_county, sender_country, sender_postcode, sender_iso, sender_email, sender_phone_number.sender_company_number, sender_vat_number, sender_eori_number, sender_xeori_number, sender_ioss_number, sender_ukims_number.config — return addressProvide either company_return_address_id (existing address) or every inline return_* field (same shape as sender, with return_* prefix).
name must be unique across channels.WAREHOUSE_TYPE location.fulfilment_client_id is set, the client must exist.SHIPMENT_TYPE.The created channel with config containing the merged inline + database address fields.
Updates an existing manual channel. Same body shape as Create Manual Sales Channel.
\nname must remain unique (excluding the channel's own row).sender_address_id and company_return_address_id must exist — null is rejected.The updated channel with merged config.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["sales_channels","manual","{{sales_channel_id}}","update"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"c40c21a4-f017-4114-a039-14eab14d14e2","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"My Online Store (Renamed)\",\n \"warehouse_id\": 6,\n \"fulfilment_client_id\": null,\n \"config\": {\n \"sender_address_id\": 10,\n \"sender_company_name\": \"My Company Ltd\",\n \"sender_line_one\": \"1 Sender Street\",\n \"sender_line_two\": \"\",\n \"sender_city\": \"London\",\n \"sender_county\": \"\",\n \"sender_country\": \"United Kingdom\",\n \"sender_postcode\": \"SW1A 1AA\",\n \"sender_iso\": \"GB\",\n \"sender_email\": \"sender@example.com\",\n \"sender_phone_number\": \"+44 1234 567890\",\n\n \"company_return_address_id\": 11,\n \"return_company_name\": \"My Returns Centre\",\n \"return_line_one\": \"5 Returns Drive\",\n \"return_line_two\": \"\",\n \"return_city\": \"London\",\n \"return_county\": \"\",\n \"return_country\": \"United Kingdom\",\n \"return_postcode\": \"SW1A 1AA\",\n \"return_iso\": \"GB\",\n \"return_email\": \"returns@example.com\",\n \"return_phone_number\": \"+44 1234 567890\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/sales_channels/manual/{{sales_channel_id}}/update","description":"Updates an existing manual channel. Same body shape as **Create Manual Sales Channel**.\n\n### Constraints\n- The channel must exist and be a manual channel.\n- `name` must remain unique (excluding the channel's own row).\n- `sender_address_id` and `company_return_address_id` must exist — `null` is rejected.\n- All sender_* and return_* fields must be present in the config block.\n- Updates rewrite the linked address records in place — they do not create new addresses.\n\n### Response\nThe updated channel with merged config.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 43,\n \"chapi_id\": \"\",\n \"fulfilment_client_id\": null,\n \"name\": \"Postman G5 Update Test 2 - Renamed\",\n \"config\": {\n \"sender_address_id\": 9,\n \"sender_company_name\": \"Updated Postman Co\",\n \"sender_line_one\": \"99 Updated Street\",\n \"sender_line_two\": \"Suite 9\",\n \"sender_city\": \"London\",\n \"sender_county\": \"Greater London\",\n \"sender_country\": \"United Kingdom\",\n \"sender_postcode\": \"SW1A 9ZZ\",\n \"sender_iso\": \"GB\",\n \"sender_email\": \"updated@postman.test\",\n \"sender_phone_number\": \"+44 9999 999999\",\n \"sender_company_number\": \"99999999\",\n \"sender_vat_number\": \"\",\n \"sender_eori_number\": \"\",\n \"sender_xeori_number\": \"\",\n \"sender_ioss_number\": \"\",\n \"sender_ukims_number\": \"\",\n \"company_return_address_id\": 10,\n \"return_company_name\": \"Postman Returns Updated\",\n \"return_line_one\": \"99 Return Street\",\n \"return_line_two\": \"Unit Z\",\n \"return_city\": \"London\",\n \"return_county\": \"Greater London\",\n \"return_country\": \"United Kingdom\",\n \"return_postcode\": \"SW1A 9ZZ\",\n \"return_iso\": \"GB\",\n \"return_email\": \"returns@postman.test\",\n \"return_phone_number\": \"+44 9999 999999\",\n \"return_company_number\": \"99999999\",\n \"return_vat_number\": \"\",\n \"return_eori_number\": \"\",\n \"return_xeori_number\": \"\",\n \"return_ioss_number\": \"\",\n \"return_ukims_number\": \"\"\n },\n \"data\": \"\",\n \"accounting_channel_id\": 0,\n \"warehouse_id\": 6,\n \"created_at\": \"2026-04-30 13:23:46\",\n \"updated_at\": \"2026-04-30 13:23:47\"\n}"}],"_postman_id":"cf3b0b1e-4671-40ad-be2f-77ee6d1793dd"},{"name":"Delete Manual Sales Channel","id":"94bce384-aa2c-4b39-a1bf-0570374f8a87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://your-company.myhelm.app/public-api/sales_channels/manual/{{sales_channel_id}}/delete","description":"Soft-deletes a manual channel. Linked addresses are retained for audit.
\nThe deleted channel object with its config.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["sales_channels","manual","{{sales_channel_id}}","delete"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"e87217f6-d860-4a89-b756-2cdbf38c6c93","name":"Success","originalRequest":{"method":"DELETE","header":[],"url":"https://your-company.myhelm.app/public-api/sales_channels/manual/{{sales_channel_id}}/delete","description":"Soft-deletes a manual channel. Linked addresses are retained for audit.\n\n### Constraints\n- The channel must be a manual channel.\n- Fulfilment-client users can only delete their own client's channels.\n\n### Response\nThe deleted channel object with its config.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 43,\n \"chapi_id\": \"\",\n \"fulfilment_client_id\": null,\n \"name\": \"Postman G5 Update Test 2 - Renamed\",\n \"type\": \"manual\",\n \"config\": {\n \"sender_address_id\": 9,\n \"sender_company_name\": \"Updated Postman Co\",\n \"sender_line_one\": \"99 Updated Street\",\n \"sender_line_two\": \"Suite 9\",\n \"sender_city\": \"London\",\n \"sender_county\": \"Greater London\",\n \"sender_country\": \"United Kingdom\",\n \"sender_postcode\": \"SW1A 9ZZ\",\n \"sender_iso\": \"GB\",\n \"sender_email\": \"updated@postman.test\",\n \"sender_phone_number\": \"+44 9999 999999\",\n \"sender_company_number\": \"99999999\",\n \"sender_vat_number\": \"\",\n \"sender_eori_number\": \"\",\n \"sender_xeori_number\": \"\",\n \"sender_ioss_number\": \"\",\n \"sender_ukims_number\": \"\",\n \"company_return_address_id\": 10,\n \"return_company_name\": \"Postman Returns Updated\",\n \"return_line_one\": \"99 Return Street\",\n \"return_line_two\": \"Unit Z\",\n \"return_city\": \"London\",\n \"return_county\": \"Greater London\",\n \"return_country\": \"United Kingdom\",\n \"return_postcode\": \"SW1A 9ZZ\",\n \"return_iso\": \"GB\",\n \"return_email\": \"returns@postman.test\",\n \"return_phone_number\": \"+44 9999 999999\",\n \"return_company_number\": \"99999999\",\n \"return_vat_number\": \"\",\n \"return_eori_number\": \"\",\n \"return_xeori_number\": \"\",\n \"return_ioss_number\": \"\",\n \"return_ukims_number\": \"\",\n \"fulfilment_client_id\": null,\n \"warehouse_id\": 6\n },\n \"data\": \"\",\n \"accounting_channel_id\": 0,\n \"auto_sync_offset\": null,\n \"is_local\": 1,\n \"warehouse_id\": 6,\n \"created_at\": \"2026-04-30 13:23:46\",\n \"updated_at\": \"2026-04-30 13:23:47\"\n}"}],"_postman_id":"94bce384-aa2c-4b39-a1bf-0570374f8a87"}],"id":"8a23baf7-bb9c-4f25-817f-046c0defedce","description":"Manage and inspect sales channels — both integrated channels (real marketplaces / storefronts synced via plugins) and manual channels (locally-defined channels for orders that don't come from an integration).
\nFor manual channels you also need to provide sender and return-address details — these are required for any label printed from orders that arrive on the channel.
\n","_postman_id":"8a23baf7-bb9c-4f25-817f-046c0defedce","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}}},{"name":"Picks","item":[{"name":"List Picks","id":"2bddea0a-9faa-45da-b58f-12328a110072","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-company.myhelm.app/public-api/picks?page=1&per_page=20","description":"Returns a paginated list of picks with status / type / option labels resolved.
\nNot available to fulfilment-client users.
\nList envelope. Each data[] item is a pick_header with status_name, pick_type_name, pick_option_name resolved.
Search on pick_number.
Pick status (see folder description). Send multiple times for OR.
\n","type":"text/plain"},"key":"filters[status][]","value":"0"},{"disabled":true,"description":{"content":"Warehouse ID. Send multiple times for OR.
\n","type":"text/plain"},"key":"filters[warehouse][]","value":""},{"disabled":true,"description":{"content":"1 = Single, 2 = Multi.
Pick option (see folder description).
\n","type":"text/plain"},"key":"filters[pick_option][]","value":""},{"disabled":true,"description":{"content":"User ID assigned to the pick.
\n","type":"text/plain"},"key":"filters[assigned_user][]","value":""},{"disabled":true,"description":{"content":"User ID who created the pick.
\n","type":"text/plain"},"key":"filters[creator_user][]","value":""},{"disabled":true,"description":{"content":"0 = picks generated by API, 1 = picks generated from the dashboard UI.
Two unix timestamps comma-joined. Filters on created_at.
Returns a single pick with its pick_inventories[] (each enriched with order / location / inventory data) and time_tracking_data[].
Full pick record + pick_inventories[] + time_tracking_data[]. Returns 404 if the pick doesn't exist.
Adjusts the quantity or completion state of a product line within a pick.
\ndecrease / increase: changes the picked quantity by quantity.reset: resets picked quantity to 0.complete: marks the inventory line as fully picked.The affected pick_inventory records after the update.
Assigns a pick to a warehouse user.
\nuser_id (int, required).0) or IDLE (4).3) if assigning from IDLE.The updated pick record.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["picks","","assign_user"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"de745e74-ec15-429e-8b24-ed470bb6965c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user_id\": 4\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/picks//assign_user","description":"Assigns a pick to a warehouse user.\n\n### Body field\n- `user_id` (int, required).\n\n### Constraints\n- The pick's status must be **OPEN** (`0`) or **IDLE** (`4`).\n- The user must exist, must not be a fulfilment-client user, and must not be DC staff.\n- Status moves to **INPROGRESS** (`3`) if assigning from IDLE.\n\n### Response\nThe updated pick record.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 16,\n \"pick_type\": 1,\n \"pick_option\": 2,\n \"pick_number\": \"PIC-1777551965-147\",\n \"created_by\": 4,\n \"warehouse_id\": 6,\n \"assigned_to\": 4,\n \"status\": 4,\n \"zone_id\": 0,\n \"is_batch\": 0,\n \"is_split\": 0,\n \"ui_pick\": 0,\n \"force_completed\": 0,\n \"completed_at\": null,\n \"created_at\": \"2026-04-30 13:26:05\",\n \"updated_at\": \"2026-04-30 13:26:14\"\n}"}],"_postman_id":"40467da0-a4fe-4151-a126-e5d75993f722"},{"name":"Delete Pick","id":"fdd9a19f-c1d4-4f91-93ae-bd6456cca473","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://your-company.myhelm.app/public-api/picks//delete","description":"Soft-deletes a pick and unwinds the linked allocations.
\n1).{ \"id\": <pick_id>, \"message\": \"Pick deleted successfully.\" }\nBulk-generates picks for every order in a given status. Heavy operation — runs LocationSelection across the candidate orders, decides whether to create single- or multi-order picks, and applies a status change to any orders that fail to allocate.
\norder_status_id must allow pick creation.failed_order_status_id, if set, must NOT be in the no-pick set listed above.max_order_limit cannot exceed 100.BULK (4) auto-converts to BULK_AND_SORT (2) when the pick option is unsupported.failed_order_status_id (if set) and reported in the response.{\n \"status\": \"success\",\n \"message\": \"50 order(s) found... 48 pick(s) created. 2 order(s) failed...\",\n \"result\": {\n \"created_picks\": [ ...pick objects... ],\n \"failed_orders_due_to_allocation\": { \"<order_id>\": \"<reason>\" }\n },\n \"time_taken\": \"X.X Seconds\"\n}\nManage warehouse picks — single- or multi-order pick lists generated from despatch-ready orders.
\nstatus referencepick_type referencepick_option referencePick endpoints are not available to fulfilment-client users.
\n","_postman_id":"6159e8e7-bb49-4128-96d6-b8e6b7bcdb0a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}}},{"name":"Stock Transfers","item":[{"name":"List Stock Transfers","id":"ff952995-2ee4-4f4c-8e52-cac8cf7223fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-company.myhelm.app/public-api/stock_transfers?page=1&per_page=20","description":"Returns a paginated list of stock transfers.
\npage (default 1), per_page (default tenant setting).
List envelope. Each data[] item carries transfer_number, status + status_label, source_warehouse, destination_warehouse, items_count, total_quantity, total_shipped, total_received. When there are no transfers, data is null.
Partial match on the public-facing transfer number.
\n","type":"text/plain"},"key":"filters[transfer_number]","value":""},{"disabled":true,"description":{"content":"Status ID — see folder description.
\n","type":"text/plain"},"key":"filters[status][]","value":"0"},{"disabled":true,"description":{"content":"Source warehouse ID.
\n","type":"text/plain"},"key":"filters[source_warehouse][]","value":""},{"disabled":true,"description":{"content":"Destination warehouse ID.
\n","type":"text/plain"},"key":"filters[destination_warehouse][]","value":""},{"disabled":true,"description":{"content":"Starting date for transfer creation.
\n","type":"text/plain"},"key":"filters[date_range][from]","value":""},{"disabled":true,"description":{"content":"Ending date for transfer creation.
\n","type":"text/plain"},"key":"filters[date_range][to]","value":""},{"disabled":true,"description":{"content":"User ID who created the transfer.
\n","type":"text/plain"},"key":"filters[created_by]","value":""},{"disabled":true,"description":{"content":"One of: transfer_number_asc | transfer_number_desc | status_asc | status_desc | created_at_asc | created_at_desc. Default: created_at_desc.
Returns a single stock transfer with the full nested items[] array (each item with inventory metadata, plus a locations[] array carrying batch / serial / expiry info per source location).
Creates a new stock transfer in Pending status. Stock isn't deducted yet — that happens at Ship Stock Transfer.
\n{ \"success\": true, \"transfer_id\": <int>, \"transfer_number\": \"<string>\", \"message\": \"...\" }\nUpdates a transfer's destination, notes or items. Only Pending (0) transfers can be updated.
All optional; same shape as Create Stock Transfer (without source_warehouse_location_id). Sending items[] replaces the entire item list.
{ \"success\": true, \"message\": \"...\" }\nTransitions a transfer from Pending to Shipped, deducting stock from the source locations.
\n0).{ \"success\": true, \"message\": \"...\" }\nRecords receipt of items at the destination warehouse. The transfer auto-completes once every shipped item is received.
\n1).{\n \"success\": true,\n \"message\": \"...\",\n \"result\": {\n \"success\": true,\n \"locations_received\": <int>,\n \"transfer_completed\": <bool>,\n \"errors\": []\n }\n}\nCancels a transfer. If the transfer was already shipped, stock is returned to the source.
\nreason (string, optional).force_delete (bool, optional, default false) — if true, removes the cancelled transfer record afterwards.0), Shipped (1), or Cancelled (4).{ \"success\": true, \"message\": \"...\" }\nHard-delete shortcut — internally calls Cancel Stock Transfer with force_delete = true.
Same as Cancel Stock Transfer.
\n{ \"success\": true, \"message\": \"...\" }\nReturns audit logs for a single transfer (creation, ship, receive, cancel events).
\n{\n \"success\": true,\n \"data\": [\n { \"action\": \"...\", \"description\": \"...\", \"user_id\": <int>, \"metadata\": { ... }, \"created_at\": \"...\" }\n ]\n}\nLookup helper for the transfer-creation UI — searches inventory available in a source warehouse by SKU / name / barcode.
\n{\n \"success\": true,\n \"result\": {\n \"inventory\": [\n { \"id\": <int>, \"sku\": \"...\", \"name\": \"...\", \"image\": \"...\", \"stock_levels\": { ... },\n \"fulfilment_client_id\": <int|null>, \"batching_type\": <int>, \"is_serial_numbered\": <0|1> }\n ]\n }\n}\nResults are sorted by available stock descending.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["stock_transfers","inventory","search"],"host":["https://your-company.myhelm.app/public-api"],"query":[{"description":{"content":"Required. Warehouse to search stock in.
\n","type":"text/plain"},"key":"source_warehouse_id","value":"6"},{"description":{"content":"Required. Partial match on SKU, name, or barcode.
\n","type":"text/plain"},"key":"search","value":"widget"},{"description":{"content":"Result cap. Default 50, max 200.
Lookup helper for the transfer-creation UI — returns all locations in a warehouse where a SKU has stock, with batch/serial/expiry info per row.
\n{\n \"success\": true,\n \"result\": {\n \"inventory\": { \"id\": <int>, \"sku\": \"...\", \"name\": \"...\", \"is_batch_numbered\": <0|1>, \"batching_type\": <int> },\n \"locations\": [\n { \"location_id\": <int>, \"location_name\": \"...\", \"location_map\": \"...\",\n \"stock_level\": <int>, \"stock_level_available\": <int>, \"priority\": <int>,\n \"batch_number\": \"...\", \"serial_number\": \"...\", \"expire_date\": \"...\",\n \"batch_display\": \"...\", \"is_batch_numbered\": <0|1>,\n \"selected_quantity\": <int>, \"selected_notes\": \"...\" } // last two only when transfer_id is supplied\n ]\n }\n}\nRequired. The warehouse whose locations to list.
\n","type":"text/plain"},"key":"warehouse_id","value":"6"},{"disabled":true,"description":{"content":"Optional. If editing an existing transfer, returns previously-selected quantities and notes.
\n","type":"text/plain"},"key":"transfer_id","value":""}],"variable":[]}},"response":[{"id":"3ee4845c-a131-4c81-82e3-e9b154585b44","name":"200 — locations with stock","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://your-company.myhelm.app/public-api/stock_transfers/inventory/contact_id/locations?warehouse_id=6","host":["https://your-company.myhelm.app/public-api"],"path":["stock_transfers","inventory","contact_id","locations"],"query":[{"key":"warehouse_id","value":"6","description":"Required. The warehouse whose locations to list."},{"key":"transfer_id","value":"","description":"Optional. If editing an existing transfer, returns previously-selected quantities and notes.","disabled":true}]},"description":"Lookup helper for the transfer-creation UI — returns all locations in a warehouse where a SKU has stock, with batch/serial/expiry info per row.\n\n### Response\n```\n{\n \"success\": true,\n \"result\": {\n \"inventory\": { \"id\":Returns the warehouses available to use as source / destination of a transfer (basically every active WAREHOUSE_TYPE location).
{ \"success\": true, \"data\": [ { ...location records... } ] }\nMove stock between warehouses. A stock transfer captures what (inventory + qty + source location), from where (source warehouse), to where (destination warehouse), then walks through Pending → Shipped → Delivered (or Cancelled) states.
\nThe success-shape for endpoints in this folder differs from the rest of the API — they return { success: true, ... } rather than the bare object.
Returns a paginated list of users (excluding DC staff).
\nAdmin level only; not available to fulfilment-client users.
\nList envelope. Each data[] item is a user record with sensitive fields stripped. last_login is a unix timestamp.
Free-text search. Pair with filters[search_field].
One of: auto | name | email.
0 or 1.
Staff level. See folder description.
\n","type":"text/plain"},"key":"filters[staff_level][]","value":""},{"disabled":true,"description":{"content":"Fulfilment client ID.
\n","type":"text/plain"},"key":"filters[fulfilment_client_id][]","value":""}],"variable":[]}},"response":[{"id":"c474b651-bc32-4eb7-b5ff-4708c376f6d9","name":"200 — page of users","originalRequest":{"method":"GET","header":[],"url":"https://your-company.myhelm.app/public-api/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"total\": 2,\n \"per_page\": \"100\",\n \"current_page\": 1,\n \"last_page\": 1,\n \"data\": [\n {\n \"id\": 4,\n \"email\": \"hidayet.arasan@thedespatchcompany.com\",\n \"tfa_active\": 0,\n \"name\": \"Hidayet Arasan\",\n \"last_login\": 1777542159,\n \"staff_level\": 5,\n \"is_support_pin_active\": 0,\n \"is_barcode_login_active\": 0,\n \"barcode_number\": \"\",\n \"is_rfid_login_active\": 0,\n \"rfid_number\": \"\",\n \"is_ip_whitelist_active\": 0,\n \"ip_whitelist\": \"\",\n \"fulfilment_client_id\": null\n }\n ]\n}"}],"_postman_id":"f93d00e0-db15-466d-ae4b-86b10f5d35bb"},{"name":"Get User Detail","id":"0a55d4c5-49db-4817-8cf8-dc568a665f7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-company.myhelm.app/public-api/users/","description":"Returns a single non-DC-staff user with their warehouse-location IDs.
\nThe user record (sensitive fields stripped) plus a locations array of warehouse-location IDs the user is linked to.
Returns 404 if the user doesn't exist or is DC staff.
Creates a new internal user.
\nThe created user with sensitive fields stripped. Includes locations (the array of linked location IDs).
Updates an existing user. The full set of fields (including password) is always required — this endpoint is not a partial update.
The locations[] array completely replaces the user's existing location links (every prior link is removed first).
Same set as Create User — all required.
\nThe updated user with stripped fields.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"order_id"}]},"isInherited":true,"source":{"_postman_id":"473f3ed8-7306-464c-98bb-48b8b39c0469","id":"473f3ed8-7306-464c-98bb-48b8b39c0469","name":"Helm 3.6","type":"collection"}},"urlObject":{"path":["users","","update"],"host":["https://your-company.myhelm.app/public-api"],"query":[],"variable":[]}},"response":[{"id":"8383c913-1024-4be6-9883-4f66721e2888","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Jane Picker\",\n \"email\": \"jane@example.com\",\n \"password\": \"new-strong-password-456\",\n \"staff_level\": 2,\n \"fulfilment_client_id\": null,\n \"is_support_pin_active\": 0,\n \"is_barcode_login_active\": 0,\n \"barcode_number\": null,\n \"is_rfid_login_active\": 0,\n \"rfid_number\": null,\n \"is_ip_whitelist_active\": 0,\n \"ip_whitelist\": null,\n \"tfa_active\": 0,\n \"locations\": [1]\n}","options":{"raw":{"language":"json"}}},"url":"https://your-company.myhelm.app/public-api/users//update","description":"Updates an existing user. The full set of fields (including `password`) is **always** required — this endpoint is not a partial update.\n\nThe `locations[]` array completely replaces the user's existing location links (every prior link is removed first).\n\n### Body fields\nSame set as **Create User** — all required.\n\n### Response\nThe updated user with stripped fields.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 8,\n \"email\": \"postman-g7-user2-updated@example.com\",\n \"tfa_active\": 0,\n \"name\": \"Postman G7 User2 Updated\",\n \"last_login\": 1777552035,\n \"staff_level\": 2,\n \"is_support_pin_active\": 0,\n \"is_barcode_login_active\": 0,\n \"barcode_number\": null,\n \"is_rfid_login_active\": 0,\n \"rfid_number\": null,\n \"is_ip_whitelist_active\": 0,\n \"ip_whitelist\": null,\n \"fulfilment_client_id\": null,\n \"created_at\": \"2026-04-30 13:27:15\",\n \"updated_at\": \"2026-04-30 13:27:15\",\n \"locations\": [\n 6\n ]\n}"}],"_postman_id":"c5e9247c-bc68-4a35-b56b-ae71309c2393"},{"name":"Delete User","id":"a61645f8-b8d7-4409-bc42-735b0c75d58a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://your-company.myhelm.app/public-api/users//delete","description":"Soft-deletes a user. The email address is replaced with a placeholder so it can be re-used for a new account; warehouse-location links are removed.
\n{ \"id\": <user_id>, \"message\": \"User deleted successfully.\" }\nManage internal users (warehouse staff, supervisors, admins). All endpoints in this folder require Admin permission level and are not available to fulfilment-client users.
\nstaff_level referenceDC-staff users (internal The Despatch Company staff) are excluded from every list / detail response — they cannot be managed via the public API. The tfa_secret, google_secret, ip, user_agent, and dc_staff fields are stripped from every response.
Returns a paginated list of fulfilment clients.
\npage (default 1). Page size from tenant settings.
Fixed: created_at descending.
List envelope. Each data[] item is a fulfilment_client with status_name resolved.
Free-text search. Pair with filters[search_field]. Single pipe | between terms.
One of: auto | name | contact_email | billing_email.
Status — see folder description.
\n","type":"text/plain"},"key":"filters[status][]","value":"1"},{"disabled":true,"description":{"content":"0 or 1.
Billing option ID — see folder description.
\n","type":"text/plain"},"key":"filters[billing_api_billing_option][]","value":""},{"disabled":true,"description":{"content":"0 or 1.
Returns a single fulfilment client with its address record and any assigned warehouse locations.
\nThe fulfilment_client record plus:
address — the linked address record (or null).assigned_warehouses[] — array of warehouse location records the client is linked to.status_name — resolved status label.Creates a fulfilment client.
\nThe created fulfilment_client record with status_name resolved.
Updates a fulfilment client. Omitted fields keep their current values (each optional field defaults to the existing record's value).
\nSame set as Create Fulfilment Client, plus:
\nstatus (int, optional) — see folder description.default_supplier_id (int | null, optional) — sets the default supplier contact for new POs. Must be a Supplier (contact_type = 2).The updated client record with address resolved and status_name.
Soft-deletes a fulfilment client.
\n{ \"id\": <client_id>, \"message\": \"Fulfilment Client deleted successfully.\" }\nManage fulfilment clients — the tenant-of-the-tenant model used in 3PL setups, where each client gets isolated visibility into their own SKUs / orders / contacts.
\nAll endpoints in this folder require an owner / back-office user — fulfilment-client users themselves cannot manage other clients.
\nstatus referencebilling_api_billing_option reference