Clarus WMS settings

Every setting on the Clarus WMS Goods Inbound, Goods Inbound Receipt, Inventory, Warehouse Order and Warehouse Shipment Configurations, including the ids that change at go-live.

The Clarus WMS Integration books goods in and goods out in Clarus and brings back receipts, stock levels and shipments. Its settings live on five Configurations: Clarus WMS Goods Inbound, Clarus WMS Goods Inbound Receipt, Clarus WMS Inventory, Clarus WMS Warehouse Order and Clarus WMS Warehouse Shipment.

Test and live ids differ

A Clarus test account usually has a different warehouse and location from the live one (for example warehouse 8 in test and 2 in live). Every defaultWarehouseId and defaultLocationId needs changing at go-live.

Goods in (booking a receipt)

These settings are on the Clarus WMS Goods Inbound Configuration. They control the goods in receipt booked in Clarus when an inbound goods advice (a purchase order raised in the source system) is sent to the warehouse.

The ids a receipt needs (account, supplier, warehouse, product) are cross-reference identifiers read from the Document, so they can be corrected per organisation without changing the Configuration. The warehouse is the only one with a settings fallback, for sources whose Documents carry no fulfilment Location.

Setting	What it does	Values / default	When to change it
Default warehouse `defaultWarehouseId`	The Clarus warehouse id goods are received into when the Document's fulfilment Location has no Clarus warehouse id cross-referenced. When set, the warehouse cross-reference is no longer required.	A Clarus warehouse id.	Set it when Documents don't carry a fulfilment Location. Change it at go-live.
Default location `defaultLocationId`	The Clarus location id the goods are booked into, normally the warehouse's default goods in bay.	A Clarus location id.	Always set it: Clarus rejects a receipt with no location ("location_id - must be filled") rather than using the default bay. Change it at go-live.
Receipt type `receiptType`	What kind of receipt is booked: a plain receipt of goods, a receipt against a purchase order held in Clarus, or a crossdock.	Default `receipt`.	Change it for purchase order receipts or crossdock.
Inbound method `inboundMethod`	Whether the supplier delivers the goods or the warehouse collects them.	Default `delivery`.	Change it when the warehouse collects.
Status `status`	The state the receipt is created in. Only draft and pending are meaningful; the other states are reached as the warehouse works the receipt.	Default `PENDING`.	Change it to draft if receipts should start as drafts.
Goods in receipt kind `goodsInReceiptKindId`	The Clarus goods in receipt kind to book against.	A constant, or a rule that reads the value from the Document's tags. Unset means the field is left out.	Set it when the warehouse classifies receipts by kind. A tag rule lets different inbounds be classified differently without a Configuration change.
Order type `orderTypeId`	The Clarus order type to book against.	A constant, or a rule reading the Document's tags.	Set it when the warehouse asks for an order type.
Inbound good kind `inboundGoodKindId`	The Clarus inbound good kind to book against.	A constant, or a rule reading the Document's tags.	Set it when the warehouse asks for an inbound good kind.
Send batch numbers `sendBatchNumbers`	Sends a line that carries batches as one receipt line per batch, with the batch number and expiry date.	On or off. Default off.	Leave off where the warehouse assigns its own batches on receipt.
Send storage unit quantity `sendStorageUnitQuantity`	Adds the number of pallets each line fills, in `storage_unit_quantity`: the quantity in the Product's default unit divided by its pallet conversion (packs per pallet), rounded up, because a part pallet still takes a space. Each batch line is counted on its own.	On or off. Default off.	Turn on when the warehouse wants pallet counts. It needs the organisation's pallet Unit of Measure and a pallet conversion on every Product received. Leave off where the warehouse works out its own storage units.

How receipt lines are sent:

Lines carry a Clarus product id only. A Product with no Clarus product id cross-referenced is looked up by SKU when the receipt is sent.
If any Product can't be found, the receipt isn't sent, and the error names the unmatched SKUs.
The stock description is left for Clarus to take from the product.
With sendStorageUnitQuantity on, a line whose Product has no pallet conversion fails translation naming the SKU, rather than sending its pack count as pallets. product_storage_unit_id is never sent.

