Overview

Warehouse Integration within Claritum provides the following facilities:

Automatically import stock orders placed by end-users directly through to your WMS (Warehouse Management System)
Allows your WMS to update Claritum on each order’s progress (including shipping costs)
Allows your WMS to notify Claritum when new stock arrives.
Daily stock levels request (to identify discrepancies between Claritum and your WMS stock levels).

Audience

This document is intended for use by the supplier wishing to implement Warehouse Integration with the Claritum System.

References

Before you start, please review this article detailing how to call Claritum's Web Services API.

Stock Order Workflow

This table illustrates the steps in the integration workflow from the order being placed to the confirmed despatches.

(the comments in boldMonospaced are the web service SOAP API endpoints you will need to call to service that step of the workflow)

Customer User	Claritum System	WH Supplier WMS
Places stock order on the customer catalogue
		Downloads new orders `getStockDespatches`
		Verify orders
		Post ‘rejections’ back to Claritum `markFailed`
	Generate and send error-alert emails to administrators
		Onboard verified orders into WMS workflow
		Confirm orders received `markExported`
		Pick, Pack and Despatch
		Post despatch information back to Claritum `setStockDespatches`
	Updates the stock order status to ‘Despatched’ with the given shipping cost
	Send alert emails to the Customer User (if configured)

Note: You’ll probably want to call getStockDespatches from a scheduled process of some sort. Perhaps every hour.

Replenishment Workflow

This workflow illustrates the process by which new stock arriving at the warehouse may be updated in Claritum, completing the linked replenishment job.

Service Manager	Production Supplier	Claritum System	WH Supplier WMS
Creates replenishment order, sends PO to Production Supplier for production.
	Produces product and ships to the WH Supplier
			Stock arrives and is booked into the WMS
			Posts the new stock details to Claritum `setGoodsReceipts`
		Updates the replenishment project, marking the goods as received (updating stock levels, releasing back-orders, etc)
		Marks the production supplier as ‘completed'

Daily Stock Levels Request

This is a service that you would implement that allows Claritum to obtain an up-to-date list of the stock levels for all items held by you on behalf of your customer. It is a simple GET request to which you should respond with JSON formatted data detailing each item’s current state.

Please contact your account manager to find out if you need to support this request or not.

URL

If you are handling this request you need to provide one URL, for example:

https://wms.abclogistics.com/api/stock/check?divisions=custref1,custref2

The ‘divisions’ property will contain a comma-separated list of the customer reference IDs from Claritum. Your account manager will be able to confirm these for your account. These can help you filter your stock lists for just the products known to the Claritum system.

Authentication

The request will use basic authentication with username and password. You will need to provide these credentials to your account manager on Claritum so that these can be configured for the call.

If the authentication fails then you should respond with a 401 status response.

Response

Here’s an example of the JSON array response you should be returning with the stock levels’ data:

[
    {
        “PartNumber”: “AB111”,
        “QtyAvailable”: 100,
        “UnitOfMeasure”: 1
    },
    {
        “PartNumber”: “AB112”,
        “QtyAvailable”: 200,
        “UnitOfMeasure”: 10
    },
    {
        “PartNumber”: “AB113”,
        “QtyAvailable”: 5,
        “UnitOfMeasure”: 1
    },
]

Summary

So, to implement the integration on your side, you will need to do a few things:

Implement the Stock Order Workflow (the call to getStockDepsatches on a timer process, the importing into your WMS and the confirmation/rejection calls back to Claritum).
Implement the Replenishment Workflow (the call to setGoodsReceipts).

And for the Stock Levels Request service you’ll need to:

Implement the Stock Levels Request JSON service.
Get the customer ref’s from your customer (to help with filtering)
Provide your customer with a username/password.
Give your URL to your customer.