Supply Lens

How do I test my Unleashed integration without touching live data?

Test with the Unleashed Sandbox

Connect your Unleashed Sandbox as its own Integration, run test orders through it, then move your Mappings to the live account.

About 5 min

The Unleashed Sandbox is a secure, separate environment that mirrors your Unleashed account as it was when the Sandbox was created. Supply Lens recommends testing against a Sandbox before you create your live Unleashed Integration. By the end of this guide you'll have a Sandbox Integration you can test against safely.

Before you start

  • An Unleashed Sandbox. Sandboxes are created in Unleashed, not in Supply Lens. Unleashed's guide How to set up the Sandbox explains the steps.
  • The Sandbox's own API ID and API Key. The Sandbox has a different pair from your live account. An Unleashed Account Owner can find them on the Sandbox's API Access page.
  • A Supply Lens account with permission to manage Integrations.

Steps

Create and connect the Sandbox Integration

  1. Go to Settings → Integration setup → Integrations and click + ADD INTEGRATION.
  2. Click ADD on Unleashed.
  3. Enter the Sandbox's API ID and API Key, then click CONNECT.
  4. Check the new Integration's name starts with Sandbox. Supply Lens adds this automatically so you can always see which Integration you're working with.

Add Configurations and Mappings

  1. Add the Configurations you plan to use live, as in Add Unleashed.
  2. Create your Mappings with the Sandbox Integration as the source or target. Consider turning Automatic off so each test Document waits at Ready for you to check.

Test

  1. Set the Sandbox Integration's Activation to Enabled.
  2. Send some test data into it, for example a test order from your storefront.
  3. Use Manual Operation → Run Send & Receive rather than waiting for a schedule.
  4. Work through your test orders: a normal order, a discounted one, a gift order, an unknown SKU and a cancellation.

Check it worked

  • Your test messages appear in the Unleashed Sandbox.
  • Each Document in Supply Lens is Complete and its Target Data is Sent. An order with an unknown SKU should fail with a clear error, not arrive half-right.
  • Reprocessing a Document after changing a setting doesn't create duplicates: Target Data with the same reference is marked Cancelled instead of being sent again.

When your tests pass, create the live Integration with the live API ID and Key and move your Mappings across. The Migrate tool on the Mappings screen moves every Mapping from one Integration to another in one step.

If something goes wrong

  • A code works in the Sandbox but fails live. The Sandbox is a snapshot. Products, customers, warehouses or statuses added to live Unleashed afterwards won't be in it, and the reverse. Re-check every code against live before go-live.
  • You can't tell the Integrations apart. Rename them with the pencil next to the name on the tile.
  • The connection fails. Check you used the Sandbox's own API ID and Key, not the live pair. See Update integration credentials.