Intro
Shopify is an e-commerce platform that enables individuals and businesses to create online stores. To learn more about the Shopify API, go to https://docs.shopify.com/api. The Shopify connector is a “Cloud App” connector, meaning it retrieves data stored in the cloud. In the Data Center, you can access the connector page for this and other Cloud App connectors by clicking Cloud App in the toolbar at the top of the window. This topic discusses the fields and menus that are specific to the Shopify connector user interface. For general information about adding DataSets, setting update schedules, and editing DataSet information, see Adding a DataSet Using a Connector.Primary Use Cases | This connector is appropriate for retrieving data for ecommerce sales, inventory, deliveries, and the like. It also supports blog and marketing information. |
| Primary Metrics | Returns sales information for your ecommerce shop. You can also get metrics on the blog and marketing side of your business. |
Primary Company Roles |
|
Average Implementation Time | Less than an hour |
Ease of Use (on a 1-to-10 scale with 1 being easiest) | 2 |
Prerequisites
Before connecting a Shopify store to Domo, you must install the Domo Shopify app (https://apps.shopify.com/domo-inc ) from your Shopify instance. You need to install the app in every store for which you want to connect to Domo. Follow the steps below to install the app and configure the connector:- Navigate to https://apps.shopify.com/domo-inc. The below screen appears. Note: Ensure that you have selected the correct store in the top right corner of your page.
- Click Install, to install the Domo app in your store. The Install app page opens.
-
From the Install app page, you will be prompted to confirm the Domo app’s access to your store.
Note: The data access request is for objects that can be pulled through the connector. If you are comfortable providing read access to the data, then click Install. Domo will only pull the data you select and on your selected schedule. Domo will not pull any data from Shopify that you do not request.
-
When you click Install, a new window opens, from where you will be asked to sign in to Domo. Enter your Domo instance name and click Continue.
Note: If you have not previously logged in to the Domo specified instance, you will be asked to log in. If you do not have a Domo instance, then click the Sign up free link to obtain a Domo instance.
- After logging in, you will be redirected to the connector power up experience. You will be able to view the account populated in the Credentials section, which is same as the name of the store from which you installed the Domo app.
- Click Next to select the report that you wish to pull, select the options for the report, and set the dataset name and scheduling duration.
Connecting to Your Shopify Account
To connect to your Shopify account, refer to the prerequisites section. The components of the other panes in this page, Scheduling and Name & Describe Your DataSet, are universal across most connector types and are discussed in greater length in Adding a DataSet Using a Connector.Details Pane
This pane contains one primary menu, Report, and other menus that appear depending on the report you select.Note: Currently you can enter only one search string in fields that request search strings, such as Order Name.
Menu | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Report | Select the desired Shopify report. The following reports are available:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Subreport | Select a sub-report to filter the data. Selecting a sub-report will expand additional data available for the report. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Date Filter | Select the date type to filter the data. Created receives data based on its created date, Published receives data based on its published date, and Updated receives data based on its updated date. It should be noted that when the requested object is a subset of another object, the date will filter based on the parent object. For example, Fulfillments are a part of the Order object, so when requesting the Fulfillments report, your date selection will be filtered on the Orders those fulfillments belong to, not the fulfillments themselves. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Financial Status | Filter orders by their financial status. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Duration | Select the duration for the report (a Single Date, or a Date Range). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Report Date | Select the report date using relative or specific dates. Relative indicates the number of days from today or a specific date using the date selector. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Select Specific Date | Select the report date using the date selector. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Days Back | The number of days back that you would like to get data for. Specify either today or 0, yesterday or 1, or today or 7 to get data for 7 days into the past. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Start Date | Select the report start date using relative or specific dates. Relative indicates the number of days from today or a specific date using the date selector. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Select Specific Start Date | Select the report date using the date selector. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Days Back To Start From | The number of days back that you would like to get data from (start day). Specify either today or 0, yesterday or 1, or today-7 or 7 to get data for 7 days into the past. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| End Date | Select the report end date using relative or specific dates. Relative indicates the number of days from today or a specific date using the date selector. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Select Specific End Date | Select the report date using the date selector. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Days Back To End At | The number of days back that you would like to get data to (end day). Specify either today or 0, yesterday or 1, or today-7 or 7 to get data for 7 days into the past. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Status | Select whether the report contains information for cancelled, closed, or open items. If you select Any , all items appear regardless of the status. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Published Status | Select whether the report contains information for published or unpublished items. If you select Any , both published and unpublished items will appear. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Fulfillment Status | Select whether the report contains information for partial, shipped, or unshipped orders. If you select Any , all items appear regardless of the fulfillment status. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Backfill Data | Select this checkbox, to retrieve new data with APPEND mode, only in consecutive runs of the dataset. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Merge Mode | Select this option if you want to merge the functionality when the sub-report is “None”. Scheduling set below will not have any effect if this option is selected. Does not work for the first run. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GraphQL Query | Enter the GraphQL query to execute. For more information on Shopify GraphQL queries, refer to the Shopify API documentation. |
Other Panes
For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Connector.Troubleshooting
Ensure the Shop Name you enter in the Credentials pane is just the subdomain of your URL. For example, the Shop Name for domo.shopify.com would be domo.FAQs
What endpoint is the base URL for this connector?
What endpoint is the base URL for this connector?
The base URL for the Shopify connector is
https://{shop-name}.myshopify.com/admin/api/{apiVersion}.Which endpoint does each report call in this connector?
Which endpoint does each report call in this connector?
Report Name | Endpoint URL |
|---|---|
Application Charges | /application_charges.json |
Application Credits | /application_credits |
Articles | /blogs//articles.json |
| Assets | /themes/assets.json |
| Blogs | /blogs.json |
| Carrier Services | /carrier_services |
| Checkouts | /checkouts.json |
| Collects | /collects.json |
| Comments | /comments.json |
| Countries | /countries.json |
| Custom Collections | /custom_collections.json |
| Customers | /customers |
| Discount Codes | /price_rules/discount_codes |
| Disputes | /shopify_payments/disputes |
| Draft Orders | /draft_orders |
Execute GraphQL Query | /graphql.json |
| Gift Cards (Shopify Plus) | /gift_cards |
| Inventory Items | /inventory_items |
Inventory Items Using GraphQL | /graphql.json |
| Fulfillments | /orders//fulfillments |
| Locations | /locations |
| Marketing Events | /marketing_events |
Metafield Definitions | /graphql.json |
| Orders | /orders |
| Pages | /pages |
| Payouts | /shopify_payments/payouts |
| Policies | /policies |
| Price Rules | /price_rules |
| Product Variants (Deprecated) | /products//variants |
| Products (Deprecated) | /products |
Product Variants Using GraphQL | /graphql.json |
Products Using GraphQL | /graphql.json |
| Provinces of Country | /countries/provinces |
| Recurring Application Charges | /recurring_application_charges |
| Redirects | /redirects |
| Refunds | /orders//refunds |
| Resource Feedback | /resource_feedback |
| Order Risks | /orders//risks |
| Script Tags | /script_tags |
| Shipping Zones | /shipping_zones |
| Shop | /shop |
| Smart Collections | /smart_collections |
| Themes | /themes |
| Transactions | /orders//transactions |
| Usage Charges | /recurring_application_charges/usage_charges |
| Webhooks | /webhooks |
What kind of credentials do I need to power up this connector?
What kind of credentials do I need to power up this connector?
You need the name of your Shopify shop to power up this connector, and your Shopify username and password. Shop owners can use the connector without setting any additional permissions. However, if you have a limited user account - a Staff account, you will need to ensure that you have permissions to Apps and any other resources you wish to pull from the connector. Visit Shopify documentation.
Where do I get my Shopify shop name in the credentials section?
Where do I get my Shopify shop name in the credentials section?
The Shopify shop name is found in your shop dashboard URL. For example, if your shop dashboard is domo.shopify.com, your shop name is “domo”.
Can I use the same account for multiple datasets?
Can I use the same account for multiple datasets?
Yes
How often can the data be updated?
How often can the data be updated?
As often as needed.