/track17/carriers/search

POST /api/track17/carriers/search

Price: 20 credits

Search the 17track carrier catalog by name and country

How to use it

Search 17track's catalog of 3300+ parcel carriers worldwide. Filter by carrier name (keyword) and/or two-letter ISO country code. Each carrier returns its id, name (including Chinese names), country, website, support email, phone and availability scope. Use it to map carrier codes, validate carrier names, or browse carriers by country. With no filters it returns the full catalog. No matches returns an empty list.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Filter carriers whose name contains this text (case-insensitive) (minLength: 1)
• country string nullable — Filter carriers by two-letter ISO country code (examples: "US", "CN", "GB", "DE"; minLength: 2; maxLength: 2)
• count integer required — Max number of carriers to return (min: 1)

Response

• @type string (default: "Track17Carrier")
• id integer required
• name string required
• name_zh_cn string nullable
• name_zh_hk string nullable
• country string nullable
• country_code integer nullable
• web_url string nullable
• email string nullable
• phone string nullable
• group_code string nullable
• scope array (default: [])

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.