Supply Lens

How do I add Unleashed?

Add Unleashed

Connect your Unleashed account to Supply Lens with its API ID and Key, switch on the message types you need, route them with Mappings and prove it with a test order.

About 7 min

By the end of this guide you'll have an Unleashed Integration that is connected, configured for the message types you need, routed to your other systems with Mappings, and proven with a test order.

Before you start

  • An Unleashed account and a Supply Lens account with permission to manage Integrations.
  • Your Unleashed API ID and API Key. Only an Unleashed Account Owner can see them, on the API Access page in Unleashed. Unleashed's own article, Unleashed API Access, shows where to find them. Treat the key like a password.
  • An Unleashed Sandbox, with its own API ID and Key (recommended). The Sandbox is a copy of your live account, so you can test without touching live data. See Test with the Unleashed Sandbox.
  • SKUs that match. Every product code that will appear on orders must exist in Unleashed in exactly the same format. Work through Align your SKUs first.
  • The Unleashed codes your settings will need, such as warehouse codes, sales order statuses and delivery methods, and a few real sample orders to test with.

Steps

Create and connect the Integration

  1. Log in to Supply Lens and go to Settings → Integration setup → Integrations.
  2. Click + ADD INTEGRATION in the top-right.
  3. Find Unleashed and click ADD.
  4. Complete the form with the API ID and API Key for the account you're connecting. Use the Sandbox's pair first if you have one.
  5. Click CONNECT. The new Integration appears in the list. A Sandbox connection is automatically named with Sandbox at the front.
  6. Click the arrow to expand the tile. Leave Activation disabled for now, and leave State and Default Unit of Measure unset unless you have a reason to set them. Note the Integration Id for Support.

Add Configurations

Add one Configuration per message type. Send and Receive are from Supply Lens's point of view: orders from your web shop are sent into Unleashed; stock on hand is received from Unleashed.

  1. On the Unleashed tile, click Configurations, then + Add.
  2. Choose a document type, for example Order.
  3. Click Send, Receive or both.
  4. Click Create Default JSON, then Save.
  5. Repeat for each type you need. A typical storefront set-up uses Order (Send), Inventory (Receive) and Shipment (Receive).

The Unleashed Integration supports these message types:

DataDirectionUnleashed record
CreditUnleashed ↔ Supply LensCredit Note
Customer UpdateUnleashed → Supply LensCustomer
Goods InboundUnleashed → Supply Lens
Goods Inbound ReceiptSupply Lens → Unleashed
InventoryUnleashed ↔ Supply LensStock on Hand
InvoiceUnleashed → Supply LensSales Invoice
OrderUnleashed ↔ Supply LensSales Order
Order ChangeSupply Lens → UnleashedSales Order
Order GroupUnleashed ↔ Supply LensSales Order Group
PickUnleashed → Supply LensPick List
Product UpdateUnleashed ↔ Supply LensProduct
Purchase OrderUnleashed ↔ Supply LensPurchase Order
QuoteUnleashed → Supply LensSales Quote
ShipmentUnleashed ↔ Supply LensSales Shipment
Stock AdjustmentSupply Lens → UnleashedStock Adjustment
Warehouse OrderUnleashed → Supply Lens
Warehouse ShipmentSupply Lens → Unleashed
Work OrderSupply Lens → Unleashed

Start with the defaults

The default order settings are a sound first test: validateOrderStatuses, completeFulfilledOrders and deleteCancelledOrders are on, and only Placed orders are imported out of Unleashed. Text values such as statuses and warehouse codes must match Unleashed exactly. Every setting is explained in Unleashed order settings.

Add Mappings

Each flow between two systems needs a Mapping.

  1. Go to Settings → Integration setup → Mappings and click + ADD.
  2. Set Map, From, As and To. For example, Order from your Shopify Integration, as Target Data, to Unleashed.
  3. Turn Automatic off while you test if you want to review each order before it reaches Unleashed. It will wait at Ready.
  4. Click SAVE. Add the return flows too, such as Inventory and Shipment from Unleashed to your storefront.

Test

  1. On the Unleashed tile, set Activation to Enabled. Leave the schedule off for now.
  2. Create a test order in the source system, or run the source Integration with Manual Operation.
  3. On the Unleashed tile, use Manual Operation → Run Send & Receive.
  4. Wait a few minutes.

Check it worked

  • In Supply Lens, open the order Document. Its status should be Complete (or Ready if the Mapping is manual), and its Target Data should be Sent.
  • In Unleashed (or the Sandbox), the sales order should be there with the right customer, products and quantities.
  • When you're happy, set a Schedule on the tile (every 30 minutes to 12 hours) so the Integration runs on its own.

Going live from a Sandbox means creating a second Integration with the live API ID and Key. The Go live lesson has the switch-over checklist.

If something goes wrong

  • Nothing arrives in Unleashed. Check Activation is Enabled, the Configuration direction is right (orders are Send), and a Mapping is Enabled to Unleashed.
  • The order fails with a product error. The SKU doesn't exist in Unleashed in exactly that format. See Fix "product does not exist".
  • It stopped connecting. Someone may have regenerated the API Key. See Update integration credentials.
  • Still stuck? Contact support@supplylens.co.uk with the Integration ID.