Skip to Content
SettingsAPI Keys

API Keys

API keys provide programmatic access to the Orderly API. Each key is scoped to specific permissions.

Creating a Key

  1. Go to Settings > API Keys
  2. Click Create API Key
  3. Name your key (e.g., “Production Integration”)
  4. Select the scopes this key needs
  5. Click Create
  6. Copy the key — it won’t be shown again

Using a Key

Include the key in the Authorization header:

curl -H "Authorization: Bearer ord_sk_..." https://api.orderly.dev/api/orders

Available Scopes

Orders
orders:readView orders and order details
orders:writeCreate and update orders
Shipments
shipments:readView shipments and tracking info
shipments:writeCreate and update shipments
Bridges
bridges:readView bridge configurations
bridges:writeCreate, update, and delete bridges
Transformations
transformations:readView data transformations
transformations:writeCreate and update transformations
Webhooks
webhooks:manageConfigure webhook endpoints
Carrier Accounts
carrier-accounts:readView carrier account details
carrier-accounts:writeManage carrier accounts
Rates
rates:readFetch shipping rates
Pickups
pickups:readView scheduled pickups
pickups:writeSchedule and cancel pickups
Dispatchers
dispatchers:readView dispatcher rules
dispatchers:writeCreate and update dispatchers
Operations
operations:readView operations and items
operations:writeCreate and update operations
operations:executeExecute operations and apply actions
Insights
insights:readView dashboard analytics and reports
insights:writeConfigure insight settings
Agent
agent:readView agent conversations and memory
agent:writeSend messages to the AI agent
agent:adminManage agent settings and standing orders
Embed
embed:manageManage embed access codes and config

Key Management

GET /api/api-keys           # List keys (without secret values)
POST /api/api-keys          # Create a key
DELETE /api/api-keys/:id    # Revoke a key

Security Best Practices

  • Use the minimum scopes necessary
  • Rotate keys regularly
  • Never commit keys to version control
  • Use environment variables for key storage
  • Create separate keys for different environments (dev, staging, prod)
MembersCustom Roles