Authenticate a Shopify Connection

The Shopify connector allows you to connect Unify to a Shopify account and view data tables. There are no standard tables and stored procedures created. The connector will connect to the source connections and replicate the tables in the destination connections.

The Shopify connector uses a private app setup within a shop. Application API key and password must then be provided within the ConnSettings.xml config file. These are then used for authentication.

To register the Unify connector as an app and obtain the client credentials (i.e. AppId, Password, and ShopUrl):

  1. Log in to Shopify from the admin page and go to Apps.

  2. Click Manage Private Apps.

  3. Click Create New Private App.

  4. In the Description section, enter the app name and contact email.

  5. In Permissions section, choose the areas of your store you want to grant to your app. The permissions required to use all the tables and views are:

    • read_customers,
    • write_customers,
    • write_draft_orders,
    • read_draft_orders,
    • read_fulfillments,
    • write_fulfillments,
    • write_inventory,
    • read_inventory,
    • write_marketing_events,
    • read_marketing_events,
    • read_orders,
    • write_orders,
    • read_price_rules,
    • write_price_rules,
    • read_product_listings,
    • write_product_listings,
    • read_products,
    • write_products,
    • read_shopify_payments_payouts.

  1. Go back to your private apps. The API Key (AppId) of your application and its password (Password) are listed for the app.

  2. Within the Unify ConnSettings.xml config file set the following connection properties:

    • ShopUrl: Set this to the full URL of your shop (https://yourshopname.myshopify.com).
    • AppId: Set this to the API Key in your private app settings.
    • Password: Set this to the password in your private app settings.

The following table lists all settings that can be found within the ConnSettings.xml configuration file:

XML Tag

Standard

Description

apikey

No

The string API key which can be found within app settings on Manage Private Apps screen.

apipass

No

The string API password which can be found within app settings on Manage Private Apps screen.

shopurl

No

The web address of the Shopify shop.

overwritetables

Yes

True – write all the available tables in current connection to the conname_tables.txt file. This property will provide a list of all the tables available in the current connection.

False – Start downloading the data from the tables listed in the file conname_tables.txt to destination connection.

cacheconnection

Yes

Destination connection string.

cacheschema

Yes

Name of the schema used in the destination database for tables.

cacherefresh

Yes

True – Refresh the entire database by deleting all the existing rows.

False – Performs incremental updates.

proxysettingsrequired

Yes

True – Read all the proxy settings defined below.

False – Does not use any proxy settings.

proxyautodetect

Yes

  

proxypassword

Yes

  

proxyserver

Yes

  

proxyuser

Yes

  

generatelog

Yes

True – Generate logs inside the connname_log file inside files folder.

verbosity

Yes

Detail level of logs to generate scale from 1 to 5. 5 is the highest.