# Shopify

Shopify (opens new window) is an e-commerce platform that allows businesses to create online stores and sell products.

# API version

This connector uses the Shopify REST Admin API (opens new window) version 2024-04. You can monitor the availability of the API and other services through the Shopify Status (opens new window) page.

HOW DOES SHOPIFY HANDLE ITS API VERSION UPGRADES?

Shopify generally releases a new version every three months, and maintains each release version for a maximum of twelve months. That means that there will be four stable versions supported at any point in time.

Once a released version passes its one year mark, Shopify will no longer maintain that version, and any API calls requesting that version will be automatically routed to the oldest stable version currently supported.

For instance, if the current available stable versions are 2023-07, 2023-10, 2024-01, and 2024-04, then any API calls requesting for 2023-04 version will be automatically routed to the 2023-07 version by Shopify.

Refer to Shopify's API versioning (opens new window) page for more information.

# How to connect to Shopify on Workato

To connect Workato to Shopify, you must provide the fields detailed in the following table. Additional input fields appear depending on the authentication type you select.

Field	Description
Connection name	Give this connection a unique name that identifies which Shopify instance it is connected to.
Location	Specify where in the project you want to store the connection in.
Authentication type	Select the authentication method for your connection.
Shop Name	Your shop name. For example, shopname.myshopify.com/admin
Custom OAuth profile	When selected, all requests to the app will use the profile specified in Workato (opens new window). You can create a new profile in-app (opens new window). It ensures that the connection is restricted to the same set of scopes selected in the profile for all users with the profile, and the authentication flow uses the client app linked to the custom profile.

You can connect to Shopify using the following authentication methods:

# OAuth 2.0

Provide your own OAuth app to perform OAuth 2.0 authorization. This OAuth app should be registered as a custom OAuth profile in Workato. Select the registered custom OAuth profile to connect to Shopify through it.

Field	Description
Requested permissions (OAuth scopes)	Optional. The permissions (opens new window) to request for this connection.

To create your own OAuth app, you will need a Shopify Partner account. Complete the following steps to locate the necessary client ID and client secret:

Click Apps > Create app.

Click Create app manually and provide a name for your app.

Click Create.

Shopify redirects you to the app dashboard, which contains the API key and API secret key. Create a custom OAuth profile using the API key and API secret key on Workato.

Click App setup on the left navigation. Type https://www.workato.com into the App URL and https://www.workato.com/oauth/callback into the Allowed redirection URL(s) fields.

Refer to the Shopify documentation (opens new window) on OAuth apps for more information.

PUBLISHED PUBLIC CUSTOM APPS REQUIRE APPROVAL TO ACCESS CUSTOMER PROTECTED DATA

As of version 2022-10, published public custom apps are required to satisfy Shopify's data protection policy (opens new window) to process customer data. If you are connecting through a published public custom app, you will need approval (opens new window) to access customer protected data.

This requirement does not apply if you connect through custom apps (using access token authentication) or unpublished custom apps.

# Requested scopes

By default, we request the following scopes when setting up a connection to Shopify:

read_customers
write_customers
read_inventory
write_inventory
read_products
write_products
read_orders
write_orders
read_draft_orders
write_draft_orders

Along with the default scopes, you can grant Workato access to the following additional scopes

write_reports
read_reports
write_payment_terms
read_payment_terms
read_product_listings
read_assigned_fulfillment_orders
write_assigned_fulfillment_orders
read_merchant_managed_fulfillment_orders
write_merchant_managed_fulfillment_orders
read_third_party_fulfillment_orders
write_third_party_fulfillment_orders
read_all_orders

MINIMUM REQUIRED SCOPE TO ESTABLISH CONNECTION

The minimum scope required to establish a connection is read_products.

# Access token

To connect to Shopify using an access token, you must create a custom app. Unlike OAuth 2.0 authentication, you must define the permissions or scopes within the custom app configuration page.

Field	Description
Access token	The access token provided when installing your custom app. Record the token somewhere secure as you can only see it one time on both Shopify and Workato.

Complete the following steps to create a custom app and locate the necessary access token:

Click Develop apps for your store > Create an app.

Name the app, and then click Create an app.

Shopify redirects you to the app dashboard. In the Overview tab, click on Configure Admin API scopes, and select the required scopes. You can edit the scopes after the installation.

MINIMUM SCOPES REQUIRED

Ensure that the app has at least read_products permission scope to successfully connect Workato to Shopify.

The recommended set of scopes are:

read_customers
write_customers
read_inventory
write_inventory
read_products
write_products
read_orders
write_orders
read_draft_orders
write_draft_orders

Click Save > Install App.

After the app is installed, reveal and copy the access token. Be sure to record the token in a secure location, as you can only see it once in Shopify and Workato.

Navigate to the connection setup page in Workato and provide the access token.

Refer to the Shopify documentation (opens new window) on custom apps for more information.