# Shopify Connector

Shopify (opens new window) is an e-commerce platform that lets you manage your orders - from inventory to point of sale to shipping and returns.

# API version

This connector uses the Shopify Admin API (opens new window) version 2021-10. 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 3 months, and maintains each release version for a maximum of 12 months. That means that there will be 4 stable versions supported at any point in time.

Once a released version passed 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 2021-01, 2021-04, 2021-07, and 2021-10, then any API calls requesting for 2020-04 version will be automatically routed to the 2021-01 version by Shopify.

You may visit Shopify's API versioning (opens new window) page for more information.

# How to connect to Shopify on Workato

To connect Workato to Shopify, you need to provide the fields as detailed in the table below. There are also additional fields to input depending on the authentication type you select. These will be detailed in their individual sections.

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 We currently support (a) OAuth 2.0 or (b) access token.
Shop Name Your shop name. For example, shopname.myshopify.com/admin

There are currently 2 ways to connect to Shopify — OAuth2.0, and access token.

# OAuth 2.0

You can perform OAuth 2.0 authorization through providing your own OAuth app.

Field Description
API key The API key to connect via your own OAuth app. Required when connecting via your own OAuth app.
API secret key The API secret key to connect via your own OAuth app. Required when connecting via your own OAuth app.
[Optional] Requested permissions (OAuth scopes) The permissions to request for this connection.

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

  1. Login to your Partner account (opens new window). If you don't have one, you can register via the same link.
  2. On the left navigation, click on "Apps", and then "Create app".
  3. Click on "Create app manually" and provide a name for your app. Finally, click "Create".
  4. You will be redirected to the app dashboard which contains the API key and API secret key. Please provide them in the connection setup page on Workato.
  5. Click on the "App setup" option 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.

For more information, you may read Shopify's documentation (opens new window) on OAuth apps.

# Requested scopes

By default, we request for 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

In addition to the above, you may choose to allow Workato access to the following additional scopes:

  • write_reports
  • read_reports
  • write_payment_terms
  • read_payment_terms
  • read_product_listings

# Access token

To connect to Shopify via access token, you will need to create a custom app. Unlike OAuth 2.0 authentication type, you will need to define the permissions/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.

Follow the steps below to create a custom app and find the necessary access token:

  1. Login to Shopify, and go to "App and sales channel settings".
  2. Click on "Develop apps for your store", then "Create an app".
  3. Name the App, and then confirm by clicking on "Create an app".
  4. You will be redirected to the app dashboard. In the "Overview" tab, click on "Configure Admin API scopes", and select the required scopes. Rest assured you can still edit the scopes post-installation.

    TIP

    Please 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
  5. Click "Save", then click "Install App" at the top right corner
  6. Once the app is installed, there will be an option to get the access token. Reveal and copy the access token. Make sure to record the token somewhere secure as you can only see it one time on both Shopify and Workato.
  7. Please provide the access token in the connection setup page on Workato.

For more information, you may read Shopify's documentation (opens new window) on custom apps.

# Next

Explore the available triggers and actions:

# Triggers

# Actions