Goods in receipts (what was counted)

These settings are on the Clarus WMS Goods Inbound Receipt Configuration. They import goods in receipts back from Clarus so the quantities the warehouse counted can be written onto the purchase order the advice came from. A receipt is imported once per change, not once per receipt: the warehouse works a receipt over time, so it comes back again with more received.

Setting	What it does	Values / default	When to change it
Setup date `setupDate`	Only receipts created on or after this date are imported.	A date. Set automatically when the Integration is first configured.	Not normally changed.
Last import date `lastImportDate`	The import watermark. Each run only fetches receipts modified after it.	Date and time. Managed by the system.	Don't edit it by hand.
Import delay `importDelay`	Holds back recently changed receipts so they can settle before import.	A duration, for example `00:05:00`.	Add a delay if receipts are imported mid-change.
Filter by statuses `filterByStatuses`	Imports only receipts in these states.	A list of states. Empty imports every state, including receipts the warehouse hasn't finished working.	Set it to the finished states if you only want completed receipts.
Filter by account code `filterByAccountCode`	Imports only receipts held against this Clarus account.	An account code. Empty imports every account the credentials can see.	Set it when the Clarus site holds other clients' accounts.
Filter by warehouse code `filterByWarehouseCode`	Imports only receipts held in this Clarus warehouse.	A warehouse code. Empty imports every warehouse.	Set it to limit the import to one warehouse.
Use the quantity received field `useQuantityReceivedField`	Clarus has two received quantities on a receipt line, `quantity_received` and `received_quantity`, and documents neither. On reads `quantity_received`; off reads `received_quantity`.	On or off. Default on.	Turn off if quantities written back to the purchase order come through as zero.

Stock

These settings are on the Clarus WMS Inventory Configuration.

Stock is read in one of two ways, decided by lastImportDate:

No last import date: every stock balance is read as a complete snapshot, and any Product Clarus doesn't hold is set to zero.
With a last import date: each run reads only the Products whose stock has moved since then and updates only those. Clarus records no timestamp on a stock balance, so movement is found from Clarus's stock transactions (allocations, picks, despatches, put-aways, transfers and holds), and each moved Product's current balance is then read in full.

Setting	What it does	Values / default	When to change it
Last import date `lastImportDate`	When stock was last imported. When set, a run imports only Products whose stock has changed since.	Set automatically after each run, to the time that run started; the next run looks back a further five minutes so nothing at the boundary is missed.	Clear it to import a complete inventory on the next run.
On-hand basis `onHandBasis`	Which Clarus figure counts as the quantity physically on hand: `received`, `available`, or `available`, `allocated` and `picked` added together. Configurable because Clarus doesn't document what each figure counts.	Default `received`.	It has no effect on the stock adjustment today: the quantity available always comes from the `available` figure, and that's what Unleashed reconciles against unless batches are present (Clarus stock balances carry none).
Filter by account code `filterByAccountCode`	Imports only stock held against one Clarus account.	An account code. Empty imports every account the credentials can see.	Set it when the Clarus site holds other clients' accounts.
Filter by warehouse code `filterByWarehouseCode`	Imports only stock in one Clarus warehouse, by its code (for example `AW`).	A warehouse code, not the numeric id, which matches nothing here. Empty imports every warehouse.	Set it to limit the import to one warehouse.
Filter by product code `filterByProductCode`	Imports only one Product.	A product code.	Only for verifying the Integration, not for normal running.
Page size `pageSize`	How many stock balances to request per page.	Empty means 100, which is also Clarus's maximum; a larger value is reduced to 100.	Rarely needed.

Never leave filterByProductCode set with an empty lastImportDate

A complete snapshot taken under filterByProductCode is still treated as a complete inventory, so it sets the stock of every other Product to zero.

Goods out (warehouse orders)

