The Openbridge Shopify API data connector allows you to tap into inventory, orders, returns, and a host of other information via an automated, code-free process.
Using private, customer-created, apps for connectivity to a Shopify account allows you to leverage the universal Openbridge OAuth and API services. Why do we use private (i.e., custom apps)? These applications are secure, controlled by you, owned by you, and dedicated for your use only.
This guide will walk you through the process to activate a private, custom merchant app. It should only take a couple of minutes to complete this process.
Step 1: Enroll in Shopify Partners
The first step is to create a Shopify Partner account. This is where you will activate a private Shopify app that allows Openbridge the ability to collect data on your behalf.
Step 2: Create your Shopify Partner Program account
Creating an account is quick and easy. All you need to do is enter your email, first, and last name:
You may be asked to fill out additional information. Answer the questions as appropriate. We marked a few suggested settings in red:
Step 3: Create Your Shopify App
After creating your account, the next step is creating an
App. Select the
Create app button or select
Apps in the navigation:
Next, you will be presented with the type of app to be created. Select the
Single-merchant app option. This is a private app exclusive to a specific client:
Enter a name for your app. For example, if your store URL is
https://your-store.myshopify.comthen we suggest calling your app
your-store. Using the store name will help you identify the app. If you have more than one custom app, this will ensure you have a clear mapping of your app to the target store.
For the app URL, enter
https://oauth.api.openbridge.io/oauth/callbackfor the redirection URL. This allows us to authorize our secure connection to your app.
That is it! Select the
Create app button to finish the process!
If you are asked for your store URL, enter it. For example, in this case, the URL was
(Note: Shopify requires you remove the HTTPS or slashes)
Step 4: Generate Merchant Link
Now that you have your app, the next step is to generate a merchant link:
Once you click
Generate link Shopify will create a merchant install link for you to use when authorizing Openbridge access to collect data on your behalf:
Copy the link and keep it safe. You will need this later.
Step 5: Copy your authorization information
After generating your merchant install link, the last step is to get a copy of your
Your app will have an
API key and
API secret key. Take note of each as these two keys are needed when setting up the Shopify data connector in the Openbridge interface.
At this point, you will have an install link, API key, and API secret. You are ready to complete the process at Openbridge!
Step 6: Request Order History (Optional)
As of June 6th, 2018, only the last 60 days' worth of orders from a store will be accessible. If you want to access older orders, then you need to request access to all orders. Shopify requires that you request this access.
Here is how you request access...
App setup there is an option to have your app able to access more than 60 days of order history.
App setup, scroll down to the
Orders section to
When you request this access, Shopify will ask two questions. We provided examples of answers you can use and tailor as you deem appropriate:
Question: Describe your app and how it helps merchants.
This app will only be used for our store
<store-name.myshopify.com>. As such, the primary purpose of the app is to help us directly as a Shopify merchant. We are creating this app so we can provide analysts with the Order data they need to undertake data visualizations, analytics, reporting, and other business intelligence activities for our e-commerce operations. Order data will allow our team to use
<Tableau, Grow, Power BI...>analytics tools for date-based performance and financial reporting.
Question: Why does your app need access to orders older than 60 days?
The Order history will provide an automated connection to the API so we can get historical data to our analysts and business teams to undertake operational and performance analyses. This includes month over month, year over year sales, and profit reports. It supports financial auditing and cross-referencing data from internal systems (i.e., warehouses, vendors...) to reconcile profitability, breakage, and forecasting. As a result, having complete and accurate order history is necessary for our business to undertake comprehensive operations, performance, and financial analysis.