shopify
Order sync and WhatsApp order updates (Commerce), and SEO fixes/blog posts on the storefront.
AProvider definition
- Provider
- shopify
- What it does
- Order sync and WhatsApp order updates (Commerce), and SEO fixes/blog posts on the storefront.
- Why we need it
- Order sync and WhatsApp order updates (Commerce), and SEO fixes/blog posts on the storefront.
- Used in
- Commerce · SEO fixes
BAccount requirements
- Account type
- Shopify store with a custom app
- Prerequisites
- Store owner or staff with app development permission
CConnection method
- Authentication
- Admin API access token (custom app)
- Where to enter it
- Stores: App → Commerce → StoresStore owner or staff with app permissions.
- Per brand: App → Integrations → Connected accountsAnyone who manages the brand. Each brand connects its own accounts.
Setup steps
- 1Shopify admin → Settings → Apps and sales channels → Develop apps → Create an app.
- 2Admin API scopes: read_orders, write_orders, read_merchant_managed_fulfillment_orders, write_merchant_managed_fulfillment_orders (plus read_products, write_content for SEO).
- 3Install the app; copy the Admin API access token and the API secret key.
- 4Commerce → Stores → Add Shopify store and paste them.
DPermissions & API scopes
No OAuth scopes — access is controlled by the key or token itself. Restrict keys to the APIs listed in the setup steps where the provider allows it.
- read_orders
- Import orders and statuses.
- write_orders
- Add notes, cancel or confirm orders after WhatsApp replies.
- read_merchant_managed_fulfillment_orders
- Read shipments and tracking.
- write_merchant_managed_fulfillment_orders
- Mark orders fulfilled.
- read_products
- (SEO) Read products.
- write_content
- (SEO) Update blog posts and pages.
This list is generated from the scopes the application's code requests.
EFree vs paid
- Free account / free API access
- Yes — custom apps have no API fee.
- Card or billing account required?
- No.
- Paid plan / costs
- None.
- Quota and usage limits
- Shopify Admin API rate limits (leaky bucket).
FSetup screenshots
Capture each step with real values masked. Save images as public/docs/integrations/shopify/1.png … 10.png and they appear here automatically.
- Screenshot to add1. Account login / creationThe provider's sign-in or sign-up page.
- Screenshot to add2. Developer consoleThe developer console or dashboard home.
- Not applicable3. Project / app creationCreating the app or project used for this integration.
- Not applicable4. API enablementThe API or product enabled for the project.
- Not applicable5. OAuth configurationConsent screen / OAuth settings with the redirect URIs.
- Screenshot to add6. API key / credentials creationCreating the key, secret or token (mask the value).
- Not applicable7. Permissions / scopesThe scopes or permissions requested or approved.
- Screenshot to add8. Billing / quota settingsBilling, credits or quota page.
- Screenshot to add9. Application connectionThe provider card in our application with fields filled (secrets masked).
- Screenshot to add10. Successful connectionThe green Test result or the connected account listed.
GApplication configuration
Never include real API keys, client secrets, access tokens or passwords in screenshots, tickets or documentation. Values below are field names and examples only.
| Field | Required | Example / default | Notes |
|---|---|---|---|
| Shop domain | Yes | your-store.myshopify.com | |
| Admin API access token | Yes | •••••••• | Stored encrypted; shown masked after saving. |
| API secret key | Optional | •••••••• | Used to verify order webhooks. Without it, orders sync every few minutes instead of instantly. |
| API version | Optional | 2025-07 |
Shopify admin → Settings → Apps and sales channels → Develop apps → Create an app. Admin API scopes: read_orders, write_orders, read_merchant_managed_fulfillment_orders, write_merchant_managed_fulfillment_orders. Install it, then copy the Admin API access token and the API secret key.
HTesting
- 1Add the store; the last 30 days of orders import (without messaging customers).
ITroubleshooting
| Problem | What to do |
|---|---|
| Invalid credentials | The key or token is wrong, revoked or from another project. Create a new one and paste it again, then click Test. |
| Missing permissions | The key's project or role doesn't include this API. Grant access or create the key in the right project. |
| API not enabled | Enable the API/product for the project or app in the provider console and wait a few minutes. |
| Quota exceeded | Wait for the quota window to reset (see section E) or request a higher quota / add credits. |
| Account not eligible | Check the account requirements in section B (e.g. business/professional account, verified property, registered organisation). |
| Billing required | Add a payment method or prepaid credits on the provider account (see section E). |
JDisconnect & security
- Revoke access at the provider
- Uninstall the custom app in Shopify admin.
- Disconnect in the application
- App → Commerce → Stores or App → Integrations → Connected accounts → open the card → Remove / Disconnect. Connected accounts can be disconnected per brand.
- Rotate credentials
- Create the new key or secret first, paste it into the same card and Test, then delete the old one at the provider — no downtime.
- How credentials are stored
- Encrypted at rest with AES-256-GCM using the server's ENCRYPTION_KEY, shown masked after saving, never returned to the browser, and used only from the API server.
- What data the application can access
- Orders, customers on those orders and fulfilments.

