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 | Process Return, Remove Line Items, Cancel Return, Flag Return, Close Return, Get Return Notes, Create Return Note, Detailed Returns List, Get Return Details, Advanced Shipping Notice, Grade Items, Assess Dispositions, Create Fraud Report |
| Orders | Create Return Deep Link, Create Return Deep Link with QR Code, List Blocklist Items, Get Blocklist Item, Create Blocklist Item, Delete Blocklist Item, List Allowlist Items, Create Allowlist Item, Get Allowlist Item, Delete Allowlist Item |
| Carts | Create Cart, Get Cart, Update Cart, Delete Cart |
| Developer Tools | Get Webhooks, Create Webhook, Delete Webhook, Update Webhook |
| Destinations (Read) | Get All Destinations, Get Destination Details |
| Destinations (Write) | Create Destination, Update Destination, Delete Destination |
| Happy Returns Shipments (Read) | Get Shipment Information, Get Shipments, Get Shipment Items |