Skip to main content

Documentation Index

Fetch the complete documentation index at: https://packageretriever.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
API Reference

Base URL: https://api.packageretriever.com/v1 All requests require authentication via Bearer token: 
Authorization: Bearer pr_live_YOUR_KEY
Use pr_test_ keys for sandbox mode (no billing, simulated responses).

​
Endpoints

ResourceEndpoints
AddressesValidate address, get residential classification
RatesMulti-carrier rate shopping
LabelsCreate, view, and void shipping labels
TrackingRegister and poll tracking numbers
Carrier AccountsView connected BYOA accounts
BatchesBatch label creation (up to 5,000)
WalletCheck prepaid wallet balance
WebhooksWebhook delivery log

​
Response format

All successful responses return the resource object directly. All errors follow: 
{
  "error": {
    "code": "RESOURCE.CATEGORY.SPECIFIC",
    "message": "What went wrong.",
    "suggestion": "What to do next.",
    "docs_url": "https://docs.packageretriever.com/...",
    "request_id": "req_xxxxxxxxx"
  }
}

​
Rate limits

Every response includes X-RateLimit-Remaining and X-RateLimit-Reset headers. See Rate Limits for the full published table.