Register Tracking Numbers

POST 
/register

Register up to 40 tracking numbers per call for auto-tracking.

Per-item fields:

• number (string, required) — the tracking number
• carrier (int, optional) — 17TRACK carrier code; omit + set auto_detection: true to let 17TRACK guess
• auto_detection (bool, optional) — fall back to auto-detect when carrier is unknown/wrong
• lang, order_no, order_time, tag, destination_country, destination_postal_code, shipper, consignee, phone_number_last_4, phone_number, email, remark — optional enrichment fields

Response envelope: {code, data: {accepted, rejected}}. Per-row rejections (already-registered, carrier not detected, …) come back in data.rejected[] with the error code — they're NOT envelope errors.

Common envelope error codes:

• -18010002 invalid API key
• -18010014 rate limit exceeded (also HTTP 429)
• -18019907 daily tracking limit reached
• -18019908 monthly quota exhausted

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.