Initial authorization endpoint
GEThttps://merchant.shuttleglobal.com/authorize
GET
/authorize
Initiates the OAuth 2.0 authorization flow on merchant.shuttleglobal.com
Flow:
- Your application redirects the user to this endpoint with required parameters
- This endpoint responds with a 302 redirect to Shuttle’s login page
- On the login page, the user authenticates and grants permission to your application
- After successful authentication and consent, the user is redirected to your redirect_url with an authorization code
- Use this code immediately with the /token endpoint to obtain tokens IMPORTANT: The authorization code expires after 15 minutes
Notes:
- The authorization code is valid for only 15 minutes from the time it’s generated
- The state parameter is recommended for CSRF protection
- Your redirect_url must match one of your pre-registered URLs
Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”response_type
required
string · enum
Must be ‘code’ for authorization code flow
client_id
required
string
redirect_url
required
string · uri
scope
string
Space-delimited list of requested scopes
state
string
Value used to maintain state between request and callback
Responses
Section titled “Responses”Redirect to Shuttle’s login page or return an error
Media typetext/plain
One of:
Redirect to login page
object
login_url
string · uri
URL of Shuttle’s login page
state
string
The state value from the request (if provided)
Error response
object
error
string · enum
error_description
string
Human-readable error description
error_uri
string · uri
URI to error documentation
state
string
The state value from the request (if provided)
Headers
Section titled “Headers”Location
string · uri
URL of the login page where user will authenticate and grant permissions
Was this page helpful?
What went wrong?
Thanks for telling us.