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

A Patchworks app is available in the Shopify marketplace. When you install this app, you add a Patchworks connector with an authenticated instance, instantly.

Alternatively, you can use custom apps

API documentation

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

GraphQL

https://shopify.dev/docs/api/admin-graphql

REST (deprecated)

https://shopify.dev/docs/api/admin-rest

If you've been using the Shopify connector with REST API endpoints (either installed via our Shopify app or the Patchworks marketplace), we advise updating the connector from the Patchworks marketplace, so GraphQL endpoints are available.

Having updated the Shopify connector, you should then edit process flows where the Shopify connector is used and switch any REST API endpoints to a GraphQL equivalent. If you can't find a GraphQL endpoint that you need, you can add your own.

Tax handling for sales channels

Are you integrating Shopify with accounting, ERP, or other business systems where sales tax is considered? If so, please read the following.

When selling products across different sales channels (online store, social media, marketplace platforms, etc.) and building integrations to accounting, ERP, or other business systems where sales tax is considered, it's important to know where the responsibility for remitting sales tax lies - is it with the merchant, or is it handled via the sales channel?

For example, since January 2025, Shopify automatically calculates, collects, and remits tax for orders placed through the Shop channel in the US. If these orders are treated the same as 'normal' Shopify orders in your integrations, there’s a risk of processing tax twice

What you need to do

In this scenario, check whether the Shopify sales channel is set as being responsible for tax. You can do this via the Shopify admin portal, or via the API.

If using the API, Shopify provides a field called channel_liable. If this is set to true, it means tax has already been calculated and collected by the channel. In this case, your integration should not recalculate or reapply tax.

Installing the Shopify app

You must have a Patchworks account to install the app. If you don't have an existing account, you can register for a trial account or contact our Sales team.

If Multi-factor authentication is enabled for your Patchworks account, it must be disabled (temporarily) before completing the steps below. Please see Disabling 2FA for your Patchworks login if you're unsure how to do this.

1

Locate the Patchworks app in Shopify

Log in to your Shopify admin portal and search for the Patchworks app:

2

Review access requirements

Review access requirements and click the install button:

3

Provide your Patchworks account credentials

Click the sign-in button:

This will open the Patchworks Dashboard, enter your credentials to sign in to the Patchworks dashboard:

4

Installation the Shopify Connector

In the Patchworks dashboard head to the Marketplace and install the latest Shopify connector:

When installation is complete you will be redirected to the connectors & instances menu:

5

Click Add new Instance

Enter an appropriate name for your instance, we recommend using your store name

Select the required settings for your connector, more information can be found here on Connection Pools.

Select the PATCHWORKS APP AUTHENTICATION, this is already setup with the required credentials needed to authenticate against shopify using the Patchworks Shopify App.

Enter your store name as found in the Shopify settings, E.G customer-peaks-1.

When you click create the oauth2 process will be initiated, this will make a request to Shopify to get credentials, you must be logged into your Shopify store and have the same permissions that the app required.

6

Connected - Once complete you will see a new instance within your connector.