Định dạng phản hồi

Một số route POST của HIOBuy Public API hỗ trợ hai dạng phản hồi. Có thể truyền response_format tùy chọn trong JSON body.

Tóm tắt

Mặc định là standard. Bỏ qua response_format hoặc dùng "response_format": "standard".

	`standard` (khuyến nghị)	`upstream`
Nội dung trả về	Model thống nhất HIOBuy — cùng cấu trúc JSON trên mọi channel	JSON gốc từ nhà cung cấp upstream (1688 Open API, Taobao IOP, …)
Ánh xạ field	HIOBuy Gateway xử lý	Không — giống tài liệu chính thức của vendor
1688 vs Taobao	Một interface → một cấu trúc; đổi `channel` không cần viết lại parser	Mỗi channel trả JSON upstream khác nhau
Khi nào dùng	Tích hợp production, ứng dụng đa channel	Debug theo tài liệu vendor, migration

Khuyến nghị: Tích hợp thông thường dùng standard. Chỉ dùng upstream khi cần payload gốc từ nhà cung cấp.

Chế độ

Giá trị	Mô tả
`standard` (mặc định)	Kiểu chuẩn hóa HIOBuy — cùng cấu trúc dù `channel` là `1688` hay `taobao`.
`upstream`	Truyền nguyên upstream — JSON chính thức 1688 / Taobao trong `upstream`, không map field HIOBuy.

Envelope upstream

Khi response_format là upstream:

{
  "channel": "1688",
  "response_format": "upstream",
  "upstream_api": "com.alibaba.fenxiao.crossborder/product.search.keywordQuery",
  "upstream": {
    "result": {
      "success": true
    }
  },
  "upstream_steps": [],
  "request_id": "req_abc123"
}

upstream_api — định danh API vendor chính (path 1688 hoặc route Taobao IOP)
upstream — HTTP JSON body thô từ cuộc gọi đó
upstream_steps — các cuộc gọi trước đó tùy chọn (ví dụ upload ảnh trước khi tìm bằng ảnh)

Phản hồi preview chuẩn {#standard-preview}

POST /v1/orders/preview (1688 và Taobao) trả về StandardOrderPreviewResult ở chế độ standard. Số tiền tính bằng fen (cent CNY). Tham chiếu field: Procurement orders.

{
  "channel": "taobao",
  "success": true,
  "total": {
    "payment": {
      "amount": 12900,
      "currency": "CNY"
    },
    "shipping": {
      "amount": 0,
      "currency": "CNY"
    }
  },
  "unavailable_lines": [],
  "sellers": [
    {
      "seller_id": "...",
      "lines": [
        {
          "offer_id": "...",
          "spec_id": "...",
          "quantity": 5
        }
      ]
    }
  ],
  "request_id": "req_..."
}

1688 bổ sung trade_types, pay_channels và promotions. Với response_format: "upstream", preview trả về JSON vendor thô.

Product routes

Endpoint	Kênh	Upstream API (ví dụ)
`POST /v1/products/detail`	1688, taobao	`queryProductDetail` / `/traffic/item/get`
`POST /v1/products/search`	1688, taobao	`keywordQuery` / `/traffic/item/search`
`POST /v1/products/search-by-image`	1688, taobao	upload + `imageQuery` / upload + `/traffic/item/imgsearch`

POST /v1/products/parse luôn chỉ trả về standard. POST /v1/products/freight/estimate dùng cùng body với order preview và chỉ trả phí vận chuyển.

Order routes (1688 & Taobao)

Endpoint	Standard	Upstream API (ví dụ)
`POST /v1/orders/list`	✓	`alibaba.trade.getBuyerOrderList`
`POST /v1/orders/1688/preview`	✓	`alibaba.createOrder.preview`
`POST /v1/orders/1688/create`	✓	`alibaba.trade.createCrossOrder`
`POST /v1/orders/preview`	✓	Dispatches by `channel` (1688 / taobao)
`POST /v1/orders/create`	✓	Dispatches by `channel`
`POST /v1/orders/taobao/preview`	✓	`/purchase/order/render`
`POST /v1/orders/taobao/create`	✓	`/purchase/order/create`
`POST /v1/orders/cancel`	✓	`alibaba.trade.cancel`
`POST /v1/orders/pay`	✓	Dispatches by `channel`
`POST /v1/orders/detail`	✓	Order detail by `order_id`
`POST /v1/orders/logistics/trace`	✓	Domestic logistics trace
`POST /v1/orders/purchase/query`	✓	Taobao purchase list

Ví dụ — upstream search

curl https://api.hiobuy.com/v1/products/search \
  -H "Authorization: Bearer hio_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "response_format": "upstream",
    "channel": "1688",
    "keyword": "phone case",
    "page": 1,
    "page_size": 10,
    "language": "en"
  }'

Validation

Giá trị không hợp lệ (ví dụ vendor_raw) trả về HTTP 400 với VALIDATION_ERROR. Xem Errors.

OpenAPI

Spec cho máy đọc: openapi.json (schemas UpstreamApiResponse, UpstreamStep).

Get Support

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

Email support