Skip to main content
The OrderProtection App Marketplace is where merchants browse and install third-party apps. Once your public app is approved, it appears in the marketplace for all merchants to discover.

​
How installation works

1

Merchant browses the marketplace

Merchants access the marketplace from their dashboard via App Marketplace in the left sidebar. They can search by name or filter by category.
2

Merchant reviews your app

Your app’s detail page shows its name, description, logo, category, and the permissions it requests. Merchants can see which scopes are required and which are optional.
3

Merchant approves permissions

When the merchant clicks Install, a consent dialog shows all requested scopes. Required scopes are pre-selected and cannot be unchecked. The merchant can opt out of optional scopes.
4

Authorization code delivered

After the merchant confirms, OrderProtection creates an installation record and delivers an authorization code to the first redirect URI configured on your app.
POST https://yourapp.example.com/callback

{
  "code": "a1b2c3d4e5f6...",
  "state": "...",
  "store_id": "store_abc123"
}
5

Exchange code for tokens

Your server exchanges the authorization code for access and refresh tokens using the token endpoint. You are now authorized to make API calls on behalf of that merchant’s store.

​
Handling reauthorization

When you update your app’s requested scopes (e.g., adding a new permission), existing installations are flagged for reauthorization. Merchants will see a Reauthorization required badge on your app in their installed apps list. When the merchant clicks Reauthorize, they review the updated scope list — with new scopes highlighted — and can approve or deny the changes. After reauthorization, a new authorization code is delivered to your redirect URI.
Your existing tokens continue to work with the original scopes until the merchant reauthorizes. Plan for a transition period where some installations may have the old scope set.

​
Handling uninstalls

When a merchant uninstalls your app:
  1. All access and refresh tokens for that installation are immediately revoked
  2. Any app webhooks registered for that store are deleted
  3. The installation is marked as removed
Your app should handle 401 Unauthorized responses gracefully — this typically means the merchant has uninstalled your app or revoked access.

​
Private apps

Private apps are not listed in the marketplace. They are scoped to a single store and do not go through the review process. This is ideal for:
  • Internal tools for your own store
  • Custom integrations with specific partners
  • Development and testing before going public
To install a private app, the store owner installs it directly from the developer dashboard.