Connect and configure
Lesson 13 of 15 8 min read
Create an Integration, add Configurations for the document types it should handle, and switch it on, step by step.
With your plan in hand, it is time to connect. Every Integration is set up the same way:
This lesson covers steps 1 to 3. The next two lessons cover Mappings and running.
1. Create the Integration
- Go to Settings → Integration setup → Integrations.
- Click + ADD INTEGRATION in the top-right to see the available Integrations. You can search the list to find the one you need.
- Click ADD on the Integration you want.
- Complete the form. It varies by Integration: some ask for an API key, some take you to the other system to authorise Supply Lens.
- Click CONNECT.
Your new Integration appears in the list. Password and API key fields hide what you type, but have a show button so you can check what you pasted before connecting.
Connecting Unleashed
Priya clicks ADD on Unleashed, pastes the API ID and Key from Unleashed's API Access page, names the Integration "Unleashed (sandbox)" because she is starting with the sandbox account, and clicks CONNECT.
Connecting Shopify
Hilltop has approved the collaborator request from Supply Lens, so the store is available to
pick. The Add Shopify dialog also offers linking with a code from the Supply Lens app inside
Shopify; connecting with the store's .myshopify.com domain is in a section you can expand.
Priya uses the domain and clicks CONNECT.
2. Check its settings
Click the Integration to expand its panel. You met these cards in Integrations explained. For a first Integration:
- Activation: leave it Disabled until Configurations and Mappings are in place, so nothing runs half-configured. (Some Integrations start syncing as soon as you enable them; the Shopify guide warns that the first sync starts immediately.)
- State: usually leave unset unless this is an EDI Integration.
- Default Unit of Measure: leave unset unless every quantity on this Integration should be forced into one unit.
- Schedule: decide later; you will test by hand first.
3. Add Configurations
Add one Configuration per document type in your plan.
- Expand the Integration and click Configurations.
- Click + Add in the top-right of the window to open Add configuration.
- Choose a document type from the list.
- Click Send, Receive or both. Remember these are from Supply Lens's point of view.
- Click Create Default JSON to fill in the default settings for that type.
- Click Save.
About the settings
The default settings are a sensible starting point. They are shown as JSON (a structured text format) in an editor that checks them against what the Integration expects and underlines anything that will not save. You do not need to change them for a first test; if you are unsure what a setting does, ask Support before editing.
Hilltop's Configurations
| Integration | Document type | Direction |
|---|---|---|
| Shopify | Orders | Receive |
| Shopify | Inventory | Send |
| Unleashed (sandbox) | Orders | Send |
| Unleashed (sandbox) | Inventory | Receive |
Webhooks for instant orders
For Shopify, webhooks make new orders arrive straight away instead of at the next scheduled run. The help centre recommends enabling them: expand the Shopify panel and click Setup in the Webhooks section. The Integrations list shows whether webhooks are set up.
Recap
- Create an Integration from Settings → Integration setup → Integrations → + ADD INTEGRATION, complete its form and click CONNECT.
- Keep Activation on Disabled until Configurations and Mappings are in place.
- Add one Configuration per document type: choose the type, pick Send and/or Receive, click Create Default JSON, then Save.
- Enable webhooks on Shopify so orders arrive straight away.
Quick guides for this topic
Your progress is saved in this browser. Create a free account to keep it everywhere, take quizzes and earn certificates.