Setup Guide

You can find your Shopify application credentials by visiting your Shopify Partner Dashboard.

You'll need the following information to set up your Shopify App with Paragon:

• API Key

• API Secret Key

• Scopes Requested

Prerequisites

• Shopify Developer account, also known as a Shopify Partner account. You can create one here.

• Shopify development store. Learn more about creating a development store here.

• Shopify application. Learn more about creating a Shopify application here.

Add the Redirect URL to your Shopify app

Paragon provides a redirect URL to send information to your Shopify app. To add the redirect URL to your Shopify app:

1. Copy the link under "Redirect URL" in your integration settings in Paragon. The Redirect URL is:

https://passport.useparagon.com/oauth

2. Log in to your Shopify Partner Dashboard and select your app.

3. Navigate to App setup > URLs > Allowed redirection URL(s)

4. Paste-in the Redirect URL from Paragon in "Allowed redirection URL(s)".

5. Press the Save button at the top of the page to save your changes.

Add a development store to your Shopify app

1. Log in to your Shopify Partner Dashboard.

2. Click Apps on the sidebar.

3. Select your Shopify application.

4. In the Test your app section, press the Select store button.

5. Choose the development store you'd like to connect to.

Add your Shopify app to Paragon

1. Select Shopify from the Integrations Catalog.

2. Under Integrations > Connected Integrations > {YOUR_APP} > Settings, fill out your credentials from the end of Step 1 in their respective sections:

• API Key: Found under Apps > App setup > App credentials > API key on your Shopify app page.

• API Secret Key: Found under Apps > App setup > App credentials > API secret key on your Shopify app page.

• Permissions: Select the scopes you've requested for your application. A complete list of Shopify's scopes is here.

Press the blue "Connect" button to save your credentials.

Connecting to Shopify

Once your users have connected their Shopify account, you can use the Paragon SDK to access the Shopify API on behalf of connected users.

See the Shopify REST API documentation for their full API reference.

Any Shopify API endpoints can be accessed with the Paragon SDK as shown in this example.

// You can find your project ID in the Overview tab of any Integration
​
// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
​
// Create Customer
await paragon.request("shopify", "/admin/api/2020-10/customers.json", { 
  method: "POST",
  body: { 
    "first_name": "John",
    "last_name": "Norman",
    "email": "[email protected]",
    "phone": "+16135551111",
    "note": "Creating customer for testing",
    "tags": ["tag1","tag2"]
   }
});
​
​
// Query Customers
await paragon.request("shopify", "/admin/api/2020-10/customers.json", { 
  method: "GET"
});
  

Building Shopify workflows

Once your Shopify account is connected, you can add steps to perform the following actions:

• Get customers

• Search customers

• Create customer

• Update customer

• Get orders

• Create order

• Update order

• Get products

• Create product

• Update product

When creating or updating records in Shopify, you can reference data from previous steps by typing {{ to invoke the variable menu.