POST /api/wcohs/index/search
Price: 20 credits
Read the WCO Alphabetical Index — the curated product-name to Harmonized System code cross reference, one letter or digit bucket at a time
This is the WCO's own hand-written product-name index, so it names goods the way a trader would rather than the way the nomenclature does, and it is the place to look when a plain keyword search returns nothing. Entries are bucketed by first character, so pass the letter (a-z) or digit (0-9) the product name starts with and narrow with keyword; numeric entries are spread across all ten digit buckets by their own leading digit, not collected under one bucket. Three kinds of entry come back: one with hs_code set, one with only explanatory_notes_code, meaning the goods are discussed in the Explanatory Notes rather than named in the nomenclature, and a cross-reference such as 'ABALONE : see MOLLUSC(s)' with neither. The index covers fewer editions and languages than the nomenclature itself.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)letter string required — Index bucket to read — a single letter a-z, or a single digit 0-9 for the numeric entries (numeric entries are spread across all ten digit buckets by their leading digit, not just 9) (examples: "a", "z", "1", "9"; minLength: 1; maxLength: 1)keyword string nullable — Keep only entries whose goods text contains this word (examples: "cotton", "acid")edition string — Harmonized System edition the index belongs to (default: "2022"; one of: "2022", "2017")language string — Language of the index entries (default: "en"; one of: "en", "fr")count integer required — Number of index entries to return (min: 1; max: 1300)@type string (default: "WcohsIndexEntry")goods string requiredhs_code string (default: "")explanatory_notes_code string (default: "")internal_code string (default: "")url string (default: "")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.X-Error — Error message text (present only on error)X-Request-ID — Unique request identifierX-Execution-Time — Execution time in secondsX-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.