Skip to main content

​
Getting Your Credentials

​
API Token

To create an API token:
  1. Log in to your Redo Dashboard
  2. Go to Settings → Developer
  3. Click Add API Client
  4. Copy the generated API secret
Store your API secret securely. It will only be shown once when created.

​
Store ID

Your Store ID is displayed in the General section of Settings → Developer in the Redo Dashboard.

​
API Endpoints

All API endpoints are authenticated using the Bearer authorization scheme with your API secret. Include your API secret in the Authorization header of every request:
Never share your API secret publicly or commit it to version control.

​
Example Request

​
Access scopes

API tokens carry access scopes that determine which protected endpoints they may call. For example, listing returns requires returns_read, and a request is rejected with 403 Forbidden if the token does not hold it. Choose a client’s scopes in Settings → Developer when you create its token, and update them at any time without re-issuing the token. Endpoints that require a scope list it in this reference.
Public storefront coverage endpoints do not require an access scope. A token used only for those endpoints can be created with no scopes selected.
Tokens created before access scopes were introduced were granted all scopes, so they keep working unchanged. Newly created tokens only carry the scopes you select.
See Access scopes for the full list and how to grant them.

​
Webhooks

Webhooks are authenticated using the Bearer authorization scheme with a secret you provide when creating the webhook subscription. Redo will include this secret in the Authorization header when delivering webhook events to your endpoint:
Always verify the Authorization header in your webhook handler before processing events.

​
Webhook Event Delivery

  • Webhook events are delivered in order for each individual subject (e.g., return)
  • If the response is not a 2xx status code, the event will be retried multiple times before discarding it
See the Webhooks guide for detailed setup instructions.