Response format

Supported POST routes accept an optional response_format field in the JSON body. Omit it or use standard for the default HIOBuy unified models.

Modes

Value	Description
`standard` (default)	Normalized types — `StandardProductDetail`, `StandardProductList`, `StandardOrderPreviewResult`, etc.
`upstream`	Vendor passthrough — official 1688 Open API or Taobao IOP JSON in `upstream`, without field mapping.

Upstream envelope

When response_format is 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 — primary vendor API identifier (1688 path or Taobao IOP route)
upstream — raw HTTP JSON body from that call
upstream_steps — optional prior calls (e.g. image upload before image search)

Standard preview response {#standard-preview}

POST /v1/orders/preview (1688 and Taobao) returns StandardOrderPreviewResult in standard mode. Amounts are in fen (CNY cents). Field reference: 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 adds trade_types, pay_channels, and promotions. With response_format: "upstream", preview returns raw vendor JSON instead.

Product routes

Endpoint	Channels	Upstream API (examples)
`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 always returns standard only. POST /v1/products/freight/estimate uses the same body as order preview and returns shipping only.

Order routes (1688 & Taobao)

Endpoint	Standard	Upstream API (examples)
`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

Example — 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

Invalid values (e.g. vendor_raw) return HTTP 400 with VALIDATION_ERROR. See Errors.

OpenAPI

Machine-readable spec: openapi.json (schemas UpstreamApiResponse, UpstreamStep).