Shopify (prebuilt connector)

Description

Shopify is a cloud-based, fully hosted commerce platform which can be used to create and manage online stores, and sell across multiple channels ( including web, mobile, social media, online marketplaces, brick-and-mortar locations, and pop-up shops).

API documentation

API documentation for Shopify (used to build this connector) can be found via the link below:

Authentication

When adding connector instances for Shopify, the following authentication methods are supported:

Token-based authentication

Token-based authentication

When a user chooses to add a connector instance using token-based authentication, the credentials below are prompted:

Credential Required? Notes

Credential	Required?	Notes
`store_name`		The URL used to access a Shopify store always follows the convention: `https://your-store-name.myshopify.com`. For example, the URL for our 'Patchworks Docs Demo' store is: `https://patchworks-docs-demo.myshopify.com` When adding credentials for a new instance, you only need to provide the name of your store - don't enter `https://` and don't enter `.myshopify.com`. So taking our example, the store would be entered as: `patchworks-docs-demo`.
`token`		Generated in your Shopify admin portal - see the Obtaining credentials tab.

store_name

The URL used to access a Shopify store always follows the convention:

https://your-store-name.myshopify.com. For example, the URL for our 'Patchworks Docs Demo' store is:

https://patchworks-docs-demo.myshopify.com

When adding credentials for a new instance, you only need to provide the name of your store - don't enter https:// and don't enter .myshopify.com. So taking our example, the store would be entered as: patchworks-docs-demo.

token

Generated in your Shopify admin portal - see the Obtaining credentials tab.

Whenever a process flow sends a Shopify API request using token-based authentication, Shopify's X-Shopify-Access-Token option is passed in the request header. The value is set to whatever token was provided when the associated connector instance was added.

To obtain an API token, you need to access your Shopify admin portal and create/install a new Patchworks Integration app. At the end of this procedure you will be given an API token - this token should be used when adding connector instances for your Shopify store for use in process flows.

The steps required are summarised below.

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:

[Enter your customer name] 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: