エラー
HIOBuy には 2 種類のエラー形があります。プロトコルエラー(非 2xx + error)と 業務失敗(一部注文ルートで HTTP 200 かつ success: false)。
Protocol errors (HTTP 4xx / 5xx) {#protocol-errors}
{
"error": {
"code": "INBOUND_VALIDATION_FAILED",
"message": "Some inbound information is missing or invalid.",
"request_id": "req_abc123",
"category": "VALIDATION_ERROR",
"field": "tracking_number",
"details": {
"fields": [
{
"field": "items[0].name",
"code": "REQUIRED",
"message": "Product name is required."
}
]
}
}
}| Field | Description |
|---|---|
error.code | Machine-readable enum — use for branching logic |
error.message | Human-readable explanation (English) |
error.request_id | Same as x-request-id response header |
error.category | Coarse grouping: AUTH_ERROR, RATE_LIMIT_ERROR, VALIDATION_ERROR, CHANNEL_ERROR, INTERNAL_ERROR |
error.field | Optional primary field path related to this error |
error.details | Optional object; validation may include details.fields: [{ field, code, message }] |
error.upstream | Optional vendor error summary on CHANNEL_UPSTREAM_ERROR (sanitized) |
Field-level details.fields[].code values: REQUIRED | INVALID_VALUE | INVALID_FORMAT | OUT_OF_RANGE.
HTTP status principles
| HTTP | When |
|---|---|
400 | Unparseable JSON / generic validation |
401 | Invalid API key |
403 | Authenticated but not allowed (including fulfillment mode gate) |
404 | Missing or inaccessible resource |
409 | State / uniqueness conflict |
422 | Parsed body fails business validation |
429 | Rate limit / quota |
500 / 502 / 503 | Internal or upstream failure |
エラーコード参照 {#error-codes}
正規の機械可読カタログは data/errors.catalog.json です。要約:
| Code | HTTP | Category | When |
|---|---|---|---|
INVALID_API_KEY | 401 | AUTH_ERROR | Bearer トークンが無効または欠落 |
UNAUTHORIZED | 401 | AUTH_ERROR | API キー欠落/無効(INVALID_API_KEY と同義) |
CHANNEL_NOT_AUTHORIZED | 401 | AUTH_ERROR | このアプリでチャネル未認可 |
FORBIDDEN | 403 | AUTH_ERROR | キーは有効だが権限なし |
INSUFFICIENT_SCOPE | 403 | AUTH_ERROR | このルートに必要な scope が不足 |
CHANNEL_NOT_ENABLED | 403 | AUTH_ERROR | このアプリでチャネル未有効 |
CHANNEL_AUTH_REQUIRED | 403 | AUTH_ERROR | チャネル認可未完了 |
CHANNEL_AUTH_EXPIRED | 403 | AUTH_ERROR | 認可期限切れ — Portal で再認可 |
CHANNEL_AUTH_REVOKED | 403 | AUTH_ERROR | 認可が取り消されました |
FULFILLMENT_MODE_NOT_SUPPORTED | 403 | AUTH_ERROR | self 履約アプリで /v1/fulfillment/* |
FULFILLMENT_ACCESS_REQUIRED | 403 | AUTH_ERROR | 予約 — 履約アクセス未付与 |
FULFILLMENT_ACCESS_SUSPENDED | 403 | AUTH_ERROR | 予約 — 履約アクセス停止中 |
WAREHOUSE_AUTH_REQUIRED | 403 | AUTH_ERROR | 倉庫履約だが倉庫認可なし |
WAREHOUSE_AUTH_EXPIRED | 403 | AUTH_ERROR | 倉庫認可の期限切れ |
WAREHOUSE_AUTH_INVALID | 403 | AUTH_ERROR | Warehouse rejected developer authentication |
VALIDATION_ERROR | 400 | VALIDATION_ERROR | ボディ欠落/不正、未対応通貨 |
UNSUPPORTED_CHANNEL | 400 | VALIDATION_ERROR | 不明な channel 値 |
UNSUPPORTED_FIELD | 400 | VALIDATION_ERROR | このルートで許可されないフィールド |
NOT_FOUND | 404 | VALIDATION_ERROR | ルートまたはリソースが存在しない |
CHANNEL_CAPABILITY_NOT_SUPPORTED | 400 | CHANNEL_ERROR | このチャネルでは利用不可 |
CHANNEL_UPSTREAM_ERROR | 502 | CHANNEL_ERROR | マーケット側が拒否(マスク済み) |
WAREHOUSE_UPSTREAM_ERROR | 502 | CHANNEL_ERROR | 倉庫/履約上流失敗(マスク済み) |
INTERNAL_ERROR | 500 | INTERNAL_ERROR | Gateway 予期せぬ障害 — バックオフ再試行 |
RATE_LIMIT_EXCEEDED | 429 | RATE_LIMIT_ERROR | 毎分/バースト制限超過 |
QUOTA_EXCEEDED | 429 | RATE_LIMIT_ERROR | チャネル日次クォータ枯渇 |
PLATFORM_QUOTA_EXCEEDED | 429 | RATE_LIMIT_ERROR | プラットフォーム月次容量上限 |
PAYMENT_DECLINED | 402 | VALIDATION_ERROR | 支払い拒否 |
PAYMENT_INSUFFICIENT_FUNDS | 402 | VALIDATION_ERROR | 資金不足(調達支払い) |
ORDER_ALREADY_PAID | 409 | VALIDATION_ERROR | 注文は既に支払済み |
ORDER_CANCELLED | 409 | VALIDATION_ERROR | 注文は既に取消済み |
PRODUCT_UNAVAILABLE | 422 | VALIDATION_ERROR | 商品販売不可 / 掲載終了 |
IDEMPOTENCY_CONFLICT | 409 | VALIDATION_ERROR | external_shipment_id / 冪等キー重複 |
EXTERNAL_ORDER_ID_ALREADY_EXISTS | 409 | VALIDATION_ERROR | external_order_id がアプリ内で使用済み |
PARCEL_NOT_FOUND | 404 | VALIDATION_ERROR | 無効または未入庫の parcel |
INVALID_SHIPPING_CHANNEL | 400 | VALIDATION_ERROR | 不正な shipping_channel_code |
INSUFFICIENT_BALANCE | 402 | VALIDATION_ERROR | 履約ウォレット残高不足 |
SHIPMENT_ALREADY_PAID | 409 | VALIDATION_ERROR | International shipment already paid |
SHIPMENT_NOT_FOUND | 404 | VALIDATION_ERROR | Shipment missing or not owned |
SHIPMENT_NOT_INTERCEPTABLE | 409 | VALIDATION_ERROR | Current shipment state cannot request intercept |
SHIPMENT_INTERCEPTION_ALREADY_REQUESTED | 409 | VALIDATION_ERROR | Intercept already requested |
INVALID_INTERCEPTION_REASON | 422 | VALIDATION_ERROR | Intercept reason CODE is invalid |
INTERCEPTION_REMARK_REQUIRED | 422 | VALIDATION_ERROR | remark required when reason is OTHER |
SHIPMENT_CREATE_EXCEPTION | 400 | VALIDATION_ERROR | Create refused (missing item attributes, parcel not inbound, etc. — read message) |
SHIPMENT_NOT_CANCELLABLE | 409 | VALIDATION_ERROR | Shipment cannot be cancelled in current status |
SHIPMENT_ALREADY_CANCELLED | 409 | VALIDATION_ERROR | Shipment already cancelled |
PACKAGE_ALREADY_CONSOLIDATED | 409 | VALIDATION_ERROR | Parcel already in another shipment |
INBOUND_TRACKING_ALREADY_SHIPPED | 409 | VALIDATION_ERROR | 追跡番号が既出荷パッケージに紐付済 |
INBOUND_TRACKING_ALREADY_EXISTS | 409 | VALIDATION_ERROR | 追跡番号は登録済み |
INBOUND_VALIDATION_FAILED | 422 | VALIDATION_ERROR | 入庫フィールドエラー(details.fields) |
INBOUND_NOT_FOUND | 404 | VALIDATION_ERROR | Inbound 不存在または権限なし |
PACKAGE_NOT_FOUND | 404 | VALIDATION_ERROR | パッケージ不存在または権限なし |
INBOUND_NOT_EDITABLE | 409 | VALIDATION_ERROR | 現状態では編集不可 |
INBOUND_ALREADY_RECEIVED | 409 | VALIDATION_ERROR | 倉庫で受領済み |
INBOUND_PACKAGE_MISMATCH | 409 | VALIDATION_ERROR | 指定の入庫/パッケージに紐付け不可 |
INVALID_TRACKING_NUMBER | 422 | VALIDATION_ERROR | 追跡番号フォーマット不正 |
PACKAGE_COUNT_INVALID | 422 | VALIDATION_ERROR | package_count 不正 |
TOTAL_VALUE_INVALID | 422 | VALIDATION_ERROR | total_value 不正 |
UNSUPPORTED_CURRENCY | 422 | VALIDATION_ERROR | 未対応通貨(入庫: CNY/USD/KRW) |
UNCLAIMED_PACKAGE_NOT_FOUND | 404 | VALIDATION_ERROR | 未照合パッケージなし |
TRACKING_NUMBER_MISMATCH | 422 | VALIDATION_ERROR | クレームの完全一致失敗 |
PACKAGE_ALREADY_CLAIMED | 409 | VALIDATION_ERROR | 既にクレーム済み |
PACKAGE_NOT_CLAIMABLE | 409 | VALIDATION_ERROR | 現状態ではクレーム不可 |
CLAIM_ATTEMPTS_EXCEEDED | 429 | RATE_LIMIT_ERROR | 同一 ucp_* の失敗過多 |
RETURN_NOT_FOUND | 404 | VALIDATION_ERROR | 返品リクエストなし/権限なし |
RETURN_NOT_CONFIRMABLE | 409 | VALIDATION_ERROR | 現状態では確認不可 |
RETURN_NOT_CANCELLABLE | 409 | VALIDATION_ERROR | 現状態では取消不可 |
RETURN_ALREADY_RETURNED | 409 | VALIDATION_ERROR | 返品済み |
RETURN_ALREADY_CANCELLED | 409 | VALIDATION_ERROR | 取消/無効済み |
RETURN_FEE_NOT_READY | 409 | VALIDATION_ERROR | 返品費用未算出 |
RETURN_FEE_CHANGED | 409 | VALIDATION_ERROR | 確認金額が fee.total と不一致 |
PACKAGE_NOT_RETURNABLE | 409 | VALIDATION_ERROR | パッケージ状態により返品不可 |
INVALID_RETURN_REASON | 422 | VALIDATION_ERROR | 不明な返品理由コード |
INVALID_RETURN_ADDRESS | 422 | VALIDATION_ERROR | seller_return 住所不正 |
RETURN_VALIDATION_FAILED | 422 | VALIDATION_ERROR | 返品フィールド検証失敗 |
VALUE_ADDED_SERVICE_NOT_FOUND | 422 | VALIDATION_ERROR | 不明な VAS service_code |
VALUE_ADDED_SERVICE_UNAVAILABLE | 422 | VALIDATION_ERROR | VAS はあるが利用不可 |
VALUE_ADDED_SERVICE_INVALID_STAGE | 422 | VALIDATION_ERROR | この段階では VAS 不可 |
VALUE_ADDED_SERVICE_QUANTITY_INVALID | 422 | VALIDATION_ERROR | VAS 数量不正 |
SERVICE_REQUEST_NOT_FOUND | 404 | VALIDATION_ERROR | サービス申請なし |
RESOURCE_NOT_FOUND | 404 | VALIDATION_ERROR | 関連リソースなし |
RESOURCE_NOT_ELIGIBLE_FOR_SERVICE | 409 | VALIDATION_ERROR | サービス対象外 |
SERVICE_FEE_NOT_READY | 409 | VALIDATION_ERROR | サービス料金未準備 |
SERVICE_FEE_CHANGED | 409 | VALIDATION_ERROR | 確認金額がサービス料金と不一致 |
SERVICE_REQUEST_VALIDATION_FAILED | 422 | VALIDATION_ERROR | サービス申請フィールド検証失敗 |
TRANSACTION_NOT_FOUND | 404 | VALIDATION_ERROR | 取引なし/権限なし |
INVOICE_NOT_FOUND | 404 | VALIDATION_ERROR | 請求書なし/権限なし |
TRANSACTION_NOT_INVOICEABLE | 409 | VALIDATION_ERROR | 請求不可の取引 |
TRANSACTION_ALREADY_INVOICED | 409 | VALIDATION_ERROR | 既に請求済み |
TRANSACTION_INVOICE_PENDING | 409 | VALIDATION_ERROR | 請求処理中 |
INVOICE_NOT_DOWNLOADABLE | 409 | VALIDATION_ERROR | 未発行のためダウンロード不可 |
INVOICE_VALIDATION_FAILED | 422 | VALIDATION_ERROR | 請求申請検証失敗 |
INVOICE_CURRENCY_MISMATCH | 422 | VALIDATION_ERROR | 請求通貨不一致 |
INVALID_INVOICE_TITLE | 422 | VALIDATION_ERROR | 請求書タイトル不正 |
INVALID_TAX_NUMBER | 422 | VALIDATION_ERROR | 税番号不正 |
INVALID_BILLING_ADDRESS | 422 | VALIDATION_ERROR | billing_address missing or invalid |
TICKET_NOT_FOUND | 404 | VALIDATION_ERROR | チケットなし/アプリ外 |
TICKET_NOT_REPLYABLE | 409 | VALIDATION_ERROR | 返信不可(閉鎖など) |
TICKET_ALREADY_CLOSED | 409 | VALIDATION_ERROR | チケット閉鎖済み |
INVALID_TICKET_CATEGORY | 422 | VALIDATION_ERROR | チケットカテゴリ不正 |
INVALID_TICKET_PRIORITY | 422 | VALIDATION_ERROR | チケット優先度不正 |
INVALID_RELATED_RESOURCE | 422 | VALIDATION_ERROR | related_resource 種別不正 |
TICKET_VALIDATION_FAILED | 422 | VALIDATION_ERROR | チケットフィールド検証失敗 |
RELATED_RESOURCE_NOT_FOUND | 404 | VALIDATION_ERROR | 関連業務リソースなし/権限なし |
MESSAGE_REQUIRED | 422 | VALIDATION_ERROR | メッセージ本文必須 |
MESSAGE_TOO_LONG | 422 | VALIDATION_ERROR | メッセージが 10000 文字超過 |
Business failures (HTTP 200) {#business-failures}
Procurement preview/create/pay may return HTTP 200 with success: false when the marketplace refuses the operation but the Gateway request was valid.
{
"channel": "1688",
"success": false,
"code": "ORDER_CREATE_FAILED",
"message": "One or more lines could not be purchased.",
"failed_offers": [
{
"offer_id": "...",
"spec_id": "...",
"error_code": "STOCK_NOT_ENOUGH",
"error_message": "Insufficient stock"
}
],
"request_id": "req_..."
}- Check
successbefore treating the call as completed - Inspect
unavailable_lines(preview) orfailed_offers(create) - Partial success: 1688 may return
success: truewith non-emptyfailed_offers
Product upstream failures {#upstream-product-errors}
Invalid Taobao口令, missing product, or vendor timeouts on product routes typically return 502 with CHANNEL_UPSTREAM_ERROR — not an empty product shell.
Recommended handling {#handling}
- Log
request_idon every error path. - Retry
429and500with exponential backoff; do not retry400/401without fixing input. - On
502 CHANNEL_UPSTREAM_ERROR, surface vendor message to ops; optionally retry once for transient outages. - Order create: use
external_order_id/ Taobaoouter_purchase_idfor idempotency — see Procurement orders.
Get Support
Need integration help? Contact Developer Support at support@hiobuy.com · Response within 1–2 business days