The Loop API uses API keys to authenticate requests. You can view, edit, and create API keys from the Developers page in the Loop Admin.
API endpoints require keys with specific scopes. Ensure you create API keys with the necessary scopes for the specific endpoints you plan to use. Refer to the documentation for each endpoint to determine the required scopes.
If the API key you are using does not have the required scope, you will receive a 401 Unauthorized
response.
API Key Scope Quick Reference:
Scope | Available Endpoints |
---|---|
Returns | Advanced Shipping Notice, Process Return, Flag Return, Cancel Return, Close Return, Return Details |
Orders | Deeplink, Blocklist, Allowlist |
Carts | On-store, On-store Snippet |
Developer Tools | Get, Create, Update, and Delete Webhooks |