Shopify App Setup
This guide walks through creating a custom app in Shopify Partner Dashboard for a merchant you want to onboard.
Step 1: Open Shopify Partner Dashboard
Go to partners.shopify.com and log in.

Step 2: Navigate to Apps
Click Apps in the left sidebar, then click Create app.

Step 3: Select Custom App
When prompted, select Custom app (also called "single-merchant app").
Step 4: Configure the App

App Name
This helps you identify which app belongs to which merchant when managing multiple apps. Use a descriptive name that identifies both your channel and the merchant:
Example:
YourChannel - Merchant Store Name
App URL
Live Mode
https://connect.violet.io/{YOUR_APP_ALIAS}
Test Mode
https://connect.violet.dev/{YOUR_APP_ALIAS}
Redirect URI
The Redirect URI must match the App URL host and include the Shopify connect path:
Live Mode
https://connect.violet.io/{YOUR_APP_ALIAS}/platforms/shopify/connect
Test Mode
https://connect.violet.dev/{YOUR_APP_ALIAS}/platforms/shopify/connect
Example: If your App Alias is acme-shopping, your Live Mode Redirect URI is: https://connect.violet.io/acme-shopping/platforms/shopify/connect
Required API Scopes
Select all 26 required API scopes listed below. Missing scopes will cause features to fail after the merchant connects.
Step 5: Release your App
This will submit and create your new App.
Step 6: Select Custom Distribution
After creating the app, you must select the distribution method to generate an Install Link.

Click "Select custom distribution" to confirm

Step 6: Add your store domain to generate the Install Link
After selecting custom distribution, add your store domain and select the CTA to generate the link. Upon success, you should see the Distribution page with your Install Link.

Click the Copy button next to the Install Link
Use it in the pre-registration in Violet (Step 8), once the merchant is ready to install
The Install Link format should resemble this:
Step 7: Copy Credentials
After creating the app, go to "Settings" in the dev dashboard to reveal the Client ID and Client Secret. You will need this for the next step.

Step 8: Create Pre-Registration in Violet
Now that you have your Install Link, Client ID, and Client Secret, go to Channel Dashboard to create a pre-registration for this merchant.
Summary
Before moving on, confirm you have:
Once you have completed all of these items, proceed to Pre-Registration Process
Help
Have questions or running into issues? See Troubleshooting & FAQs for common problems and solutions.
Last updated
Was this helpful?