BitHub — API 文档 | API Reference

认证方式

所有 API 请求需在 Header 中携带 Authorization: Bearer API_KEY。API Key 可在后台「个人设置 - API 管理」中生成和吊销。

Authorization: Bearer bithub_sk_live_xxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

可用接口

订单 Orders

GET/api/v1/orders获取订单列表，支持按店铺、日期范围、状态筛选。

# 请求示例
curl -H "Authorization: Bearer bithub_sk_live_xxx" \\
  "https://api.bithub.com/api/v1/orders?store_id=123&status=shipped&page=1"

# 响应示例
{
  "total": 312, "page": 1, "per_page": 20,
  "data": [{
    "order_id": "112-0000001-0000002",
    "store_id": 123, "store_name": "US · MyStore",
    "amount": 29.99, "currency": "USD",
    "status": "shipped",
    "customer": { "name": "John Smith", "phone": "+1..." },
    "shipping": { "city": "New York", "state": "NY", "zip": "10001", "country": "US" },
    "created_at": "2026-09-20T10:23:00Z"
  }]
}

GET/api/v1/orders/{id}获取单个订单详情。

商品 Products

GET/api/v1/products获取商品列表。

POST/api/v1/products创建新商品。

# 创建商品请求体
{
  "store_id": 123, "sku": "SKU-001", "asin": "B0XXXXXXX",
  "title": "My Product Title", "price": 29.99, "stock": 50, "cost": 8.50,
  "images": ["https://.../main.jpg"],
  "description_html": "Rich-text description"
}

店铺 Stores

GET/api/v1/stores获取已授权的店铺列表及同步状态。

错误码

401 Unauthorized        API Key 无效或缺失
403 Forbidden           当前套餐无权限调用
404 Not Found           资源不存在
429 Too Many Requests    超出频率限制（1000 次/分钟）
500 Internal Error      服务内部错误

沙箱环境

专业版客户可申请沙箱环境 https://sandbox.bithub.com，独立 API Key 和测试数据，免费联调。

频率限制

默认 1000 次请求 / 分钟 / 账号。更大业务量请联系客服升级。