Installation Flow
Merchant installs app
Merchant clicks install from BigCommerce App Marketplace. This triggers
GET /big-commerce/auth.OAuth flow
BigCommerce redirects to the authorization page. Upon approval, the OAuth callback exchanges codes for access tokens.
App load callback
When the merchant opens the app, BigCommerce calls
GET /big-commerce/load with a signed payload. The backend validates the payload and redirects to the retailer dashboard.Order Processing
BigCommerce order webhooks are processed viaPOST /big-commerce/webhook/order-status and feed customer purchase data into the segmentation engine for targeted email campaigns.
Customer SSO
BigCommerce customers are authenticated via the platform’s customer login API:Billing
BigCommerce retailers use Braintree for subscription billing, managed through theRetailerBillingConfiguration entity.
App Lifecycle
| Event | Endpoint | Description |
|---|---|---|
| Install | GET /big-commerce/auth | OAuth installation |
| Load | GET /big-commerce/load | App loaded in admin |
| Uninstall | GET /big-commerce/uninstall | App removal cleanup |
Configuration
| Variable | Description |
|---|---|
BIGCOMMERCE_CLIENT_ID | BigCommerce app client ID |
BIGCOMMERCE_CLIENT_SECRET | BigCommerce app client secret |