Create trackings (async)

POST/api/v2/trackings/create

Each request creates 1–1000 trackings. After the request is accepted, Tracksuite processes the batch asynchronously.

Parameters

data is an array of 1–1000 trackings. referId must be unique within the batch. Fields match Create a tracking.

dataarrayRequired

Trackings to create.

Fields

referIdstringRequired

A business ID from your system, such as an order ID. Max 128 characters.

rawTrackingNumberstringRequired

Carrier tracking number. Max 300 characters.

metadata.carrierCodestringoptional

Carrier code. If omitted, Tracksuite identifies the carrier from the number. Max 64 characters.

Return

success: true means the batch has entered asynchronous processing. Retrieve each tracking through Query a tracking or a webhook. While processing is unfinished, a query can return Processing.

successboolean

true when the batch entered the processing queue.

cURL

curl 'https://api.tracksuite.net/api/v2/trackings/create' \
  -H 'Authorization: your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{"data":[{"referId":"order-10001","rawTrackingNumber":"9400111899223857461234","metadata":{"carrierCode":"usps"}}]}'

Response Sample

{
  "success": true
}