Carriers & Shipments API
Track shipments via 17track and resolve carrier codes.
Carriers
| Method | Path | Description |
|---|---|---|
| GET | `/api/v1/carriers` | Global carrier directory |
Shipments
| Method | Path | Description |
|---|---|---|
| GET | `/api/v1/shipments` | List |
| POST | `/api/v1/shipments` | Register a tracking number |
| GET | `/api/v1/shipments/:id` | Detail (timeline) |
| POST | `/api/v1/shipments/:id/refresh` | Force a poll |
| DELETE | `/api/v1/shipments/:id` | Stop tracking |
Webhooks
POST /api/v1/webhooks/17track — public, signed by 17track.
Every response uses the standard envelope:
{
"success": true,
"data": { /* resource or array */ },
"meta": { "total": 100, "cursor": "...", "hasMore": true },
"error": { "code": "ERROR_CODE", "message": "Human readable" }
}error is omitted on success; meta is omitted when not paginating.
Rate Limits
Subject to the standard 200 req/min/tenant authenticated limit. See [Rate Limits](/docs/api-reference/rate-limits) for full details and the per-endpoint overrides.