Clarus WMS ids and setup
Lesson 9 of 28 6 min read
Clarus works in ids rather than codes, and test and live accounts have different ones. Learn the flows, where each id comes from and how to set up the Integration.
Clarus WMS is a warehouse management system used by contract warehouses, including pallet and distribution operations. It has one of the most detailed settings guides of any connector, because Clarus is strict about what it accepts: it rejects a receipt without a location rather than guessing one.
By the end of this lesson you will know the five Clarus flows, why every value is an id, and how to set up the Integration.
The five flows
| Settings group | Direction | What it does |
|---|---|---|
| Clarus WMS Warehouse Order | Send | Creates a goods out in Clarus |
| Clarus WMS Warehouse Shipment | Receive | Imports despatched goods outs, with batches picked |
| Clarus WMS Goods Inbound | Send | Books a goods in receipt from a purchase order |
| Clarus WMS Goods Inbound Receipt | Receive | Imports what the warehouse counted, to write onto the purchase order |
| Clarus WMS Inventory | Receive | Imports stock balances, as a full snapshot or just what moved |
Ids, not codes
Every reference in the Clarus settings is a Clarus id (a number), not a code. The guide explains why: warehouses advise ids, because a code can be reclassified underneath you (a pallet network renaming its service levels, for example) and an id cannot.
The two exceptions are filters on imports, which use codes: filterByAccountCode and
filterByWarehouseCode. The Inventory guide warns that the warehouse filter takes the code
(for example AW), and a numeric id "matches nothing here".
Where the ids come from
Clarus resolves most ids from the Document using cross-references, so they can be corrected per organisation without a configuration change:
- Account, supplier, warehouse and product on a goods in receipt are cross-reference identifiers. Party identifier types include Clarus WMS Account Code, Clarus WMS Account ID, Clarus WMS Customer Code and Clarus WMS Customer ID.
- Warehouse has a settings fallback,
defaultWarehouseId, for sources whose documents carry no fulfilment location. - Location (the goods in or goods out bay) comes from
defaultLocationId. - Carrier and service come from settings, as a constant or mapped from the order.
Test and live are different accounts
The guide repeatedly warns that a Clarus test account usually has different ids from live:
the warehouse might be 8 in test and 2 in live, and the bays differ too. Plan to change
defaultWarehouseId and defaultLocationId on both the Warehouse Order and Goods Inbound
groups at go-live.
Set it up
- Go to Settings → Integration setup → Integrations, click + ADD INTEGRATION and click ADD on Clarus WMS. Complete the connection form and click CONNECT.
- Open Configurations and add the Document types you need, with Create Default JSON.
- Ask the warehouse for its ids: warehouse, goods in bay, goods out bay, carriers and carrier services, plus your account code.
- Add Clarus identifiers to your Parties and Locations where the cross-references are needed.
- Set the account filter on every import to your own account code.
Oakmoor Foods and its pallet warehouse
Oakmoor Foods supplies grocery wholesalers from a contract warehouse running Clarus. The
warehouse sends a sheet of ids: test warehouse 8, live warehouse 2, goods in bay and
goods out bay ids for each, and the ids of its own pallet network carrier. Oakmoor's
implementer keeps the sheet with the go-live plan, because every one of those values changes
when the live account opens.
Recap
- Clarus has five flows: goods out, shipments, goods in, receipts and inventory.
- Settings hold Clarus ids, not codes; import filters are the exception and take codes.
- Account, supplier, warehouse and product are resolved from cross-references; the warehouse and location have settings defaults.
- Test and live Clarus accounts have different ids, so plan the switch.
Quick guides for this topic
Your progress is saved in this browser. Create a free account to keep it everywhere, take quizzes and earn certificates.