HS 代碼 API 參考
讀取某個版本的一個 HS 代碼,包含名稱、層級、上層代碼與下一層的代碼。
概覽
GET /
GET / 回傳某個版本的一個 HS 代碼:名稱、層級、上層代碼與下一層的代碼。code 為 2、4 或 6 位碼。
該版本沒有的代碼會回傳 404 hs_。同一個 6 位碼可能存在於某個版本而不存在於另一個版本,因為版本之間絕不互相轉換。MCP 工具為 trade_,參數相同。
請求
2022 版的子目 851713(智慧型手機),以及實際回應:
curl -H "Authorization: Bearer $NARWHAL_API_KEY" \
"https://api.narwhalapi.com/v1/trade/hs-codes/851713"{
"code": "851713",
"level": 6,
"label": "Smartphones for wireless networks",
"parent": "8517",
"classification": "HS",
"edition": "2022",
"children": []
}子目之下沒有代碼,因此 children 為空。
參數
| 參數 | 位置 | 類型 | 必填 | 預設值 | 允許值與意義 |
|---|---|---|---|---|---|
code | path | 字串 | 是 | 無 | 2、4 或 6 位碼的 HS 代碼,例如 85、8517 或 851713,不含句點。其他形式會回傳 400。 |
edition | query | 字串 | 否 | 2022 | 2007、2012、2017 或 2022。其他任何值會回傳 400。 |
回應
回應包含下列欄位。
| 欄位 | 含義 |
|---|---|
code | 代碼。 |
level | 2 代表章,4 代表品目,6 代表子目。 |
label | 該版本用語中的代碼名稱。 |
parent | 上一層的代碼。章為 null。 |
classification | HS。 |
edition | 版本。 |
children | 下一層的代碼,每個都含 code、level、label 與 parent。子目則為空。 |
更多範例
該版本沒有的代碼
代碼 851713 是 2022 版新增的。2017 版沒有它,因此請求會回傳 404,且免費:
curl -H "Authorization: Bearer $NARWHAL_API_KEY" \
"https://api.narwhalapi.com/v1/trade/hs-codes/851713?edition=2017"{
"type": "https://narwhalapi.com/problems/hs-code-not-found",
"title": "HS code not found",
"status": 404,
"detail": "HS 2017 has no code 851713.",
"code": "hs_code_not_found",
"request_id": "d8c40c41-aeaf-4b83-a315-c855697eafc3"
}來源
此路由收錄代碼而沒有貿易數字,因此不適用任何來源。
貨幣
此路由不回傳金額,因此不適用貨幣。
分頁
此路由沒有分頁。所有下層代碼都在一個回應中回傳。
價格
每個找到代碼的請求算一次呼叫,每 1,000 次呼叫收費 $2。找不到代碼的請求與所有其他錯誤皆免費。
錯誤
這些錯誤使用共用的問題格式,並附有 request_。缺少或無效的金鑰(401)、餘額低於該次呼叫的價格(402)以及每分鐘請求過多(429),是所有路由共有的帳戶錯誤:請見「錯誤與額度」。
| 狀態 | 代碼 | 發生時機 |
|---|---|---|
400 | invalid_query | code 不是 2、4 或 6 位碼,或 edition 不是 2007、2012、2017 或 2022。 |
404 | hs_code_not_found | 該版本沒有此代碼,例如 HS 2017 has no code 851713.。 |
此頁面對你有幫助嗎?