OAuth
Start authorization
Redirects the merchant's browser to the consent page for your app's scopes.
GET/oauth/authorize
This URL is opened by the browser, not by your server. Build the URL on your server, then redirect to it. The full walkthrough with PKCE is in OAuth 2.0 with PKCE.
Query parameters
- response_typeobjectrequired
- client_idstring (uuid)required
- store_idstring (uuid)required
- From larm_store_id in the launch URL.
- redirect_uristring (uri)required
- Exact match of a URL registered in the version.
- statestringrequired
- code_challengestringrequired
- code_challenge_methodobjectrequired
- scopestringrequired
- Space-separated, including all of their dependencies.
- version_idstring (uuid)
Errors
| HTTP | Code | Meaning |
|---|---|---|
| 400 | REDIRECT_URI_MISMATCH | The URL is not registered in the version. |
| 400 | SCOPE_DEPENDENCIES_MUST_BE_VISIBLE | A scope was requested without its dependencies. |
| 403 | INVALID_REQUESTED_SCOPES | Scopes outside the version, or required scopes missing. |
| 403 | PLAN_NOT_ELIGIBLE | The store's plan does not include apps. |
| 429 | AUTHORIZE_RATE_LIMITED | Too many authorization requests. |
Shared codes are listed in Errors.