Create a tracking

POST/api/v1/routers/create

Each request creates 1–40 trackings. For larger batches, use Create trackings (async).

Parameters

data is an array of 1–40 trackings. referId must be unique within the batch.

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 lists queued trackings. errors lists trackings that were not queued. Each item in the batch is accepted or rejected on its own, so one 200 can contain both. This response only says which trackings entered the processing queue. Read the timeline later from Query a tracking or a webhook. This response has no shipment timeline.

successarray

Trackings that entered the processing queue.

Fields

referIdstring

Business ID from the request.

trackingNumberstring

Tracking number accepted for this item.

carrierCodestring

Matched carrier code.

carrierNamestring

Matched carrier name.

errorsarray

Trackings that were not queued.

Fields

referIdstring

Business ID from the request.

messagestring

Why this tracking was not queued.

cURL

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

Response Sample

{
  "success": [
    {
      "referId": "order-10001",
      "carrierName": "USPS",
      "carrierCode": "usps",
      "trackingNumber": "9400111899223857461234"
    }
  ],
  "errors": []
}