Skip to main content

Shopify

Prerequisites for Configuring Shopify Data Source​

Shopify Store Account​

Ensure you have an active Shopify store.

Creating a Shopify Application​

  1. Create an account on Shopify and log in
  2. In Home page click on Settings
Shopify Settings
Shopify Settings
  1. Move to Apps and Sales Channels section and select Develop Apps and allow access for custom app development.
Apps and Sales Channels
Apps and Sales Channels
  1. An option to Create an app will be enabled.
Create App
Create App
  1. Enable read_ scopes under Configuration tab and Admin API Integration section.
Enable Scopes
Enable Scopes
  1. Click on Install app to complete the app creation.
Install App
Install App
  1. To retrieve API Password, move to Api Credentials tab and Reveal token once. Copy the API password and paste in the API Password field.
API Credentials
API Credentials

Steps to Obtain OAuth 2.0 Credentials​

Create a Shopify App​

  1. Log in to your Shopify Partner account
  2. Navigate to Apps in the Partner Dashboard
  3. Click Create App and provide a name for the app
  4. Select the development store where the app will be installed

Generate Client ID and Client Secret​

  1. Go to the App Credentials section of your newly created app
  2. Copy the API Key (Client ID) and API Secret Key (Client Secret) from this section

Configure App Permissions​

In the Scopes section, specify the permissions your app needs, such as:

  • read_products
  • write_orders
  • read_customers

Save the changes.

Redirect URL Configuration​

Add the Redirect URL (e.g., the URL where your connector expects the access token) in the app settings.

Generate Authorization URL​

Construct the authorization URL in the following format:

https://{shop-name}.myshopify.com/admin/oauth/authorize?client_id={API_KEY}&scope={SCOPES}&redirect_uri={REDIRECT_URL}

Replace placeholders with your Client ID, Scopes, and Redirect URL.

Authorize the App​

  1. Open the authorization URL in a browser
  2. Log in with your store credentials and approve the app
  3. Shopify will redirect you to the Redirect URL with a temporary authorization code

Exchange Code for Access Token​

Make a POST request to:

https://{shop-name}.myshopify.com/admin/oauth/access_token

Include these parameters in the request body:

  • client_id: Your API Key
  • client_secret: Your API Secret Key
  • code: The authorization code from the previous step

Retrieve Access Token​

Shopify will return a JSON response:

{
  "access_token": "shpat_abc123exampletoken",
  "scope": "read_products,write_orders"
}

Steps to Configure​

  1. Select the Source Type as Shopify
  2. Shopify Store - Enter your store name from the URL (e.g., 'NAME' from https://NAME.myshopify.com)
  3. Choose the Authentication Method:
    • API Password:
      • Paste the API Password obtained earlier
        API Password Configuration
        API Password Configuration
    • OAuth2.0:
      • Paste the Client ID, Client Secret, and Access Token
        OAuth Configuration
        OAuth Configuration
  4. Select the Replication Start Date (Format: YYYY-MM-DD)
  5. Click on Test Connection to verify if the connection is established successfully

Note: If test connection fails, verify that the app created on Shopify has all the necessary read authenticated access scopes enabled.