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).

A Patchworks app is available in the Shopify marketplace - by installing this app, you create a Patchworks connector with an authenticated instance, instantly.

API documentation

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

Installing the Shopify app (recommended)

We strongly recommend installing the Patchworks app from the Shopify marketplace - this creates a connector and adds an authenticated connector instance, seamlessly.

Step 1 Log into your Shopify admin portal and search for the Patchworks app:

Step 2 Review access requirements and click the install button:

Step 3 Click the sign in button:

Step 4 Provide your Patchworks account credentials and sign in:

Step 5 Click install latest version:

Step 6 The connector is installed with an instance - click head to Patchworks to access the Patchworks dashboard:

Step 7 In the Patchworks dashboard, you can view your new connector by selecting connectors & instances from the left-hand navigation menu:

...all your installed connectors are displayed, including Shopify:

Step 8 If you disabled Multi-Factor authentication before starting this process, you should enable it again now. Further information can be found in our Two-factor authentication guide.

Introduction

Shopify is phasing out its REST API capabilities and strongly recommends transitioning to GraphQL. If you've been using the Shopify connector with REST API endpoints, we advise updating the connector from the Patchworks marketplace, so GraphQL endpoints are available.

When browsing endpoints for the latest Shopify connector, you'll find that REST API endpoints are prefixed with the word LEGACY, and GraphQL endpoints are available:

A key advantage of GraphQL is that connector endpoints can be configured with queries that request only the data needed, minimising information over and under-fetching.

Our Shopify connector includes a range of predefined GraphQL endpoints with queries for different entity types (products, customers, orders, etc.). However, GraphQL is so flexible that you may want to add custom endpoints to the Shopify connector, with more targeted queries for your needs. This guide walks through the steps needed to achieve this.

Preparation

Ensure that your Patchworks Shopify connector is up to date. For more information please see Updating a connector.

The steps

Our suggested approach for adding custom GraphQL endpoints is to take a copy of an existing endpoint with similar properties and then edit the copy as needed. These steps are detailed in two stages:

• Stage 1: Clone an existing endpoint

• Stage 2: Edit your new endpoint

Stage 1: Clone an existing endpoint

Step 1 Log in to the Patchworks dashboard and select process flows from the left-hand navigation menu:

Step 2 Select connectors & instances:

Step 3 Click the settings icon associated with your Shopify connector:

Step 4 You're now in the connector builder - click the endpoints option:

Step 5 Find an existing GraphQL query that's similar to the one you want to add. For example, if your new query relates to retrieving customer records, the GraphQL Retrieve a list of customers endpoint would be a good option:

Step 6 Scroll to the right and select the clone option:

Step 7 You'll see two confirmation messages - the first advising that the clone task is queued and the second confirming when the task is completed (these are typically instant but may take longer in busy times) - for example:

Step 8 Refresh the page (CTRL+ R or CMD+ R). Now you should see a copy of the endpoint with an incremented number in brackets - for example:

Stage 2: Edit your new endpoint

Step 1 Click the name of the newly cloned endpoint:

You're now viewing the setup for this endpoint, with general details in the upper panel and a series of tabs in the lower panel:

Step 2 Change the name to reflect the purpose of this endpoint (the name entered here is displayed to users when configuring connector shapes in process flows) - for example:

Step 3 Update remaining fields in this panel, if necessary:

Step 4 Move down to the lower panel (where the authentication tab is displayed) and toggle token authentication to on:

...you'll see a confirmation message when this authentication method is added:

Step 5 Not all endpoints require variables - check the Shopify API documentation and if needed, click the variables tab to add them:

Step 6 Click the URL tab and set the following options:

For example:

Step 7 Click the header tab. Unless the Shopify API documentation states otherwise, header information is always the same, so the details shown for your cloned endpoint don't need to be changed:

Step 8 Click the body tab - here you'll find the GraphQL query for the endpoint you cloned earlier:

...from here, you can edit the existing query as needed.

Step 9 Schemas aren't required for GraphQL queries. With so much flexibility to control what fields are returned by queries, adding a schema can often become confusing and difficult to maintain - general (though not mandatory) advice is to ignore the schema tab for GraphQL endpoints.

Step 10 Click the pagination tab and set the following options:

For example:

Step 11 Save changes to return to the list of endpoints:

Introduction

We strongly recommend installing the Patchworks app from the Shopify marketplace - this creates a connector and adds an authenticated connector instance, seamlessly - there's no need for you to obtain your own tokens for authentication and apply them to your connector instance manually.

However, if for some reason you do need to create/update a Shopify instance manually, this guide shows how to obtain a Shopify token.

Required credentials

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

Creating a custom app for credentials

To obtain an API token, you must access your 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 for your Shopify store for use in .

The steps required are summarised below.

Stage 1: Create a new app 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 an appropriate name. For example:

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.

Stage 2: Configure API scope

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.

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:

c