Shopify Guide (Custom, OAuth App)

Shopify Configuration Guide (Custom, OAuth App)

Create a custom Shopify app and configure it so that you can process store data through Rutter. Custom apps do not require Shopify approval and can be used immediately. Make sure you have an active Rutter account and can access dashboard.rutterapi.com.

Note: Shopify migrated app creation from the Partner Dashboard to the new Dev Dashboard at dev.shopify.com/dashboard. The old "Apps → All apps → Create app → Create app manually" flow no longer exists. Follow the steps below for the updated 2026 flow.

Before You Start

Make sure you have:

  1. A Shopify Partners account — sign up at partners.shopify.com/signup if you don't have one
  2. An active Rutter account with access to dashboard.rutterapi.com
  3. Your Rutter Organization ID — found at dashboard.rutterapi.com/settings
  4. Node.js installed on your machine (needed for the GDPR webhook step)

Part 1: Create the App

  1. Go to dev.shopify.com/dashboard and log in with your Shopify Partners credentials
  2. Select Apps in the left sidebar
  3. Click Create app (top right corner)
  4. Select "Start from Dev Dashboard" — do NOT select "Start from Shopify CLI"
  5. Enter an app name (e.g. "YourCompanyName")
  6. Click Create

Part 2: Configure a Version

After creating the app, you need to create a version before the app can be installed on any store.

  1. Go to the Versions tab of your new app in the Dev Dashboard
  2. Set the App URL to (replace YOUR_RUTTER_ORG_ID with your Rutter Org ID from dashboard.rutterapi.com/settings):
    • https://production.rutterapi.com/shopify/proxy/${YOUR_RUTTER_ORG_ID}/app-url
  3. Add the Allowed redirection URL:
    • https://production.rutterapi.com/shopify/proxy/${YOUR_RUTTER_ORG_ID}/redirect-url
  4. Select the newest Webhooks API version from the dropdown
  5. Select the required scopes for your use case:
    1
    read_orders
    

    2
    read_customers
    

    3
    read_product_listings
    

    4
    read_products
    

    5
    read_locations
    Add write_orders, write_products, or write_customers if you need write access.
  6. Click Release

Part 3: Configure GDPR Compliance Webhooks (Requires CLI)

Shopify requires three GDPR compliance webhook endpoints for every app. This step requires the Shopify CLI — there is no way to configure this through the dashboard UI.

  1. Install the Shopify CLI:

    1
    npm install -g @shopify/cli

  2. Create a new folder and add a single file called shopify.app.toml with the following content (replace CLIENT_ID_FROM_DEV_DASHBOARD_SETTINGS with the Client ID from Dev Dashboard → Settings, and YOUR_RUTTER_ORG_ID with your Rutter Org ID):

    1
    client_id = "CLIENT_ID_FROM_DEV_DASHBOARD_SETTINGS"
    

    2
    

    3
    [webhooks]
    

    4
    api_version = "2026-01"
    

    5
    

    6
    [[webhooks.subscriptions]]
    

    7
    compliance_topics = ["customers/data_request", "customers/redact", "shop/redact"]
    

    8
    uri = "https://production.rutterapi.com/shopify/proxy/YOUR_RUTTER_ORG_ID/hmacwebhooks"

  3. Run the deploy command from that folder:

    1
    shopify app deploy

Part 4: Get API Credentials

  1. In the Dev Dashboard, go to Settings in the left nav of your app
  2. Copy the Client ID and Client Secret
  3. Go to dashboard.rutterapi.com/platforms/shopify
  4. Paste the Client ID and Client Secret into the Shopify configuration fields
  5. Click Save

Note: In the old flow, these were called "API Key" and "Secret API Key" on the app overview page. They are now called "Client ID" and "Client Secret" under Settings.

Part 5: Test on a Development Store

  1. In the Dev Dashboard, go to Stores in the left sidebar
  2. Click Create store, enter a store name, and click Create store
  3. Log into the new dev store
  4. Go back to the app's Home page in the Dev Dashboard
  5. Click Install app
  6. Select the dev store you just created → click Install
  7. Complete the Rutter OAuth flow
  8. Check dashboard.rutterapi.com for the new Shopify connection (you may need to refresh)

If you have configured a "Direct App Install Redirect URL" at dashboard.rutterapi.com/platforms, you will be redirected there after successful authentication.

Your custom Shopify app is now set up and ready to use. No Shopify approval is required for custom apps — you can authenticate stores immediately.