latestOpenAPI 3.0.32026-07-26170311887.2 KB

71d737a5fcbf

Authorization

Authorize user on Easyship

Redirect a user for authentication on Easyship.

The endpoint is part of OAuth 2.0 Authorization Code flow.

🚧 Warning

This endpoint uses auth.easyship.com domain. The full URL, without query params, is https://auth.easyship.com/oauth2/authorize. This docs platform does not fully support OpenAPI and uses/displays the global URL instead of the correct one.

After successful authentication, the user will be redirected back to redirect_uri with a code (and state) parameter in the query string.

The code can then be exchanged for an access token using the OAuth2 Token endpoint with AUTHORIZATION_CODE request body.

get/oauth2/authorize

Query parameters

client_idClientId required— unresolved $ref
redirect_uriRedirectUri required— unresolved $ref
response_type'code' required
scopeScope required— unresolved $ref
statestring

String that will be returned with the code to your redirect_uri (e.g., for validation).

Response

redirection