Create a batch tracking task
Download OpenAPICreates a task for between 1 and 500 tracking numbers. Processing is asynchronous. The API returns a task_id without waiting for tracking results. Use it with GET /v2/tracking/batch to retrieve the task state and results later. Task data is cached for up to 6 hours.
Authorization
api_key In: query
Query Parameters
Whether to include route information
falseRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v2/tracking/batch?need_route=false" \ -H "Content-Type: application/json" \ -d '{ "tracked_items": [ { "company": "COSU", "track_number": { "value": "CSNU6184414", "type": "container" } }, { "company": "AKKU", "track_number": { "value": "AKKNEM25072638", "type": "bl" } } ] }'{ "success": true, "data": { "task_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, "status": "OK"}List supported carriers GET
Returns supported carriers, their SCAC codes, and tracking types. Each key in `data` is a company name, and each value contains `scac`, `cn`, `bl`, and `bk`. Pass `scac` as `company`. Flags set to `true` indicate support for containers, bills of lading, and bookings respectively.
Get batch tracking status and results GET
Returns the state of a task created with `POST /v2/tracking/batch`. In `data.status`, `CREATED` means queued, `HANDLING` means processing, and `PROCESSED` means complete. Once complete, read `data.results` and stop requesting the task state. Use tracking requests or webhooks for later shipment updates. Task data is cached for up to 6 hours.