Open Navigation

Shopify

E-commerce platform for online stores and retail point-of-sale systems.

Overview

The Shopify connector currently provides operations to manage orders, fulfilments and customers in your shop.

Authentication

As of Version 1.2 the Shopify connector uses OAuth as its authentication method. So when you click on 'New Authentication' you will be presented with the following screen where you can specify the domain of your store and the permission scopes you want the Tray app to have (make sure the account you are authenticating with has the corresponding permission scopes!):

shopify-auth-2

Once you click 'Next' you will be presented with the login screen to enter your access credentials.

If using version 1.1 or earlier of the Shopify connector, create an authentication by logging in to the Shopify app, then go to the admin section, and choose Apps.

Click on Manage private apps near the bottom of the page, then click on Create a new private app.

In the App details section, enter a name for the private app and a contact email address.

In the Admin API section, select the areas of your store that you want the app to be able to access.

Click Save.

You will see the API key and API password in the Admin API section, which you will use alongside with your Shop subdomain name in the Authentication window (e.g. if your shop URL is https://traytest-123.myshopify.com you will enter traytest-123).

shopify-auth

Example - Search customers that haven't ordered anything on your shop

You can use the Search customers operation and specify orders_count:0 int the Query property. Additionally, you can specify only a set of fields that should be in the output by adding them in the Fields property such as id, name.

The Shopify Trigger

As of Version 2.0 the Shopify connector uses the same OAuth authentication method as the standard Shopify connector (version 1.2+). No further scopes are required to use the trigger.

The following steps outline how to make use of the Shopify trigger:

  1. Create the Shopify-triggered Workflow

    Create a new workflow and choose Shopify as the trigger:

    shopify-trigger-workflow

    In order to set up the webhooks in the Shopify UI, you will need to obtain the Public URL for the Workflow by clicking on the settings wheel in the top left of the screen and copying it from the settings window:

    workflow-public-url

  2. Setup subscriptions in the Shopify Admin UI

    In the Shopify admin interface (going to Settings > Notifications > Webhooks) you can set up event/topic subcriptions, entering the webhook URL obtained in step 1:

    shopify-ui-webhooks

  3. Test your webhook and extract data

    To test, you can use the 'Send test notification' function in the Shopify UI.

    Back in the Tray workflow, you can click on the Debug tab to see the webhook data coming in:

    tray-webhook-debug

    The data sent by the webhook can be extracted and used with a jsonpath beginning with $.steps.trigger.topic or $.steps.trigger.data.[field]

    For example, you could set up multiple branches to deal with different topics, or you could create a boolean branch to check if the user accepts marketing:

    shopify-boolean-1

    and take appropriate action on the True branch (note the use of { } to input the result of the jsonpath in to a string field):

    shopify-boolean-true-branch

    This is a very simplified example - you would normally use the data to update a record in Salesforce, or something similar.

If using version 1.1 or earlier, the Shopify trigger uses the same authentication method as versions 1.1 or earlier of the standard Shopify connector.

Was this article helpful?
Yes
No