Documentation

Description‍

Shopify GraphQL is an eCommerce platform that allows users to set up an online store and sell products or services directly to their customers.

Follow our setup guide to connect Shopify GraphQL to Improvado.

Step 1. Click the Make a new Connection on the Connections page.
‍‍Categories on the Data sources page group all available platforms. Use a search to find the required one.

Step 2. Click on the Shopify GraphQL tile.

Step 3. Choose authorization option:

{%docs-accordion title="Connect your own Shopify App (via Client Credentials, recommended)"%}

To authorize your account you need to fill in the required fields below following steps 3.1 - 3.4:

• Shop name
• Client ID
• Client Secret

To do these steps you need to have at least Apps Developer role or ask the user with that permission to follow through.

{%docs-informer info%} Collaborators don't have access to the Dev Dashboard. {%docs-informer-end%}

Step 3.1. Create a new app from your Dev Dashboard.

1. From the Dev Dashboard, be sure you're on Apps in the left-panel navigation and select Create app in the top, right corner of the screen.
2. Select Start from Dev Dashboard.
3. Name your app, then select Create.

Step 3.2. Create a version.

Once you've created the app, you can create a version. Your app must have at least one version before it can be installed on a store.

From the Versions tab of your app in the Dev Dashboard, complete your desired fields, including:

1. Defining your app URL. Use the default URL ```https://shopify.dev/apps/default-app-home```
2. Selecting a Webhooks API version (newest version).
3. Selecting your app scopes. These define the data and features your app can access within the Shopify platform.

4. Select Release.

Step 3.3. Complete the following steps to install your app on a store:

1. From your app, select Home in the left panel of the Dev Dashboard.
2. Scroll down and select Install app.
3. Select or create the store for your app.
4. Select Install.

Your app is now installed.

Step 3.4. Copy Client ID and Client secret

Shop data is accessed via client credentials grant:

1. From your app in the Dev Dashboard, select Settings.
2. Copy your Client ID and Client secret.
3. Paste these credentials to Authorization page in Improvado UI.

{%docs-accordion-end%}

{%docs-accordion title="Connect your own Shopify App (via Access Token, legacy)"%}

To authorize your account you need to fill in the required fields below following steps 3.1 - 3.10:

• Shop name
• Admin API access token

To do these steps you need to have Develop apps permission or ask the user with that permission to follow through.
‍

Step 3.1. In Shopify Admin, click Apps, and then click Develop apps to create your app.

Step 3.2. Click Allow custom app development.

Step 3.3. Click Allow legacy custom app development.

Step 3.4. Click Create a legacy custom app.

Step 3.5. Enter your App name, and click Create app.

Step 3.6. After app is created, go to Configuration tab and press Configure for Admin API Integration.

Step 3.7. Select the following permission scopes:

‍

Step 3.8. Go to API credentials tab and press Install app.

‍

Step 3.9. Confirm installation by clicking Install.

Step 3.10. Once app is installed, click on Reveal token once to copy and paste to Improvado authorization form.

{%docs-accordion-end%}

{%docs-accordion title="OAuth"%}

Step 3.1. Before authorization, please ensure you are signed in to the account you want to extract data from.

Step 3.2. To authorize your account you need to fill in Shop name field. Please use the same shop name from your shop URL, for example, ```my-shop-name``` if your URL is ```https://my-shop-name.myshopify.com```

Step 3.3. The following access scopes will be requested during OAuth authorization:

{%docs-accordion-end%}

Also, you can find the additional information and in-depth step-by-step guide at the links here:

• ‍Creating and installing custom app in Shopify | Docs‍
• Official video guide‍
• Get the API credentials for a custom app | Docs

Step 4. After the connection process is completed successfully, the Shopify GraphQL connection will appear in your Connected sources list.

Step 5. When the connection status is Active, and the account status column shows a number of accounts, you can move on to data extraction.

Step 6. To extract data from the connected sources, check the instruction on how to set up data extraction.

The schema information shows all report types you can use to extract data from Shopify GraphQL.