Shopify Custom App Connector

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	- Warehouse managers - E-commerce shop admins - Online sales - Owner/C-Suite
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.

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: Report Description Application Charges Receives data about Shopify Application Charges. Application Credits Receives data about Shopify Application Credits. Articles Receives data about Shopify Blog Articles. Assets Receives data about Shopify Assets. Blogs Receives data about Shopify Blogs. Carrier Services Receives data about Shopify Carrier Services. Checkouts Receives data about Shopify Checkouts. Collects Returns information about collections, such as creation and last update times, product ID and collection IDs. Comments Receives data about Shopify Blog Article Comments. Countries Receives data about Shopify Countries. Custom Collections Receives data about Shopify Custom Collections. Customers Receives data about Shopify Customers. Discount Codes Receives data about Shopify Discount Codes. Disputes Receives data about Shopify Disputes. Draft Orders Receives data about Shopify Draft Orders. Execute Bulk GraphQL Query Provides an advanced method to request custom data reports from Shopify about Products, Orders and Customers using Shopify’s GraphQL API using bulk operation. Execute GraphQL Query Provides an advanced method to request custom data reports from Shopify about Products, Orders and Customers using Shopify’s GraphQL API. Fulfillments Receives data about Shopify Fulfillments. Gift Cards (Shopify Plus) Receives data about Shopify Gift Cards. Requires Shopify Plus subscription. Inventory Items Recieves data about Shopify Inventory Items. This report compliments the Product Variants report. Locations Receives data about Shopify Locations. Marketing Events Receives data about Shopify Marketing Events. Order Risks Receives data about Shopify Order Risks. Orders Receives data about Shopify Orders. Pages Receives data about Shopify Pages. Payouts Receives data about Shopify Payouts. Policies Receives data about Shopify Store Policies. Price Rules Receives data about Shopify Price Rules. Product Variants (Deprecated) Receives data about Shopify Product Variants. Product Variants Using GraphQL Retrieves a list of product variants. Products (Deprecated) Receives data about Shopify Products. Products Using GraphQL Retrieve a list of products. Provinces of Country Receives data about Shopify Provinces of Countries. Recurring Application Charges Receives data about Shopify Recurring Application Charges. Redirects Receives data about Shopify Redirects. Refunds Receives data about Shopify Order Refunds. Resource Feedback Receives data about Shopify Resource Feedback. Script Tags Receives data about Shopify Script Tags. Shipping Zones Receives data about Shopify Shipping Zones. Shop Receives data about Shopify Shop. Smart Collections Receives data about Shopify Smart Collections. Themes Receives data about Shopify Themes. Transactions Receives data about Shopify Transactions. Usage Charges Receives data about Shopify Usage Charges. Webhooks Receives data about Shopify Webhooks.
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?

Using the Shopify Customer app connector with Domo, you can create personalized dashboards with product, sales, inventory, and even customer data all in one place.

What endpoint is the base URL for this connector?

The base URL for the Shopify Custom App connector is https://%s.myshopify.com/admin/api/2022-07.

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 Bulk GraphQL Query	/graphql.json
Execute GraphQL Query	/graphql.json
Fulfillments	/orders//fulfillments
Gift Cards (Shopify Plus)	/gift_cards
Inventory Items	/inventory_items
Locations	/locations
Marketing Events	/marketing_events
Order Risks	/orders//risks
Orders	/orders
Pages	/pages
Payouts	/shopify_payments/payouts
Policies	/policies
Price Rules	/price_rules
Product Variants (Deprecated)	/products//variants
Product Variants Using GraphQL	/graphql.json
Products (Deprecated)	/products
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
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?

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?

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?

Yes

How often can the data be updated?

As often as needed.

What is the difference between the Shopify Connector and Shopify Custom App Connector?

Shopify Custom App connector allows you to add functionality to your Shopify admin, directly access your store’s data through Shopify’s APIs, or extend your online store to other platforms using the Storefront API along-with all the features available for Shopify connector. However, Shopify connector only allows you to create personalized dashboards with product, sales, inventory, and even customer data all in one place.