Shopify Custom App Installation Guide (Legacy and Dev Dashboard)

There are currently two ways to install a Shopify Custom App:

• Legacy Method (Old – being phased out by Shopify)
• Dev Dashboard Method (New – Recommended and supported)

1. Legacy Method (Old Installation Method)

This method was previously used when custom apps were created directly inside the merchant’s Shopify admin.

Step 1: Create Custom App in Shopify Admin

1. Login to the merchant’s Shopify Admin
2. Go to Settings → Apps and sales channels
3. Click Develop apps
4. Click Create an app
5. Enter the app name and create the app

Step 2: Configure Admin API Scopes

1. Open the app
2. Go to Configuration → Admin API integration
3. Enable the following scopes:
4. Save the configuration

Step 3: Install the App

1. Click Install App
2. After installation, copy the Admin API Access Token

Step 4: Add Credentials in XStak Merchant Portal

1. Login to XStak Merchant Portal
2. Navigate to Settings → Store Info → Shopify App Details
3. In Custom App Credentials section:

✅ This will automatically configure tokens for all installed apps.

Step 5: Verification

• Place a test order on the Shopify store
• Confirm the order id is successfully mapped against the order on XAP

2. Dev Dashboard Method (New – Recommended)

Shopify has now made the Legacy method unavailable for many merchants.

This is the new and recommended approach.

Custom apps are now created from the Shopify Partner (Dev) Dashboard.

Step 1: Create App in Shopify Partner Dashboard

1. Login to Shopify Partner Dashboard
2. Go to Dev Dashboard, Apps → Create App
3. Add App Name and click Create

Step 2: Configure App Settings

Use the following configuration:

App Settings:

• Use legacy install flow: false (uncheck)
• Embedded app: false (uncheck)
• App URL:

Access Scopes:

• read_orders
• write_orders

Step 3: Create and Release App Version

1. After filling above details, Click Release

Step 4: Configure App Distribution

1. Go to Distribution and select Custom App Distribution
2. Add the merchant’s Shopify Store URL

Example:

merchant-store.myshopify.com

1. Save changes

Step 5: Get Client Credentials

1. Go to:
2. Copy:

Step 6: Add Credentials in XStak Merchant Portal

1. Login to XStak Merchant Portal
2. Navigate to: Settings → Store Info → Shopify App Details
3. In Custom App Credentials section:
4. Click Submit button

✅ This will automatically add access tokens for all apps

Step 6: Install App

1. Now, Install the Custom app on the shopify store (Important: First add Client Id and Secret on XAP, then install app on the store.)

Step 7: Verification

• Place a test order on Shopify store
• Confirm the order is successfully mapped in the system

Summary

Recommendation

Always use the Dev Dashboard method for new installations, as Shopify is phasing out the Legacy method.