Prerequisites
- A Shopify store with an active plan
- Access to your Shopify Admin dashboard
Create a Custom App in Shopify
- Log in to your Shopify Admin
- Go to Settings → Apps and sales channels → Develop apps
- Click Create an app and give it a name (e.g. “Komerza Integration”)
- Under Configuration → Admin API integration, click Configure and enable the following scopes:
write_draft_ordersread_draft_ordersread_orderswrite_orders
- Click Save
All four scopes are required. Missing any of them will cause connection errors later.
Copy Your API Credentials
- In your Shopify app, go to the API credentials tab
- Copy the API key and API secret key
Keep these credentials secure — they grant access to your Shopify store’s order data.
Connect Shopify to Komerza
- In your Komerza dashboard, go to Settings → Payment Methods → Shopify
- Enter your Shop URL (e.g.
mystore.myshopify.com) - Paste the API Key and API Secret from the previous step
- Click Save
Authorize the Connection
- After saving your credentials, click Connect to Shopify
- You’ll be redirected to Shopify to approve the app’s permissions
- Click Install app on the Shopify authorization screen
- You’ll be redirected back to your Komerza dashboard — the connection is now active
- Active — Everything is connected and working
- Inactive — Check that your API credentials are correct
How It Works
- A customer selects Shopify at checkout
- Komerza creates a draft order on your Shopify store
- The customer is redirected to Shopify’s hosted checkout to complete payment
- Once payment is confirmed, Komerza automatically marks the order as delivered
Managing Payments
- Refunds — You can issue refunds through Komerza. The refund is processed via the Shopify Orders API and reflected in both platforms.
- Webhooks — Komerza listens for order and refund events from Shopify to keep everything in sync.
Disconnecting Shopify
Go to Settings → Payment Methods → Shopify and click Disconnect. Your existing orders are not affected — only new checkouts will no longer offer Shopify.Troubleshooting
| Problem | Fix |
|---|---|
| ”Missing required permissions” error | Go back to your Shopify app settings and make sure all four API scopes are enabled, then reconnect |
| OAuth authorization fails | Double-check that your API Key and API Secret are correct — copy them again from the Shopify app’s API credentials tab |
| Webhooks not firing | Verify your app has the read_orders scope enabled — Shopify requires it for order and refund webhook subscriptions |
| ”Please configure your Shopify app credentials first” | You need to save your API Key and API Secret before clicking Connect |