> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](https://docs.shopify.com/api "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](/s/article/360042927994 "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](/s/article/360042926274 "Adding a DataSet Using a Connector").

<table class="mt-responsive-table" data-aura-rendered-by="33:195;a"><tbody><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Primary Use Cases </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><p> This connector is appropriate for retrieving data for e-commerce sales, inventory, deliveries, and the like. It also supports blog and marketing information. </p></td></tr><tr><td class="mt-noheading" colspan="1" rowspan="1"><b> Primary Metrics </b></td><td class="mt-noheading" colspan="1" rowspan="1"> Returns sales information for your e-commerce shop. You can also get metrics on the blog and marketing side of your business. </td></tr><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Primary Company Roles </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><ul><li><p> Warehouse managers </p></li><li><p> E-commerce shop admins </p></li><li><p> Online sales </p></li><li><p> Owner/C-Suite </p></li></ul></td></tr><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Average Implementation Time </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><p> Depends on the date range, but generally between 1 and 3 hours </p></td></tr><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Ease of Use (on a 1-to-10 scale with 1 being easiest) </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><p> 6 </p></td></tr></tbody></table>

## 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](/s/article/360042926274 "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](http://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](https://help.shopify.com/en/manual/apps/custom-apps?shpxid=ad580d34-73F7-461C-B073-B668A74035CE#create-and-install-a-custom-app "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](/s/article/360042926054 "Manage Connector Accounts").

## Details Pane

This pane contains one primary menu, **Reports**, and other menus that appear depending on the report you select.

<Note>
  **Note:** Currently you can enter only one search string in fields that request search strings, such as **Order Name**.
</Note>

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p> Menu </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Report </p></td><td colspan="1" rowspan="1"><p> Select the desired Shopify report. The following reports are available: </p><table border="1" cellpadding="1" cellspacing="1"><tbody><tr><td colspan="1" rowspan="1"><p><b> Report Name </b></p></td><td colspan="1" rowspan="1"><p><b> Description </b></p></td></tr><tr><td colspan="1" rowspan="1"><p> Application Charges </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Application Charges. </td></tr><tr><td colspan="1" rowspan="1"><p> Application Credits </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Application Credits. </td></tr><tr><td colspan="1" rowspan="1"><p> Articles </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Blog Articles. </td></tr><tr><td colspan="1" rowspan="1"><p> Assets </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Assets. </td></tr><tr><td colspan="1" rowspan="1"><p> Blogs </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Blogs. </td></tr><tr><td colspan="1" rowspan="1"><p> Carrier Services </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Carrier Services. </td></tr><tr><td colspan="1" rowspan="1"><p> Checkouts </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Checkouts. </td></tr><tr><td colspan="1" rowspan="1"><p> Collects </p></td><td colspan="1" rowspan="1"> Returns information about collections, such as creation and last update times, product ID and collection IDs. </td></tr><tr><td colspan="1" rowspan="1"><p> Comments </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Blog Article Comments. </td></tr><tr><td colspan="1" rowspan="1"><p> Countries </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Countries. </td></tr><tr><td colspan="1" rowspan="1"><p> Custom Collections </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Custom Collections. </td></tr><tr><td colspan="1" rowspan="1"><p> Customers </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Customers. </td></tr><tr><td colspan="1" rowspan="1"><p> Disputes </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Disputes. </td></tr><tr><td colspan="1" rowspan="1"><p> Discount Codes </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Discount Codes. </td></tr><tr><td colspan="1" rowspan="1"><p> Draft Orders </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Draft Orders. </td></tr><tr><td colspan="1" rowspan="1"><p> Execute GraphQL Query </p></td><td colspan="1" rowspan="1"> Provides an advanced method to request custom data reports from Shopify about Products, Orders, and Customers using Shopify's GraphQL API. </td></tr><tr><td colspan="1" rowspan="1"><p> Gift Cards (Shopify Plus) </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Gift Cards. <b> Requires Shopify Plus subscription. </b></td></tr><tr><td colspan="1" rowspan="1"><p> Inventory Items </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Inventory Items. This report complements the Product Variants report. </td></tr><tr><td colspan="1" rowspan="1"><p> Fulfillments </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Fulfillments. </td></tr><tr><td colspan="1" rowspan="1"><p> Locations </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Locations. </td></tr><tr><td colspan="1" rowspan="1"><p> Marketing Events </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Marketing Events. </td></tr><tr><td colspan="1" rowspan="1"><p> Orders </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Orders. </td></tr><tr><td colspan="1" rowspan="1"><p> Pages </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Pages. </td></tr><tr><td colspan="1" rowspan="1"><p> Payouts </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Payouts. </td></tr><tr><td colspan="1" rowspan="1"><p> Policies </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Store Policies. </td></tr><tr><td colspan="1" rowspan="1"><p> Price Rules </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Price Rules. </td></tr><tr><td colspan="1" rowspan="1"><p> Product Variants (Deprecated) </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Product Variants. </td></tr><tr><td colspan="1" rowspan="1"><p> Products (Deprecated) </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Products. </td></tr><tr><td colspan="1" rowspan="1"><p> Provinces of Country </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Provinces of Countries. </td></tr><tr><td colspan="1" rowspan="1"><p> Products Using GraphQL </p></td><td colspan="1" rowspan="1"> Retrieve a list of products. </td></tr><tr><td colspan="1" rowspan="1"><p> Product Variants Using GraphQL </p></td><td colspan="1" rowspan="1"> Retrieves a list of product variants. </td></tr><tr><td colspan="1" rowspan="1"><p> Recurring Application Charges </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Recurring Application Charges. </td></tr><tr><td colspan="1" rowspan="1"><p> Redirects </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Redirects. </td></tr><tr><td colspan="1" rowspan="1"><p> Refunds </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Order Refunds. </td></tr><tr><td colspan="1" rowspan="1"><p> Resource Feedback </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Resource Feedback. </td></tr><tr><td colspan="1" rowspan="1"><p> Order Risks </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Order Risks. </td></tr><tr><td colspan="1" rowspan="1"><p> Script Tags </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Script Tags. </td></tr><tr><td colspan="1" rowspan="1"><p> Shipping Zones </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Shipping Zones. </td></tr><tr><td colspan="1" rowspan="1"><p> Shop </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Shop. </td></tr><tr><td colspan="1" rowspan="1"><p> Smart Collections </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Smart Collections. </td></tr><tr><td colspan="1" rowspan="1"><p> Themes </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Themes. </td></tr><tr><td colspan="1" rowspan="1"><p> Transactions </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Transactions. </td></tr><tr><td colspan="1" rowspan="1"><p> Usage Charges </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Usage Charges. </td></tr><tr><td colspan="1" rowspan="1"><p> Webhooks </p></td><td colspan="1" rowspan="1"> Receives data about Shopify Webhooks. </td></tr></tbody></table><p /></td></tr><tr><td colspan="1" rowspan="1"><p> Subreport </p></td><td colspan="1" rowspan="1"><p> Select the subreport to filter the data. Selecting a subreport will expand additional data available for the report. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Date Filter </p></td><td colspan="1" rowspan="1"><p> Select the date type to filter the data. </p><p><b> Created </b> receives data based on the created date, <b> Published </b> receives the data based on the published date, and <b> Updated </b> 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. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Financial Status </p></td><td colspan="1" rowspan="1"><p> Select if the report contains information about different financial status. If you select <b> Any </b>, all items are shown regardless of the financial status. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Duration </p></td><td colspan="1" rowspan="1"><p> Select the duration for the report (a Single Date, or a Date Range). </p></td></tr><tr><td colspan="1" rowspan="1"><p> Start Date </p></td><td colspan="1" rowspan="1"><p> 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. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific Start Date </p></td><td colspan="1" rowspan="1"><p> Select the report date using the date selector. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days Back To Start From </p></td><td colspan="1" rowspan="1"><p> 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. </p></td></tr><tr><td colspan="1" rowspan="1"><p> End Date </p></td><td colspan="1" rowspan="1"><p> 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. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific End Date </p></td><td colspan="1" rowspan="1"><p> Select the report date using the date selector. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days Back To End At </p></td><td colspan="1" rowspan="1"><p> 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. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Report Date </p></td><td colspan="1" rowspan="1"><p> 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. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific Date </p></td><td colspan="1" rowspan="1"><p> Select the report date using the date selector. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Published Status </p></td><td colspan="1" rowspan="1"><p> Select whether the report contains information for published or unpublished items. If you select <b> Any </b>, both published and unpublished items are shown. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Status </p></td><td colspan="1" rowspan="1"><p> Select whether the report contains information for canceled, closed, or open items. If you select <b> Any </b>, all items are shown regardless of status. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Fulfillment Status </p></td><td colspan="1" rowspan="1"><p> Select whether the report contains information for partial, shipped, or unshipped orders. If you select <b> Any </b>, all items are shown regardless of fulfillment status. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Backfill Data </p></td><td colspan="1" rowspan="1"><p> Selecting this checkbox, to retrieve new data with APPEND mode only in consecutive runs of the dataset. </p></td></tr></tbody></table>

### 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](/s/article/360042926274 "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](http://domo.shopify.com) would be domo.

### FAQs

<AccordionGroup>
  <Accordion title="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.
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="Which endpoint does each report call in this connector?">
    <table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p> Report Name </p></th><th colspan="1" rowspan="1"><p> Endpoint URL </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Application Charges </p></td><td colspan="1" rowspan="1"><p> /application\_charges.json </p></td></tr><tr><td colspan="1" rowspan="1"><p> Application Credits </p></td><td colspan="1" rowspan="1"><p> /application\_credits </p></td></tr><tr><td colspan="1" rowspan="1"><p> Articles </p></td><td colspan="1" rowspan="1"><p> /blogs/{blogIds}/articles.json </p></td></tr><tr><td colspan="1" rowspan="1"> Assets </td><td colspan="1" rowspan="1"> /themes/assets.json </td></tr><tr><td colspan="1" rowspan="1"> Blogs </td><td colspan="1" rowspan="1"> /blogs.json </td></tr><tr><td colspan="1" rowspan="1"> Carrier Services </td><td colspan="1" rowspan="1"> /carrier\_services </td></tr><tr><td colspan="1" rowspan="1"> Checkouts </td><td colspan="1" rowspan="1"> /checkouts.json </td></tr><tr><td colspan="1" rowspan="1"> Collects </td><td colspan="1" rowspan="1"> /collects.json </td></tr><tr><td colspan="1" rowspan="1"> Comments </td><td colspan="1" rowspan="1"> /comments.json </td></tr><tr><td colspan="1" rowspan="1"> Countries </td><td colspan="1" rowspan="1"> /countries.json </td></tr><tr><td colspan="1" rowspan="1"> Custom Collections </td><td colspan="1" rowspan="1"> /custom\_collections.json </td></tr><tr><td colspan="1" rowspan="1"> Customers </td><td colspan="1" rowspan="1"> /customers </td></tr><tr><td colspan="1" rowspan="1"> Discount Codes </td><td colspan="1" rowspan="1"> /price\_rules/discount\_codes </td></tr><tr><td colspan="1" rowspan="1"> Disputes </td><td colspan="1" rowspan="1"> /shopify\_payments/disputes </td></tr><tr><td colspan="1" rowspan="1"> Draft Orders </td><td colspan="1" rowspan="1"> /draft\_orders </td></tr><tr><td colspan="1" rowspan="1"><p> Execute GraphQL Query </p></td><td colspan="1" rowspan="1"> /graphql.json </td></tr><tr><td colspan="1" rowspan="1"> Gift Cards (Shopify Plus) </td><td colspan="1" rowspan="1"> /gift\_cards </td></tr><tr><td colspan="1" rowspan="1"> Inventory Items </td><td colspan="1" rowspan="1"> /inventory\_items </td></tr><tr><td colspan="1" rowspan="1"> Fulfillments </td><td colspan="1" rowspan="1"> /orders/{orderId}/fulfillments </td></tr><tr><td colspan="1" rowspan="1"> Locations </td><td colspan="1" rowspan="1"> /locations </td></tr><tr><td colspan="1" rowspan="1"> Marketing Events </td><td colspan="1" rowspan="1"> /marketing\_events </td></tr><tr><td colspan="1" rowspan="1"> Orders </td><td colspan="1" rowspan="1"> /orders </td></tr><tr><td colspan="1" rowspan="1"> Pages </td><td colspan="1" rowspan="1"> /pages </td></tr><tr><td colspan="1" rowspan="1"> Payouts </td><td colspan="1" rowspan="1"> /shopify\_payments/payouts </td></tr><tr><td colspan="1" rowspan="1"> Policies </td><td colspan="1" rowspan="1"> /policies </td></tr><tr><td colspan="1" rowspan="1"> Price Rules </td><td colspan="1" rowspan="1"> /price\_rules </td></tr><tr><td colspan="1" rowspan="1"> Product Variants (Deprecated) </td><td colspan="1" rowspan="1"> /products/{productId}/variants </td></tr><tr><td colspan="1" rowspan="1"><p> Products </p><p> (Deprecated) </p></td><td colspan="1" rowspan="1"> /products </td></tr><tr><td colspan="1" rowspan="1"> Provinces of Country </td><td colspan="1" rowspan="1"> /countries/provinces </td></tr><tr><td colspan="1" rowspan="1"><p> Products Using GraphQL </p></td><td colspan="1" rowspan="1"> /graphql.json </td></tr><tr><td colspan="1" rowspan="1"><p> Product Variants Using GraphQL </p></td><td colspan="1" rowspan="1"> /graphql.json </td></tr><tr><td colspan="1" rowspan="1"> Recurring Application Charges </td><td colspan="1" rowspan="1"> /recurring\_application\_charges </td></tr><tr><td colspan="1" rowspan="1"> Redirects </td><td colspan="1" rowspan="1"> /redirects </td></tr><tr><td colspan="1" rowspan="1"> Refunds </td><td colspan="1" rowspan="1"> /orders/{orderId}/refunds </td></tr><tr><td colspan="1" rowspan="1"> Resource Feedback </td><td colspan="1" rowspan="1"> /resource\_feedback </td></tr><tr><td colspan="1" rowspan="1"> Order Risks </td><td colspan="1" rowspan="1"> /orders/{orderId}/risks </td></tr><tr><td colspan="1" rowspan="1"> Script Tags </td><td colspan="1" rowspan="1"> /script\_tags </td></tr><tr><td colspan="1" rowspan="1"> Shipping Zones </td><td colspan="1" rowspan="1"> /shipping\_zones </td></tr><tr><td colspan="1" rowspan="1"> Shop </td><td colspan="1" rowspan="1"> /shop </td></tr><tr><td colspan="1" rowspan="1"> Smart Collections </td><td colspan="1" rowspan="1"> /smart\_collections </td></tr><tr><td colspan="1" rowspan="1"> Themes </td><td colspan="1" rowspan="1"> /themes </td></tr><tr><td colspan="1" rowspan="1"> Transactions </td><td colspan="1" rowspan="1"> /orders/{orderId}/transactions </td></tr><tr><td colspan="1" rowspan="1"> Usage Charges </td><td colspan="1" rowspan="1"> /recurring\_application\_charges/usage\_charges </td></tr><tr><td colspan="1" rowspan="1"> Webhooks </td><td colspan="1" rowspan="1"> /webhooks </td></tr></tbody></table>
  </Accordion>

  <Accordion title="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](https://help.shopify.com/en/manual/your-account/staff-accounts/staff-permissions "Shopify documentation").
  </Accordion>

  <Accordion title="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](http://domo.shopify.com), your shop name is "domo".
  </Accordion>

  <Accordion title="Can I use the same account for multiple datasets?">
    Yes
  </Accordion>

  <Accordion title="How often can the data be updated?">
    As often as needed.
  </Accordion>

  <Accordion title="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.
  </Accordion>
</AccordionGroup>
