Authentication
The Shipdesk API uses Bearer token authentication over HTTPS. All API requests must include your secret API key in theAuthorization header.
Authorization header, or with an invalid/revoked token, will be rejected with an HTTP 401 Unauthorized status.
API Key Format
Shipdesk API keys are prefixed to help identify the environment:Managing API Keys
API keys are managed directly from the Shipdesk Web Application:- Navigate to Settings (
⚙) in the sidebar or top header. - Click on the API & Webhooks tab (
#settings-api). - Click + Generate API key.
- Choose a descriptive name (e.g.
Shopify Sync Engine,ERP Automated Dispatch) and assign a role:- Admin: Full access to all endpoints, assignment, pickups, and account settings.
- Ops: Operational access to orders, shipments, pickups, and NDR actions.
- Support viewer: Read-only access to search orders, tracking timelines, and download reports.
Multi-Tenant Organization Scope
Every API key is tied strictly to your organization’s workspace (org_id). When your backend makes an API call:
- The caller’s organization is resolved from the key.
- Your request can only read or modify records belonging to your account.
- Row-Level Security (RLS) guarantees absolute tenant data isolation.
Rate Limits
To protect service availability and prevent courier API flooding, Shipdesk enforces IP and organization-level rate limits:
When a rate limit is exceeded, the API responds with
HTTP 429 Too Many Requests: