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. This custom version of the Shopify connector with Domo allows you to create personalized dashboards with product, sales, inventory, and even customer data all in one place. For information about the basic version, see Shopify Connector. The Shopify Custom connector integrates Shopify data, including data on customers, orders, marketing efforts, pages, and more. 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 Custom 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 e-commerce sales, inventory, deliveries, and the like. It also supports blog and marketing information. |
| Primary Metrics | Returns sales information for your e-commerce shop. You can also get metrics on the blog and marketing side of your business. |
Primary Company Roles |
|
Average Implementation Time | Depends on the date range, but generally between 1 and 3 hours |
Ease of Use (on a 1-to-10 scale with 1 being easiest) | 6 |
Prerequisites
To connect to your Shopify Custom account and create a DataSet, you must have the following:- The name of your shop.
- The email address and password associated with your Shopify account.
- The Admin API access token.
Connecting to Your Shopify Custom App Account
This section enumerates the options in the Credentials and Details panes on the Shopify Custom Connector page. The components of the other panes on 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.Credentials Pane
This pane contains two fields where you enter the name of your shop. and the Admin API access token. You can find out the name of your shop by looking at your Shopify URL. For example, in the Shopify URL domo.shopify.com, the shop name would be domo. The Admin API Access can be generated by creating and installing the app and then making an authentication request. For more details, see Create and install a custom app. After you have entered valid Shopify credentials, you can use the same account in Domo any time you create a Shopify DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Manage Connector Accounts.Details Pane
This pane contains one primary menu, Reports, and other menus that appear depending on the report you select.Menu | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Report | Select the desired Shopify report. The following reports are available:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Subreport | Select the subreport to filter the data. Selecting a subreport will expand additional data available for the report. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Date Filter | Select the date type to filter the data. Created receives data based on the created date, Published receives the data based on the published date, and Updated receives data based on the updated date. It should be noted that when the requested object is a subset of another object, the date filters based on the parent object. For example, Fulfillments are a part of the Order object, so when you request the Fulfillments report, your date selection will be filtered based on the Orders those fulfillments belong to, not the fulfillments themselves. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Financial Status | Select if the report contains information about different financial status. If you select Any , all items are shown regardless of the financial status. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Duration | Select the duration for the report (a Single Date, or a Date Range). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Start Date | Select the report start date using relative or specific dates. Relative means 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 want to get the data from (start day). Specify either today or 0, yesterday or 1, or today-7 or 7 to get the data for 7 days into the past. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
End Date | Select report end date using relative or specific dates. Relative means 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 want to get the 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Report Date | Select the report date using relative or specific dates. Relative means 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Published Status | Select whether the report contains information for published or unpublished items. If you select Any , both published and unpublished items are shown. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Status | Select whether the report contains information for canceled, closed, or open items. If you select Any , all items are shown regardless of status. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Fulfillment Status | Select whether the report contains information for partial, shipped, or unshipped orders. If you select Any , all items are shown regardless of fulfillment status. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Backfill Data | Selecting this checkbox, to retrieve new data with APPEND mode only in consecutive runs of the dataset. |
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
When should I use this connector?
When should I use this connector?
What endpoint is the base URL for this connector?
What endpoint is the base URL for this connector?
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 |
| Fulfillments | /orders//fulfillments |
| Locations | /locations |
| Marketing Events | /marketing_events |
| Orders | /orders |
| Pages | /pages |
| Payouts | /shopify_payments/payouts |
| Policies | /policies |
| Price Rules | /price_rules |
| Product Variants (Deprecated) | /products//variants |
Products (Deprecated) | /products |
| Provinces of Country | /countries/provinces |
Products Using GraphQL | /graphql.json |
Product Variants Using GraphQL | /graphql.json |
| 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?
Where do I get my Shopify shop name in the credentials section?
Where do I get my Shopify shop name in the credentials section?
Can I use the same account for multiple datasets?
Can I use the same account for multiple datasets?
How often can the data be updated?
How often can the data be updated?
What is the difference between the Shopify Connector and Shopify Custom App Connector?
What is the difference between the Shopify Connector and Shopify Custom App Connector?