# Shopify (prebuilt connector)

## Description

[Shopify](https://www.shopify.com/) 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](https://apps.shopify.com/patchworks). When you [install this app](#installing-the-shopify-app-recommended), you add a Patchworks connector with an authenticated instance, instantly.

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FXhtbIQ5q9IQ5iOsYIkLc%2Fshopify%20app%20install%201.png?alt=media&#x26;token=8ad5fec9-df7b-4c3e-a215-9893a4567626" alt=""><figcaption></figcaption></figure>

## API documentation

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

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>GraphQL</strong></td><td><a href="https://shopify.dev/docs/api/admin-graphql">https://shopify.dev/docs/api/admin-graphql</a></td><td></td><td></td></tr><tr><td><strong>REST (deprecated)</strong></td><td><a href="https://shopify.dev/docs/api/admin-rest">https://shopify.dev/docs/api/admin-rest</a></td><td></td><td><a href="https://shopify.dev/docs/api/admin-rest">https://shopify.dev/docs/api/admin-rest</a></td></tr></tbody></table>

{% hint style="info" %}
If you've been using the Shopify connector with REST API endpoints (either [installed via our Shopify app](#installing-the-shopify-app-recommended) or the [Patchworks marketplace](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/working-with-connectors/installing-a-connector)), we advise [updating the connector from the Patchworks marketplace](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/working-with-connectors/updating-a-connector), so GraphQL endpoints are available.&#x20;

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](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/patchworks-connectors/shopify-prebuilt-connector/adding-a-custom-graphql-endpoint-for-shopify).
{% endhint %}

## Tax handling for sales channels

{% hint style="warning" %}
Are you integrating Shopify with accounting, ERP, or other business systems where sales tax is considered? If so, please read the following.&#x20;
{% endhint %}

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?&#x20;

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&#x20;

### 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.&#x20;

If using the API, Shopify provides a field called [`channel_liable`](https://shopify.dev/docs/api/admin-graphql/2025-10/objects/TaxLine#field-taxline-channelliable). 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.&#x20;

## 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](https://app.wearepatchworks.com/register) or [contact our Sales team](https://www.wearepatchworks.com/pages/contact-us).

{% hint style="warning" %}
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](https://doc.wearepatchworks.com/product-documentation/registration/two-factor-authentication-2fa#disabling-2fa-for-your-patchworks-login) if you're unsure how to do this.
{% endhint %}

{% stepper %}
{% step %}
**Locate the Patchworks app in Shopify**

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

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2Fc3ho4mvjiXxJEZg6spRB%2Fshopify%20app%20install%201a.png?alt=media&#x26;token=f05f6f88-652b-4f66-8f24-6e59c63c9fa9" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Review access requirements**

Review access requirements and click the *install* button:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2Fwx02GxkSojrJOzN0gVbo%2Fshopify%20app%20install%202b.png?alt=media&#x26;token=001e421e-2c24-48dc-9e7f-c7f2c5e67746" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Provide your Patchworks account credentials**

Click the `sign-in` button:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FjbAlB9ORoLQjTCgPqfp7%2Fshopify%20app%20install%205.png?alt=media&#x26;token=7022e92e-736e-44f0-becc-16e031e52431" alt=""><figcaption></figcaption></figure>

Then enter the credentials that you use to sign in to the Patchworks dashboard:

<div align="left"><figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FInJKt0IUbvt9EXW5Wiyd%2Fshopify%20app%20install%206a.png?alt=media&#x26;token=4dcfcb2d-7270-492d-9512-56c87c6b3d07" alt="" width="563"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Start the installation**

Click the `install latest version` butto&#x6E;*:*

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2F5iKqhZSikWUEJhV4SVsI%2Fshopify%20app%20install%207.png?alt=media&#x26;token=8b029d79-4f3a-4bfe-8ec3-9631143cb2e0" alt=""><figcaption></figcaption></figure>

The connector is installed with an instance - click `head to Patchworks` to access the Patchworks dashboard:&#x20;

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FaUHVnr8KW7SHeSLdDhxz%2Fshopify%20app%20install%208.png?alt=media&#x26;token=63150351-ffef-4f87-8e1a-dacc0779db84" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Start the installation**

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

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FYmrNUDY4R4bH5SQ9Qi5Q%2Fshopify%20app%20install%209.png?alt=media&#x26;token=e7cc9e1a-5abe-48d1-a473-5a8d074c4430" alt=""><figcaption></figcaption></figure>

All your installed connectors are displayed, including Shopify:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FGPxF5t5HwAXTf6X1Duj2%2Fshopify%20app%20install%2010.png?alt=media&#x26;token=e5d92ad2-99e3-41ee-870c-14ec0e9a3b7e" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
The instance name is the same as your Shopify store - you can [change this later if necessary](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/working-with-instances).
{% endhint %}
{% endstep %}

{% step %}
**Re-enable multi-factor authentication**

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](https://doc.wearepatchworks.com/product-documentation/registration/two-factor-authentication-2fa).
{% endstep %}
{% endstepper %}