Skip to content
Status

Initial authorization endpoint

GEThttps://merchant.shuttleglobal.com/authorize

GET
/authorize

Initiates the OAuth 2.0 authorization flow on merchant.shuttleglobal.com

Flow:

  1. Your application redirects the user to this endpoint with required parameters
  2. This endpoint responds with a 302 redirect to Shuttle’s login page
  3. On the login page, the user authenticates and grants permission to your application
  4. After successful authentication and consent, the user is redirected to your redirect_url with an authorization code
  5. 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
response_type
required
string · enum

Must be ‘code’ for authorization code flow

Allowed values: code
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

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)

Location
string · uri

URL of the login page where user will authenticate and grant permissions

Was this page helpful?