Skip to Content

Prerequisites for the Shopify connector in Jitterbit Studio

Introduction

These are the prerequisites for using 3-legged OAuth 2.0 (3LO) authentication with the Shopify connector. You first create a Shopify custom app, and then configure 3-legged OAuth by registering the app in the Management Console App Registrations page.

Note

Agent version 10.83 / 11.21 or later is required to use 3-legged OAuth 2.0 authentication.

Create a Shopify custom app

Follow the Shopify documentation to create an app for your Shopify store.

When configuring your app, select the Admin API access scopes required for the Shopify activities you plan to use, and ensure the redirect URL for your organization's region is added to the app's allowed redirect URLs:

Region URL
APAC https://apps.apac-southeast.jitterbit.com/design-studio/api/v1/oauth/authcode
EMEA https://apps.emea-west.jitterbit.com/design-studio/api/v1/oauth/authcode
NA https://apps.na-east.jitterbit.com/design-studio/api/v1/oauth/authcode

Once the app is created, note the Client ID and Secret from the Credentials section of the app's Settings page. These are required when configuring the app registration.

Configure 3-legged OAuth

This section covers the steps for registering the Shopify custom app in the Management Console App Registrations page.

To register the app, follow these steps on the App Registrations page:

  1. Set Connector to Shopify.

  2. Enter the Client ID from the Credentials section of the app's Settings page.

  3. Enter the Client Secret, using the Secret value from the Credentials section of the app's Settings page.

  4. Enter the Scope values matching the Admin API access scopes configured for the app, as a space-separated list. For a list of available scopes, see Access scopes in the Shopify documentation.

  5. Set Authentication URL to https://{shop}.myshopify.com/admin/oauth/authorize, replacing {shop} with your Shopify store name.

  6. Set Access token URL and Refresh token URL to https://{shop}.myshopify.com/admin/oauth/access_token, replacing {shop} with your Shopify store name.

  7. Under Advanced options, on the Token request tab, add a parameter with Key expiring, Value 1, and Send in set to Request Body. This setting enables access token rotation, which is required for the Shopify connector to process the token response correctly. Setting expiring=0 issues a non-expiring token and is not supported.

Once the app is registered on the App Registrations page, it is available to be selected in the OAuth Application menu under Private Applications in the Shopify connection.