Setup Shopify

Before you can access data from users using Shopify, you need to follow the next steps in Shopify and in the Railz Dashboard.


Make sure you read Shopify's integration requirements before proceeding with this guide.

You'll need to:

  1. Create your Shopify app.
  2. Submit your app to Shopify.
  3. Add your secure keys to Railz.

Create your Shopify App

To create and configure an app in Shopify, follow the next steps:


If you dont have one, create a parner account.

  1. Log in to the Shopify Partners using your credentials.
  2. From the left sidebar navigation, click on Apps then click Create app.
Shopify Partners - Create App.

Create Apps page in Shopify partners portal. Click to Expand.

  1. In the Use Shopify Partners box on the right, click the button Create app manually.

  2. On the Create an app manually page, enter the prompted information:

    1. General settings
      1. App name: Enter a name for your app. The app name is displayed to your users when connecting, so should have your company or application name.
      2. App URL: Enter a URL for your app.

        Use this URL when you submit your app to Shopify for review.

    2. Redirection URLs
      1. Allowed redirection URL(s): Enter
  3. Click Create app. Once the app is created you will be redirected automatically to the app page where you will see your API Key & API Secret Key. You'll need these for the next steps of the process.

  4. From the left sidebar navigation, click on the App setup to view the app's settings.

Shopify Partners - App Details.

App details in the Shopify partner portal. Click to Expand.

  1. Scroll to the GDPR mandatory webhooks section of the page and enter the following mandatory Railz webhook URLs:
Customer data request endpoint
Customer data erasure endpoint
Shop data erasure endpoint

Mandatory Railz Webhooks

You will need to setup and enabled the GDPR Customer Request and Connection Disconnected webhook events. See webhooks for more details.

  1. OPTIONAL: If you need access to over 60 days of order data, scroll to the Orders section of the page. In the Read all orders box, click on the Request access button and enter the information requested and click on Request access to submit.
  2. Click the Save button that appears at the top of the page.


API Key & API Secret Key

You can check your app's API key and API secret key in the App credentials section of the App setup page. You'll need these for the next steps of the process.

Submit your App to Shopify

Your app must be approved by Shopify before you can use the integration with Railz to connect a production store. The review and approval process might take up to two weeks.


Shopify App Submission Documentation

Click here, if you prefer to use Shopify's version of the documentation below.

To submit your app to Shopify, in the Shopify Partners portal:

  1. Click the name of your app.
  2. From the left sidebar navigation, click Distribution.
  3. On the Distribution page, click Choose Shopify App Store then confirm the selection.
Shopify Partners - Sumbit App.

Submit App to Shopify page. Click to Expand.

Shopify Partners - Confirm sumbit App.

Confirm App distribution in Shopify partner portal. Click to Expand

  1. Click Create listing. If prompted for authentication, select your Shopify partner account. The App listing page for your app opens.
Shopify Partners - Choose App Distribution. Click to Expand.

Choose App distribution in Shopify partner portal. Click to Expand.

  1. Click App visibility.
Shopify Partners - App Listing Page. Click to Expand

App listing page in Shopify partner portal. Click to Expand

  1. The Manage app visibility modal will open. Select Unlisted, unless you want your app to be visible in the public Shopify App Store, and click Save.
  2. Click Start listing. The English listing page is displayed.
  3. Fill all the required fields for your listing information and click Save


App Visibility

You can choose whether to make your Shopify app listed or unlisted. Both types of apps have a public Shopify App Store URL.

  • Listed: Appears on the Shopify App Store and in recommendations to businesses.
  • Unlisted: Can be shared directly with merchants, but won't appear on Shopify App Store
  1. On the App listing page, click Submit app at the top right. The button is not available until you've completed all the required listing information. Once submitted, your app is sent to Shopify for review and approval.

Request access to consumer data

To request access, in the Shopify Partners portal:

  1. Go to Apps, and then click the name of your app.

  2. In the sidebar, click App setup.

  3. Find Protected customer data access and click Request access.

  4. Select Protected customer data. Then select the reason to use customer-protected data and then select Name and Email and their respective reasons too. After that click Save.

  5. Click Submit for review.

  6. You'll receive updates about the status of your review by email and through your Partner Dashboard. The approval can take up to 60 days.


Requesting access to Phone and Address information

After you approval in the previous steps, you will need to repeat them but in this case you will have to select Address and Phone fields.

Add your secure keys to Railz

  1. Open the Railz Dashboard™ and log in.
  2. In the left sidebar navigation menu, go to Integrations > Commerce.
  3. Scroll down to the Shopify integration and click Configure.
Railz  Dashboard - Manage Commerce Integrations. Click to Expand.

Commerce integrations page in Railz Dashboard. Click to Expand.

  1. Paste in your Client ID and Client Secret from the above steps, and then click Save & Enable.
    1. For Client ID, enter the API key from your Shopify app.
    2. For Client Secret, enter the API secret key from your Shopify app.
  2. Optional Scope Permissions
    1. To allow your businesses permission to access orders over 60 days, enable the toggle in the configure settings. Submit your request to Shopify prior to enabling.
Railz  Dashboard - Manage Commerce Integrations. Click to Expand.

Configure the Shopify integration modal. Click to Expand.

How to connect- User Guide