Supply Lens

How do I make an Integration send or receive a document type?

Add a Configuration

Switch on a document type for an Integration, in the right direction, and start from its default settings.

About 4 min

A Configuration switches on one document type (orders, shipments, stock levels and so on) on one Integration, in one or both directions. At the end of this guide your Integration will handle the document type you've added.

Before you start

  • The Integration exists. See Add an Integration.
  • You know which document type to add and which way it flows. Directions are from Supply Lens's point of view: Receive brings data into Supply Lens from this system; Send pushes data out of Supply Lens to it. Orders, for example, are typically received from Shopify and sent into Unleashed.

Steps

  1. Go to Settings → Integration setup → Integrations and click the Integration to expand it.
  2. Click Configurations to open its list of Configurations.
  3. Click + Add in the top-right to open the Add configuration window.
  4. Choose a document type from the drop-down.
  5. Click Send, Receive or both.
  6. Click Create Default JSON to fill in the default settings. The editor becomes editable once the defaults are ready.
  7. Review the settings. Where the Integration has a settings form, it opens with default values filled in, and the JSON appears beside it on wide screens. Change only what you understand.
  8. Click Save.
A Shopify Integration with one Configuration per document type.

Getting the direction backwards

Choosing Send when you meant Receive is the most common Configuration mistake. Ask "what does Supply Lens do with it?" If Supply Lens collects it from this system, it's Receive.

Check it worked

  • The new Configuration appears in the Integration's list of Configurations.
  • The Configuration saved without errors. Settings are checked against what the Integration expects, and any problem is underlined on the line where it occurs. A Configuration can't be saved without settings.
  • After you've added a Mapping and run the Integration, Documents of that type arrive (for Receive) or are sent (for Send).

If something goes wrong

  • Problems underlined in the editor. Fix each underlined line, then save. If you pasted settings wrapped in a Value property, Supply Lens removes the wrapper for you and tells you.
  • Nothing happens after saving. A Configuration only switches the document type on. You also need the Integration enabled and a Mapping that uses it. See Add a Mapping.
  • Unsure what a setting does. Leave the default and check the settings page for your connector, for example Xero settings, or ask Support.