Overview
The OrbisCommerce API uses API keys for authentication. All requests must include your API key in the Authorization header.
Base URL: https://api.orbiscommerce.com/v1
Generating an API key
- Go to Settings → API Keys
- Click Generate New Key
- Give the key a name (e.g. "Production", "Development")
- Copy and store the key securely — it is shown only once
Making authenticated requests
Include your API key as a Bearer token in every request:
GET /v1/shipments HTTP/1.1
Host: api.orbiscommerce.com
Authorization: Bearer oc_live_xxxxxxxxxxxxxxxxxxxx
Content-Type: application/json
Key types
| Type | Prefix | Use |
|---|---|---|
| Live | oc_live_ | Production shipments and billing |
| Test | oc_test_ | Testing without generating real labels |
Use test keys during development — they return realistic responses but do not charge your account or create real labels.
Key scopes
When generating a key, you can restrict it to specific scopes:
| Scope | Access |
|---|---|
shipments:read | View shipments and tracking |
shipments:write | Create and void labels |
rates:read | Fetch live carrier rates |
orders:read | View synced marketplace orders |
billing:read | View charges and invoices |
Revoking a key
Go to Settings → API Keys, find the key, and click Revoke. Revoked keys are immediately invalid.
Rate limits
API requests are limited to 120 requests per minute per key. If you exceed this, the API returns a 429 Too Many Requests response. Contact us if you need higher limits.
Was this article helpful?