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.

API documentation

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

REST

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

GraphQL

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

GraphQL is preferred for Shopify APIs - REST API endpoints will be deprecated in the coming months.

Starting in 2025, Shopify will phase out key REST API capabilities. By February 2025, public apps using REST product APIs must migrate to GraphQL, with custom apps needing to follow suit by April 2025 (for handling more than 100 variants). Additionally, checkout mutations in REST will be unavailable from April 2025. Shopify strongly recommends transitioning to GraphQL to avoid disruptions and ensure smoother, more efficient integrations.

Please refer to the Shopify API Documentation for details on key deprecation dates.

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.

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:

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

4

Start the installation

Click the install latest version button:

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

5

Start the installation

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:

The instance name is the same as your Shopify store - you can change this later if necessary.

6

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.