Shopify App

Prerequisites

• An active Shopify account from which data is to be ingested exists.

• Data types in Source and Destination are the same.

• You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo to create the Pipeline.

Perform the following steps to configure your Shopify Source:

Create an App in Shopify

As a first step of replicating data from your Shopify store to the desired Destination, you must create a custom app, using which, you can make API calls to your Shopify store and fetch data. To do this:

1. Log in to your Shopify Store Admin account.

2. In the left navigation pane, click Apps.

   

3. In the search bar, click App and sales channel settings.

   

4. In the Apps and sales channels page, click Develop apps.

   

5. Click Allow custom app development.

6. Click Allow custom app development again to allow Shopify to create custom apps.

   

7. In the App Development page, click Create an app.

   

8. In the Create an app dialog:

   

   1. In the App name field, provide a name for the custom app.

   2. In the App developer field, select the email address that Shopify should use for contacting you or your team member regarding your app. Read Update your developer contact details for steps to add or update the email address of your team member to the custom app.

   3. Click Create app.

9. Click Configure Admin API scopes.

   

10. Refer to section, Configure API Permissions in Shopify for steps to configure the app to fetch all data from Shopify.

Configure API Permissions in Shopify

To configure the app to make API calls, you must grant the required permissions for the different scopes and the data within these scopes. Then, you must generate the API token to be used for setting up a Pipeline in Hevo with Shopify as the Source.

To grant the required permissions and generate the API token, perform the following steps:

1. Under the Admin API access scopes section, enable the read_<scope_name> check box for the following scopes to get the read access:

   • Assigned Fulfillment Orders

   • Discounts

   • Draft orders

   • Fulfillment services

   • Inventory

   • Marketing events

   • Merchant Managed Fulfillment Orders

   • Orders

   • Price rules

   • Products

   • Product listings

   • Shipping

   • Shopify Payment disputes

   • Shopify Payment payouts

   • Third Party Fulfillment Orders

2. Click Save.

3. Click Install app.

   

4. In the confirmation dialog box, click Install.

   

5. In the API credentials tab, under the Admin API access token, click Reveal token once.

   This shows your Admin API password that you must use while setting up a Shopify Pipeline in Hevo. The token is visible only once, so you must copy the token and store it in a secure location.

   

Configure Shopify Connection Settings

Once you have set up the app and generated the API credentials, create a Pipeline to complete the framework for replicating the data from Shopify into the Destination.

To do this:

1. Click PIPELINES in the Navigation Bar.

2. Click + CREATE PIPELINE in the Pipelines List View.

3. In the Select Source Type page, select Shopify.

4. In the Configure your Shopify Source page, specify the following:

   

   • Pipeline Name: A unique name for your Pipeline, not exceeding 255 characters.

   • Shop Name: Your shop name. You can find this in the address bar when logged into your shop. For example, in the URL https://mynewshop.myshopify.com/admin, the shop name is “mynewshop”.

   • Admin API Password: The password that you retrieved in Step 2 above.

   No additional settings are needed, as Hevo connects to Shopify using the app details that you provide.

   • Historical Sync Duration: The duration for which you want to ingest the existing data from the Source. Default duration: 3 Months.

     Note: If you select All Available Data, Hevo ingests all the data available in your Shopify App account since January 01, 2006.

5. Click TEST & CONTINUE.

6. Proceed to configuring the data ingestion and setting up the Destination.