The ReturnLogic API uses bearer tokens to authenticate requests. You must pass the token in the Authorization HTTP request header.

Authorization: Bearer {{your token here}}

Your public app must have a redirect url that is set up to accept the following query string parameters:

• code - The authorization code generated after a successful installation
• teamId - The unique identifier of the retailer that installed your app

Whenever a retailer installs your app, we will redirect the retailer to your URL with the auth code and the teamId appended in the query string.

https://www.your-public-app.com/app/authorize_redirect?code=a22bcde12345&teamId=36bd1371-1eac-40d3-92f4-065982ff9d3f

Use the code provided and make an HTTP POST request to https://api.returnlogic.com/v1/oauth with the following body:

{
  "grant_type": "authorization_code",
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET",
  "code": "a22bcde12345"  
}

You'll receive a Bearer token and a Refresh token:

{
  "bearer_token": "uebjkefgh84372",
  "refresh_token": "buelfxkdezxc10392"
}

The bearer token can be used to make API requests. The refresh token can be used to generate new bearer tokens when they expire.

It is your responsibility to keep track of bearer tokens for each retailer that installs your application.

Any API call could return an error:

• 401 - Unauthorized
• 400 - Bad Request
• 429 - Rate Limit Exceeded
• 503 - Down For Maintenance

The default rate limit for a ReturnLogic API key is 2 requests per second and 120 requests per minute. If an API request exceeds the rate limit, the API will return a 429 Rate Limit Exceeded response. The following HTTP headers will be present on all API responses to help you stay within the limit.

• X-RateLimit-Limit-Second: maximum number of calls client can make in 1 second
• X-RateLimit-Limit-Minute: maximum number of calls client can make in 1 minute
• X-RateLimit-Remaining-Second: remaining number of calls client can make in 1 second
• X-RateLimit-Remaining-Minute: remaining number of calls client can make in 1 minute