These settings are on the Clarus WMS Warehouse Order Configuration. They control the goods out created in Clarus when a warehouse order is sent. Every id here is a Clarus id, not a code: a code can be reclassified (a pallet network renaming its service levels, for example) and an id can't.

Setting	What it does	Values / default	When to change it
Default delivery instructions `defaultDeliveryInstructions`	Fixed text added to the "Delivery Notes" field on every warehouse order.	Text.	Set it for instructions that apply to every order.
Default warehouse `defaultWarehouseId`	The Clarus warehouse id the order is despatched from when its fulfilment Location has no Clarus warehouse id cross-referenced.	A Clarus warehouse id. Unset, with nothing cross-referenced, the order is sent without a warehouse and a warning is logged.	Set it, and change it at go-live.
Default location `defaultLocationId`	The Clarus location id the order is despatched from, normally the warehouse's default goods out bay.	A Clarus location id. Unset means the field is left out.	Set it where the warehouse requires a location on every goods out. Change it at go-live.
Carrier `carrierId`	The Clarus carrier id to despatch with.	A constant for one default carrier, or a JSON path that reads the carrier from the order (such as `$.shipping[0].carrierName`) with field mappings from the order's carrier to a Clarus carrier id; the mapping's default covers anything unmapped. Unset means the field is left out.	Set it whenever the warehouse needs a carrier on the order.
Carrier service `carrierServiceId`	The Clarus carrier service level id, such as a 24 or 48 hour service.	Configured the same way as `carrierId`.	Set it when the service level varies or must be stated.
Contact-required carriers `contactRequiredCarrierIds`	Clarus carrier ids that can't deliver without the recipient's email and phone number, typically the warehouse's own pallet or distribution networks. An order for a listed carrier that's missing either fails translation, naming what's missing, rather than failing later in the warehouse's transport system.	A list of carrier ids.	Add the carriers the warehouse says need contact details.
Send batch numbers `sendBatchNumbers`	Sends a line that carries batches as one goods out line per batch, with the batch number in `string1` and the expiry date in `datetime2` (the attributes a goods in receipt books a batch under), so the warehouse picks those batches. Lines without batches are sent as normal.	On or off. Default off.	Leave off where the warehouse chooses which batches to pick.

How the delivery address is sent:

Clarus field	What goes in it
`name`	The recipient
`company_name`	The company
`address_1`	The street
`address_2`	The second and third address lines, joined
`address_3`	The town or city
Postcode and country	The postcode and country
`address_4`, `address_5`	Nothing

The recipient and company never go in the address lines. An order missing a recipient or company name, street, town, postcode or country fails translation instead of being sent.

Shipments

These settings are on the Clarus WMS Warehouse Shipment Configuration.

Setting	What it does	Values / default	When to change it
Setup date `setupDate`	Only shipments created on or after this date are imported, so history isn't pulled in at go-live.	A date. Set automatically when the Integration is first configured.	Not normally changed.
Last import date `lastImportDate`	The import watermark. Each run only fetches shipments modified after it.	Date and time. Managed by the system.	Don't edit it by hand.
Import delay `importDelay`	Waits before importing a shipment, so other systems can update it first.	A duration, for example `00:05:00`.	Add a delay if shipments arrive incomplete.
Filter by account code `filterByAccountCode`	Imports only shipments held against one Clarus account. A Clarus site can hold several accounts, each a different supplier client.	An account code. Empty imports every account the credentials can see.	Set it to your organisation's own account code.
Batch number field `batchNumberField`	Which of Clarus's five stock text attributes (`string1` to `string5`) holds the batch number. Each shipment line then carries the batches it was picked from, with the quantity from each. Stock with nothing in the field isn't treated as a batch.	`string1` to `string5`. Empty by default, which imports no batches.	Follow the warehouse's convention; Clarus labels `string1` as the stock batch, which is usually the one to choose.
Batch expiry field `batchExpiryField`	Which of Clarus's five stock date attributes (`datetime1` to `datetime5`) holds the batch's expiry date.	`datetime1` to `datetime5`. Empty by default, which reads no expiry.	Set it if the warehouse records expiry dates.