International fulfillment overview
/v1/fulfillment/* covers international logistics after goods are in the HIOBuy warehouse. Domestic buying: Procurement orders.
Requires warehouse fulfillment on your app (Portal authorization). Self-fulfillment apps get 403 FULFILLMENT_MODE_NOT_SUPPORTED.
API availability {#availability}
| Path | Status |
|---|---|
/v1/fulfillment/shipments/* | Planned — spec stable; Gateway rollout in progress |
/v1/fulfillment/balance | Planned |
/v1/shipments (legacy) | Deprecated |
End-to-end flow {#end-to-end-flow}
- Create procurement order → seller ships to warehouse
- Order detail →
parcel_nos[]when inbound - Freight estimate → pick
shipping_channel_code - Shipment preview → exact price
- Create shipment →
shipment_id - Pay shipment → deduct wallet
- International tracking
Endpoint guide
| Topic | Path | Doc |
|---|---|---|
| Quick freight quote | POST .../freight/estimate | Freight estimate |
| Exact warehouse quote | POST .../preview | Shipment preview |
| Create / pay / cancel / detail | POST .../shipments/* | Shipments |
| International trace | POST .../logistics/trace | Tracking |
| Wallet balance | GET /v1/fulfillment/balance | Balance |
| Response fields | — | Fulfillment response models |
| Item attributes | GET .../item-attributes | Freight estimate |
Warehouse-mode procurement
/v1/orders/* paths unchanged; Gateway forwards to HIOBuy. Product APIs still call marketplaces directly.
Domestic trace: order logistics trace (proxied in warehouse mode).
Errors
FULFILLMENT_MODE_NOT_SUPPORTED, PARCEL_NOT_FOUND, INVALID_SHIPPING_CHANNEL, INSUFFICIENT_BALANCE — see Errors.