Finding service connector credentials for Shopify (token auth)

PreviousShopify / Shopify+ (service connector)NextFinding service connector credentials for Shopify (legacy auth)

Finding service connector credentials for Shopify (token auth)

Required credentials

To for Shopify, the following details are required for token auth authentication:

Credential

Required

Note

This is the URL that you use to log in, but can also be confirmed as part of the process for obtaining a new access token. TIP: ensure the "http://" prefix of the URL and the "/" suffix are not included in the store URL as Shopify will reject them.

Obtained by adding a new app for your Shopify store.

Make sure that your store URL does not have a forward slash (/) at the end.

Obtaining credentials

The steps detailed below show how to obtain the required credentials for token auth:`

Stage 1: create a new app for your store

Step 1 Log into the Shopify admin portal for your store.

Step 2 Select apps from the left-hand navigation menu:

Step 3 Select App and sales channel settings:

Step 4 Check the URL at the top of the left-hand navigation panel and add it to your password manager, ready for your Patchworks setup:

This is the same URL that you use to log into the admin portal.

Step 5 Click the develop apps for your store button:

Step 6 Click the create an app button:

...the create an app form is displayed:

Step 7 In the app name field, enter the following:

Patchworks Integration

Step 8 Select an app developer from the dropdown list. This can be the store owner or any staff/collaborator account with the develop apps permission.

Step 9 Click the create app button:

...details for the new app are shown:

Step 9 Go directly to stage 2 below.

Stage 2: configure API scope for the new app

Step 1 Click the configure admin API scopes button:

Step 2 From the admin API access scopes page, select checkboxes to enable all API access scopes:

Step 3 Scroll down to the webhook subscriptions panel and ensure that the (latest) option is selected from the dropdown list:

Step 4 Click the save button at the end of this page:

Step 5 Go directly to stage 3 below.

Stage 3: install the new app

Step 1 Click the install app button at the top of the page:

...the API credentials page is displayed.

Step 2 In the top admin API access token panel, click the reveal token once option:

Step 3 Copy this token and add it to your password manager, ready for use in your Patchworks setup:

Legacy auth

Shopify changed authentication requirements recently and the steps required to obtain details are shown above. For reference, legacy details are retained below.

Shopify legacy authentication

Required credentials for legacy auth

API Key
API Secret Key
Admin API access token
Store URL (make sure that your store URL does not have a forward slash (/) at the end)

Obtaining credentials for Legacy Auth

The steps detailed below are for Shopify's legacy authentication.

Step 1 Log in to your Shopify admin portal for the required store.

Step 2 Select settings from the left-hand navigation menu:

Develop apps:

Step 3 Click Allow custom app development.

Step 4 Read the warning and information provided, and then click Allow custom app development.

Step 5 Click Create an app.

Step 6 In the modal window, enter the App name and select an App developer. The app developer can be the store owner, or any staff or collaborator account with the Develop apps permission.

Step 7 Click Create app.

Step 8 Click Configure Admin API scopes.

Step 9 Enable all Admin API access scopes.

Step 10 Set the latest webhook subscription event version.

Step 11 Click Save.

Step 12 Click Install app.

Step 13 Read the warning and information provided, and then click Install.

The required credentials will have been generated in the API credentials section. Please make a note of the following: