Shopify connection

The Shopify platform provides various services to online businesses, including payment processing, marketing, shipping, and customer service. The Shopify connection represents a single Shopify store (shop) and includes the authentication credentials required to interact with that store.

Prerequisites

• An active Shopify store.
• A Custom App created and installed in your Shopify store. For more information, refer to Create and install custom apps.

Authentication types

The Shopify connection supports two authentication types:

• Basic authentication: Uses an API Key and Password.
• Token authentication: Uses the Access Token.

Basic authentication

To configure basic authentication with a Custom App:

1. Log in to the Data Integration Console.

2. From the left-hand menu, click Connections.

3. In the top-right corner, click + New Connection. A list of available sources appears.

4. In the search box, type Shopify GraphQL, and select it.

5. Enter a Connection Name.

6. Under Credentials Type, select Basic.

   To retrieve and map Custom App credentials

   1. In your Shopify Admin account, navigate to Settings > Apps and sales channels > Develop apps and select your app.
   2. Go to the API credentials tab to find your keys.
   3. Map the Shopify credentials to the Data Integration connection fields as follows:

   Data Integration Field	Shopify Value	Description
   API Key	API Key	Located in the API credentials tab of your Shopify Custom App.
   Password	Admin API Access Token	Click Reveal token once in Shopify. Copy this token (starts with shpat_...) and paste it into the Password field in Data Integration. (Note: Do not use the API Secret Key).
   Store Name	Store Name	The subdomain of your shop URL, for example, if your URL is my-shop.myshopify.com, enter my-shop.

7. Enter the Shop Name.

8. Click Test Connection to verify.

Token authentication

This connection type is also used for stores accessed through Custom Apps, specifically utilizing the OAuth-style token exchange.

1. Log in to the Data Integration console.
2. From the left-hand menu, click Connections.
3. In the top-right corner, click + New Connection. A list of available sources appears.
4. In the search box, type Shopify GraphQL, and select it.
5. Enter a Connection Name.
6. Under Credentials Type, select Token.
7. Enter the Access Token (starts with shpat_...) generated in your Shopify Custom App.
8. Enter the Shop Name.
9. Click Test Connection to verify.

Webhook API version

For both authentication types, you may need to specify the Webhook API version if you are using event-based triggers.

• Select the version that matches the API version configured in your Shopify Custom App settings.
• Supported versions typically include the most recent quarterly releases. For example, 2023-01, 2023-04, and so on.

Legacy: Deprecated Private Apps

Shopify has deprecated Private Apps. You can no longer create new Private Apps in the Shopify UI.

If you have an existing connection using a legacy Private App, it will continue to function using Basic Authentication.

• API Key: Your existing Private App API Key.
• Password: Your existing Private App Password (not the Access Token).
• Store Name: Your Shop Name.