Shopify Guide (Custom, OAuth App)

Shopify Configuration Guide (Public, OAuth App)

Create a public Shopify app and configure it so that you can process store data through Rutter. If you are going to use a Custom App (which does not require Shopify approval), please contact support@rutterapi.com.

  1. Create a Shopify Partners Account

  2. Create and setup your Shopify app:

  3. Go to Apps → All apps → Create app

  4. Click on 'Create app manually' Create App

  5. Add your company name and the generated URLS (you can find your Rutter organization ID here):

    • App url - https://production.rutterapi.com/shopify/proxy/${YOUR_RUTTER_ORG_ID}/app-url
    • Redirect url - https://production.rutterapi.com/shopify/proxy/${YOUR_RUTTER_ORG_ID}/redirect-url URLS

  6. Click 'App setup' on the left hand side menu. Scroll down to the 'GDPR mandatory webhooks' section and paste in the generated Rutter webhook for all three fields: https://production.rutterapi.com/shopify/proxy/${YOUR_RUTTER_ORG_ID}/hmacwebhooks GDPR Webhooks

  7. Click "Save" after the GDPR information is entered

  8. Go back to the app overview page

  9. Copy and paste the 'API Key' and 'Secret API Key' into your Rutter dashboard platform credentials Keys

  10. For app installs that happen directly on the Shopify marketplace, Rutter will redirect your users to the "Direct App Install Redirect URL" on a successful authentication, passing in the public token as a query parameter. Set the Direct App Install Redirect URL at https://dashboard.rutterapi.com/platforms

  11. Your Shopify app is now in draft state and can be used to authenticate development stores only. Once your app is approved and published, you'll be able to use it to authenticate live stores.

  12. Test your Shopify App, installing it the way a Shopify Reviewer would. Before you can submit the application, the entire OAuth flow process must be working

    • Make sure you have configured a “Direct App Install Redirect URL” via https://dashboard.rutterapi.com/platforms
    • Create a development Shopify store (or use one that you already have). You can do this by opening your app page, clicking "more actions" and select test on a dev store. Click create new store, select development store. Store Store Store
    • Enter your desired test store name, store URL and log-in information as well as set a password. You do not need to check developer preview Store
    • Select store purpose as test an app or theme. Hit save and your test store will be created. Store
    • Go to your stores tab. Make sure you are logged into the store on the Store page. Then go back to your apps home page, click into your test app, and click on test on development store. Find the store you would like to test and click install App. Store Store Store
    • Click Install Anyway on the popup as this allows you to get the test stores data. Store
    • Then they will be brought to the oAuth process on Rutter to connect. Now you should expect to see Shopify store on your Rutter Dashboard (you may need to refresh) and you can start development.

Public App Approval

Once you've completed development of the app, you're now ready to submit for approval! Follow the steps below

  1. Start Development for Rutter API. And follow below instructions to get the app publicly approved.

    • Click into the app you want to get approved.
    • Fill out required Shopify fields for App Approval Submission: All fields under App Setup, App Icon (no text), GDPR mandatory webhooks must be supplied, Embedded app must be disabled. App Submission
    • If you need it, request access to more than 60 days worth of data. Data
    • Describe your app and why you need more than 60 days worth of data.
    • Embedded app must be disabled Embedded App

  2. Create the App Listing for Your Shopify App App

    • Make sure your ‘App Visibility’ for your Shopify App is ‘unlisted’ or ‘listed’ depending on whether you want your app to appear on the Shopify app store or not. Unlisted or Listed App
    • Complete the Shopify App Listing in English only, and provide screenshots where required. We recommend only filling out the required fields.
    • Invite onboarding@rutterapi.com as an owner so we can assist with problems. Invite
    • Wait for Shopify to approve the application, and communicate via the Shopify Partner team via email if there are problems.