- Courses
- ItemPath Integration Guide
- Configure an Integration
Configure an Integration
An integration is a specific recurring task in ItemPath to communicate with a specific, external system. You can develop custom integrations using your own middleware, or if you are using a service that can initiate an API request to ItemPath. But this course focuses on cases where you are building an integration using one of ItemPath's three middleware apps.
There are three main types of integrations available in ItemPath:
- Data Pull: Imports orders and materials from an external source and creates them in Power Pick
- Data Push: Exports transaction confirmations from Power Pick to the connected software.
- Variance: Imports a table of data for joining with Power Pick data available in ItemPath.
You can use our documentation to fully understand of each of these apps. Creating an integration is the most involved part of the process, but it follows a general pattern. There are two main steps to creating an integration:
- Specify details to connect to the service that you need for your integration project goals.
- Pair off (map) fields from the external service with any comparable fields in ItemPath.
This page will cover specifying details for your integration. The next page in this course will help with mappings!
Configure an integration
For each of the three apps, you can create a new integration from the main app page, with the New Integration button. You'll be asked to provide basic information about the integration (such as a name for your integration and the connection that the integration service should use.
Each app contains additional basic configuration options:
- Data Pull: You can select whether data should be created or deleted by this integration, and the type of data that should be created or deleted based on data from the external source.
- Data Push: You can select if the integration requires user approval to send transactions.
- Variance: You can select a report theme to use for mapping data, once you've selected the theme, it cannot be changed for that integration!
After supplying the basic information, select Create Integration to configure advanced settings.
Settings for Data Pull
The settings page for Data Pull will differ based on whether you are using it to work with Materials or Orders. Generally, you have the following settings available for Data Pull:
- General: Change the integration name or connection.
- Connection: This is the path/extension of the connection base URL.
- Headers: Add or remove headers that should be included, like authorization tokens.
- Other Settings: Configure additional settings regarding how ItemPath creates records.
- Request: Use a GET or POST API method to pull data.
- Confirmation: Set the endpoint to send confirmation responses.
Our Data Pull documentation contains a detailed breakdown of each setting.
Settings for Data Push
When configuring Data Push, you have these settings available:
- General: Change the integration name or connection.
- Connection: This is the path/extension of the connection base URL.
- Headers: Add or remove headers that should be included, like authorization tokens.
- Filters: Specify filters over the transaction data to decide which transactions will be sent by the integration.
See our Data Push documentation and course for additional guidance.
Settings for Variance
After creating a Variance integration, you can adjust these settings:
- Integration Name
- Formatting: The time zone for any dates or times retrieved by the integration.
- Data Caching: How long data should be cached by the Variance app. This is important if the report is running with a workflow, or you are not working with live data that is constantly refreshing in both tables. For example, you can set the cache to reset every day following an inventory update in the ERP.
See our Variance documentation for more details.