Lỗi

HIOBuy có hai dạng lỗi: lỗi giao thức (non-2xx kèm error) và thất bại nghiệp vụ (một số route đơn hàng HTTP 200 với 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."
        }
      ]
    }
  }
}
FieldDescription
error.codeMachine-readable enum — use for branching logic
error.messageHuman-readable explanation (English)
error.request_idSame as x-request-id response header
error.categoryCoarse grouping: AUTH_ERROR, RATE_LIMIT_ERROR, VALIDATION_ERROR, CHANNEL_ERROR, INTERNAL_ERROR
error.fieldOptional primary field path related to this error
error.detailsOptional object; validation may include details.fields: [{ field, code, message }]
error.upstreamOptional 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

HTTPWhen
400Unparseable JSON / generic validation
401Invalid API key
403Authenticated but not allowed (including fulfillment mode gate)
404Missing or inaccessible resource
409State / uniqueness conflict
422Parsed body fails business validation
429Rate limit / quota
500 / 502 / 503Internal or upstream failure

Tham chiếu mã lỗi {#error-codes}

Catalog chuẩn: data/errors.catalog.json. Tóm tắt:

CodeHTTPCategoryWhen
INVALID_API_KEY401AUTH_ERRORBearer token không hợp lệ hoặc thiếu
UNAUTHORIZED401AUTH_ERRORAPI key thiếu/không hợp lệ
CHANNEL_NOT_AUTHORIZED401AUTH_ERRORKênh chưa được ủy quyền cho app
FORBIDDEN403AUTH_ERRORKey hợp lệ nhưng không được phép
INSUFFICIENT_SCOPE403AUTH_ERRORThiếu scope bắt buộc cho route
CHANNEL_NOT_ENABLED403AUTH_ERRORKênh chưa bật cho app
CHANNEL_AUTH_REQUIRED403AUTH_ERRORChưa hoàn tất ủy quyền kênh
CHANNEL_AUTH_EXPIRED403AUTH_ERRORỦy quyền kênh hết hạn — ủy quyền lại trên Portal
CHANNEL_AUTH_REVOKED403AUTH_ERRORỦy quyền kênh bị thu hồi
FULFILLMENT_MODE_NOT_SUPPORTED403AUTH_ERROR/v1/fulfillment/* trên app self-fulfillment
FULFILLMENT_ACCESS_REQUIRED403AUTH_ERROR(Dự trữ) chưa cấp quyền fulfillment
FULFILLMENT_ACCESS_SUSPENDED403AUTH_ERROR(Dự trữ) quyền fulfillment bị tạm dừng
WAREHOUSE_AUTH_REQUIRED403AUTH_ERRORFulfillment kho nhưng chưa ủy quyền kho
WAREHOUSE_AUTH_EXPIRED403AUTH_ERRORỦy quyền kho hết hạn
WAREHOUSE_AUTH_INVALID403AUTH_ERRORWarehouse rejected developer authentication
VALIDATION_ERROR400VALIDATION_ERRORThiếu/sai trường body, tiền tệ không hỗ trợ
UNSUPPORTED_CHANNEL400VALIDATION_ERRORGiá trị channel không xác định
UNSUPPORTED_FIELD400VALIDATION_ERRORTrường không được phép trên route này
NOT_FOUND404VALIDATION_ERRORRoute hoặc tài nguyên không tồn tại
CHANNEL_CAPABILITY_NOT_SUPPORTED400CHANNEL_ERRORThao tác không khả dụng trên kênh
CHANNEL_UPSTREAM_ERROR502CHANNEL_ERRORMarketplace từ chối (đã che)
WAREHOUSE_UPSTREAM_ERROR502CHANNEL_ERRORUpstream kho/fulfillment lỗi (đã che)
INTERNAL_ERROR500INTERNAL_ERRORGateway lỗi bất ngờ — thử lại kèm backoff
RATE_LIMIT_EXCEEDED429RATE_LIMIT_ERRORVượt rate limit / phút
QUOTA_EXCEEDED429RATE_LIMIT_ERRORHết hạn mức kênh theo ngày
PLATFORM_QUOTA_EXCEEDED429RATE_LIMIT_ERRORChạm trần dung lượng tháng nền tảng
PAYMENT_DECLINED402VALIDATION_ERRORThanh toán bị từ chối
PAYMENT_INSUFFICIENT_FUNDS402VALIDATION_ERRORKhông đủ tiền
ORDER_ALREADY_PAID409VALIDATION_ERRORĐơn đã thanh toán
ORDER_CANCELLED409VALIDATION_ERRORĐơn đã hủy
PRODUCT_UNAVAILABLE422VALIDATION_ERRORSản phẩm không bán / gỡ bán
IDEMPOTENCY_CONFLICT409VALIDATION_ERRORTrùng external_shipment_id hoặc khóa idempotency
EXTERNAL_ORDER_ID_ALREADY_EXISTS409VALIDATION_ERRORexternal_order_id đã dùng trong app
PARCEL_NOT_FOUND404VALIDATION_ERRORParcel không hợp lệ hoặc chưa inbound
INVALID_SHIPPING_CHANNEL400VALIDATION_ERRORshipping_channel_code không hợp lệ
INSUFFICIENT_BALANCE402VALIDATION_ERRORSố dư ví fulfillment quá thấp
SHIPMENT_ALREADY_PAID409VALIDATION_ERRORInternational shipment already paid
SHIPMENT_NOT_FOUND404VALIDATION_ERRORShipment missing or not owned
SHIPMENT_NOT_INTERCEPTABLE409VALIDATION_ERRORCurrent shipment state cannot request intercept
SHIPMENT_INTERCEPTION_ALREADY_REQUESTED409VALIDATION_ERRORIntercept already requested
INVALID_INTERCEPTION_REASON422VALIDATION_ERRORIntercept reason CODE is invalid
INTERCEPTION_REMARK_REQUIRED422VALIDATION_ERRORremark required when reason is OTHER
SHIPMENT_CREATE_EXCEPTION400VALIDATION_ERRORCreate refused (missing item attributes, parcel not inbound, etc. — read message)
SHIPMENT_NOT_CANCELLABLE409VALIDATION_ERRORShipment cannot be cancelled in current status
SHIPMENT_ALREADY_CANCELLED409VALIDATION_ERRORShipment already cancelled
PACKAGE_ALREADY_CONSOLIDATED409VALIDATION_ERRORParcel already in another shipment
INBOUND_TRACKING_ALREADY_SHIPPED409VALIDATION_ERRORTracking đã gắn kiện đã gửi
INBOUND_TRACKING_ALREADY_EXISTS409VALIDATION_ERRORTracking đã đăng ký
INBOUND_VALIDATION_FAILED422VALIDATION_ERRORLỗi trường inbound trong details.fields
INBOUND_NOT_FOUND404VALIDATION_ERRORInbound không tồn tại / không thuộc sở hữu
PACKAGE_NOT_FOUND404VALIDATION_ERRORKiện không tồn tại / không thuộc sở hữu
INBOUND_NOT_EDITABLE409VALIDATION_ERRORInbound không sửa được ở trạng thái hiện tại
INBOUND_ALREADY_RECEIVED409VALIDATION_ERRORĐã nhận tại kho
INBOUND_PACKAGE_MISMATCH409VALIDATION_ERRORKhông liên kết được inbound/kiện
INVALID_TRACKING_NUMBER422VALIDATION_ERRORĐịnh dạng tracking không hợp lệ
PACKAGE_COUNT_INVALID422VALIDATION_ERRORpackage_count không hợp lệ
TOTAL_VALUE_INVALID422VALIDATION_ERRORtotal_value không hợp lệ
UNSUPPORTED_CURRENCY422VALIDATION_ERRORTiền tệ không hỗ trợ (inbound: CNY/USD/KRW)
UNCLAIMED_PACKAGE_NOT_FOUND404VALIDATION_ERRORKiện chưa nhận chủ không tồn tại
TRACKING_NUMBER_MISMATCH422VALIDATION_ERRORClaim không khớp chính xác
PACKAGE_ALREADY_CLAIMED409VALIDATION_ERRORKiện đã được claim
PACKAGE_NOT_CLAIMABLE409VALIDATION_ERRORKhông claim được ở trạng thái hiện tại
CLAIM_ATTEMPTS_EXCEEDED429RATE_LIMIT_ERRORQuá nhiều lần claim thất bại trên một ucp_*
RETURN_NOT_FOUND404VALIDATION_ERRORReturn không tồn tại / không thuộc sở hữu
RETURN_NOT_CONFIRMABLE409VALIDATION_ERRORKhông xác nhận được return
RETURN_NOT_CANCELLABLE409VALIDATION_ERRORKhông hủy được return
RETURN_ALREADY_RETURNED409VALIDATION_ERRORĐã hoàn
RETURN_ALREADY_CANCELLED409VALIDATION_ERRORĐã hủy / vô hiệu
RETURN_FEE_NOT_READY409VALIDATION_ERRORChưa tính phí return
RETURN_FEE_CHANGED409VALIDATION_ERRORSố tiền xác nhận ≠ fee.total
PACKAGE_NOT_RETURNABLE409VALIDATION_ERRORTrạng thái kiện chặn return
INVALID_RETURN_REASON422VALIDATION_ERRORMã lý do return không xác định
INVALID_RETURN_ADDRESS422VALIDATION_ERRORĐịa chỉ seller_return không hợp lệ
RETURN_VALIDATION_FAILED422VALIDATION_ERRORXác thực trường return thất bại
VALUE_ADDED_SERVICE_NOT_FOUND422VALIDATION_ERRORKhông rõ VAS service_code
VALUE_ADDED_SERVICE_UNAVAILABLE422VALIDATION_ERRORVAS tồn tại nhưng không khả dụng
VALUE_ADDED_SERVICE_INVALID_STAGE422VALIDATION_ERRORVAS không cho phép ở giai đoạn này
VALUE_ADDED_SERVICE_QUANTITY_INVALID422VALIDATION_ERRORSố lượng VAS không hợp lệ
SERVICE_REQUEST_NOT_FOUND404VALIDATION_ERRORKhông có yêu cầu dịch vụ
RESOURCE_NOT_FOUND404VALIDATION_ERRORThiếu tài nguyên liên quan
RESOURCE_NOT_ELIGIBLE_FOR_SERVICE409VALIDATION_ERRORKiện/lô hàng không đủ điều kiện
SERVICE_FEE_NOT_READY409VALIDATION_ERRORPhí dịch vụ chưa sẵn sàng
SERVICE_FEE_CHANGED409VALIDATION_ERRORSố tiền xác nhận ≠ phí dịch vụ
SERVICE_REQUEST_VALIDATION_FAILED422VALIDATION_ERRORXác thực yêu cầu dịch vụ thất bại
TRANSACTION_NOT_FOUND404VALIDATION_ERRORGiao dịch không tồn tại / không thuộc sở hữu
INVOICE_NOT_FOUND404VALIDATION_ERRORHóa đơn không tồn tại / không thuộc sở hữu
TRANSACTION_NOT_INVOICEABLE409VALIDATION_ERRORGiao dịch không thể xuất hóa đơn
TRANSACTION_ALREADY_INVOICED409VALIDATION_ERRORGiao dịch đã xuất hóa đơn
TRANSACTION_INVOICE_PENDING409VALIDATION_ERRORHóa đơn đang pending
INVOICE_NOT_DOWNLOADABLE409VALIDATION_ERRORHóa đơn chưa phát hành
INVOICE_VALIDATION_FAILED422VALIDATION_ERRORXác thực yêu cầu hóa đơn thất bại
INVOICE_CURRENCY_MISMATCH422VALIDATION_ERRORKhông khớp tiền tệ hóa đơn
INVALID_INVOICE_TITLE422VALIDATION_ERRORTiêu đề hóa đơn không hợp lệ
INVALID_TAX_NUMBER422VALIDATION_ERRORMã số thuế không hợp lệ
INVALID_BILLING_ADDRESS422VALIDATION_ERRORbilling_address missing or invalid
TICKET_NOT_FOUND404VALIDATION_ERRORTicket không tồn tại / không thuộc Application
TICKET_NOT_REPLYABLE409VALIDATION_ERRORKhông trả lời được ticket (vd. đã đóng)
TICKET_ALREADY_CLOSED409VALIDATION_ERRORTicket đã đóng
INVALID_TICKET_CATEGORY422VALIDATION_ERRORDanh mục ticket không hợp lệ
INVALID_TICKET_PRIORITY422VALIDATION_ERRORĐộ ưu tiên ticket không hợp lệ
INVALID_RELATED_RESOURCE422VALIDATION_ERRORLoại related_resource không hợp lệ
TICKET_VALIDATION_FAILED422VALIDATION_ERRORXác thực trường ticket thất bại
RELATED_RESOURCE_NOT_FOUND404VALIDATION_ERRORThiếu tài nguyên nghiệp vụ liên quan
MESSAGE_REQUIRED422VALIDATION_ERRORBắt buộc nội dung tin nhắn
MESSAGE_TOO_LONG422VALIDATION_ERRORTin nhắn vượt 10000 ký tự

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 success before treating the call as completed
  • Inspect unavailable_lines (preview) or failed_offers (create)
  • Partial success: 1688 may return success: true with non-empty failed_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.

  1. Log request_id on every error path.
  2. Retry 429 and 500 with exponential backoff; do not retry 400 / 401 without fixing input.
  3. On 502 CHANNEL_UPSTREAM_ERROR, surface vendor message to ops; optionally retry once for transient outages.
  4. Order create: use external_order_id / Taobao outer_purchase_id for idempotency — see Procurement orders.

Get Support

Need integration help? Contact Developer Support at support@hiobuy.com · Response within 1–2 business days

Email support