×

Setting Up the Connector In Enterprise Windows

Configuration Guide

To get the Shopify Connector setup and running properly you will need to perform the following actions:

  1. Create an App on the Shopify side
  2. Setup the Shopify Connector
  3. Run Connectors to push initial data up to Shopify
  4. Setup a job to automate pushing subsequent local ERP changes up to Shopify and downloading orders from Shopify to your ERP

Create a Private App

On the Shopify site, you will need to:

  1. Go to Settings | Apps and Sales Channel. There, click on the Develop apps button.
  2. Click on Allow custom app development - you may have to confirm this.
  3. Click on Create an app
  4. Create an app
    • Name this app something like BirdDog or BDSW
    • Click on Configure Admin API scopes. Check all boxes on Admin API scopes.
  5. Click on API credentials and click Install app. Copy both the Admin API access token - note that Shopify will only show this to you once - and the API secret key.

Setup the Shopify Connector

To configure Enterprise for Windows to use Shopify, you need:

  1. Go to Maintain > Setup > Connector Accounts
  2. Click Add
  3. Enter your Shopify Credentials
    • Description: Self-explanatory.
    • Type: Shopify should be selected in this dropdown list.
    • Notify Email: Email address to receive activity reports from the connector.
    • Notify Verbosity: Use this dropdown list to setup how frequently you want to receive notifications:
      1. All - receive email alerts every time the connector runs, regardless of activity
      2. Activity - receive email alerts when something is uploaded to or downloaded from Amazon
      3. Errors - only receive alerts when the connector encounters errors
      4. None - receive no email alerts ever
    • API Key: Paste the API Secret Key you copied from when you created the Private App above.
    • Admin API Key: Paste the Admin API access token information from when you created the Private App above.
    • URL: URL of your site. Shopify should provide this. It should be mysite.myshopify.com. You do not need to include http://
    • Terms Code: Select the terms code for new customers from this dropdown list.
    • Customer Type: Select the customer type code for new customers from this dropdown list. This customer type also controls the pricing that is sent up to Shopify.
    • Sales Person: Select the sales rep for new customers from this dropdown list. Typically, this will be something like WEB.
    • Ship Via: Select the ship via for new customers from this dropdown list.
    • Order Type: This determines what order format - Order, Invoice-type order, or Quote - new Shopify orders will be downloaded into the ERP as. By default, Order is selected.
    • Order Number: This determines number format is used for orders downloaded from Shopify. Next Order Number will use whatever the next order is in the ERP while Order From Remote Sysem will pull down the Shopify order number.
    • Tax Schedule or Tax Code: Select the appropriate code for new customers from this dropdown list. These are mutually exclusive so you can assign a tax schedule or a tax code to a new customer, but not both.
    • Location: Location assigned to new customers and orders downloaded from Shopify. Also used as the default location for quantities sent to Shopify. If this location does not exist for a specific item being upload then the item's default location will be used.
    • Items To Upload: Select the appropriate options from this dropdown list. This will determine what items are uploaded from your ERP to Shopify. The options are:
      • None - self-explanatory
      • All - also self-explanatory. Note that when we say All, we mean it so if you have a lot of items, be prepared for a wait when you run the Connector
      • Webcategory - selecting this unhides a Root Category field. This limits the upload of structure and items, and allows you to upload only items on the specific webcat page to Shopify. If blank, all items and customers in the database will be used. You can plug in either the page's GUID or a functional Code which is set when editing the page.
      • Query - selecting this unhides a Query for Items dropdown. On it, you can select queries saved in the system (System Management | System | Queries) There are two important factors to keep in mind when constructing this query. First, it should return the results of only one table column (that is, so no SELECT *), and second, that column will need to be named appropriately. If you are uploading items, it should be item_no or the equivalent, and cus_no if uploading customers.
    • Send Item Master Data: Select the appropriate option for the item information you wish to send up to Shopify from your ERP. There are three options here: All, None, or Some. All and None are self-explanatory, but Some adds a new Item Details button. Clicking on this option allows you to configure the properties of any item you want to send. If a property is checked, it will overwrite on an update; unchecked properties will only update if the item is new to Shopify. The options are:
      • Item Number
      • Description
      • Long Description
      • Price
      • List Price
      • Availability
      • Product Category
      • Taxable
      • Weight
      • Free Shipping
      • UPC
      • Meta Keywords
      • Images
    • Customers To Upload: Select the appropriate options from this dropdown list. This will determine what customers are uploaded from your ERP to Shopify. Note that Shopify requires an email address for their customers, so you will need to ensure that one exists on your ERP's customer. Although it is legal in many ERPs, Shopify does not allow multiple customers to share email addresses, so you will need to ensure that is not the case in your system. The options are:
      • None - self-explanatory
      • All - also self-explanatory. Note that when we say All, we mean it so if you have a lot of items, be prepared for a wait when you run the Connector
      • Query - selecting this unhides a Query for Customers dropdown. On it, you can select queries saved in the system (System Management | System | Queries). There are two important factors to keep in mind when constructing this query. First, it should return the results of only one table column (that is, so no SELECT *), and second, that column will need to be named appropriately. If you are uploading items, it should be item_no or the equivalent, and cus_no if uploading customers.
      • Tax Exempt - selecting this uploads only customers who are Tax Exempt.
    • Customer No For New Customers: Select the appropriate option from this dropdown list. This will determine how the system writes from your ERP. The options are:
      • Next Customer Number: Selecting this writes a new customer created in Shopify down into the ERP as the next customer number according to the proper range. Note also that if this is selected, the system will also download existing customers from your ERP into Shopify.
      • Guest Customer Number: Selecting this option unlocks the Guest Customer No field (which must be populated with your ERP's guest customer number) and then writes all new customers from Shopify into your ERP with that guest customer number.
      • Guest Customer Number With Ship To: Selecting this option unlocks the Guest Customer No field (which must be populated with your ERP's guest customer number) and then writes all new customers from Shopify into that existing customer as a new ship-to. This is used in scenarios where you want all of your web orders to be generated under a single customer inside your ERP.
    • Starting Shopify Order ID: This is used in the event that you've got older Shopify orders that have already been manually created in your ERP, so you'd populate this with the first Shopify order that you do want to download. NOTE: The Shopify Order ID can be found by logging into Shopify with an Admin account, clicking on an order to bring up the Order Page, and adding .json to the end of the URL (https://my-site.myshopify.com/admin/orders/424542543 to https://my-site.myshopify.com/admin/orders/424542543.json). The ID field in the JSON is the Shopify Order ID for that order.
  4. Once you are satisfied with your setup, click Save and then Close.

Run the Shopify Connector Manually

During initial configuration and anytime you want to force the process after that you can run the connector manually:

  1. Enterprise for Windows > Processes > Run Connectors

Create the Job

To ensure BirdDog keeps the data flowing between your ERP and Shopify automatically you will need to:

  1. Go to Maintain > Jobs
  2. Click on the Schedule New Job button
  3. Select Run Connectors in the Job dropdown list
  4. Schedule the job according to how frequently you want it to run (for example, every hour or at a certain time each day.)
  5. Save.