CHAOXIN OPEN API · V1

把超鑫选品接入
你的商城与系统

读取商品、价格、仓库和实时库存,提交订单并接收订单状态回调。

快速开始下载 OpenAPI JSON
正式环境https://chaoxinerp.com/api/open/v1

创建真实销售订单,订单进入超鑫 ERP。

测试环境https://chaoxinerp.com/api/open/sandbox/v1

读取真实商品数据,模拟订单不会影响库存。

快速开始

  1. 让超鑫选品管理员在 ERP「合作方 API」中创建合作方。
  2. 安全保存只显示一次的 API Key、API Secret 和 Webhook Secret。
  3. 先调用测试环境,确认签名、商品与订单结构。
  4. 切换到正式环境并保留相同签名方式。
API Secret 只能放在服务器端,不能写进网页、App 或公开代码库。

鉴权签名

所有 API 请求必须携带以下请求头。时间戳与服务器时间相差不能超过 5 分钟;Nonce 不能重复。

请求头说明
X-CX-API-Key合作方 API Key
X-CX-Timestamp10 位 Unix 秒时间戳
X-CX-Nonce16–120 位随机字符串
X-CX-SignatureHMAC-SHA256 十六进制签名

签名原文为五行:时间戳、Nonce、HTTP 方法、完整路径与查询参数、请求体 SHA-256。

const apiKey = process.env.CHAOXIN_API_KEY;
const apiSecret = process.env.CHAOXIN_API_SECRET;
const method = "GET";
const path = "/api/open/sandbox/v1/products?page=1&page_size=20";
const body = "";
const timestamp = Math.floor(Date.now() / 1000).toString();
const nonce = crypto.randomUUID().replaceAll("-", "");
const bodyHash = await sha256(body);
const canonical = [timestamp, nonce, method, path, bodyHash].join("\n");
const signature = await hmacSha256Hex(canonical, apiSecret);

const response = await fetch("https://chaoxinerp.com" + path, {
  headers: {
    "X-CX-API-Key": apiKey,
    "X-CX-Timestamp": timestamp,
    "X-CX-Nonce": nonce,
    "X-CX-Signature": signature
  }
});

商品与实时库存

GET/products

返回有库存的商品仓库记录。支持 page、page_size、q、category、warehouse 和 sku。

传入商品接口返回的 sku 时同时返回套图、详情、属性、尺寸和证书下载地址。图片和证书通过超鑫接口读取,并使用相同的签名鉴权。

合作方只能看到超鑫商品编号、脱敏仓库代码及所在地区;接口不返回上游商品编号、供应商链接、完整仓库地址、联系人或电话。

实时物流报价

POST/shipping-rates

根据收件国家、邮编、商品数量、发货仓、实际重量与材积重返回可用物流渠道和美元运费。当前自动报价仅支持美国境内地址。

{
  "country": "US",
  "postal_code": "91761",
  "items": [
    { "sku": "cxsku_由商品接口返回", "quantity": 1 }
  ]
}

返回结果按脱敏仓库代码分组,每个渠道包含 shipping_service_id、名称、时效备注、Zone、重量、材积重、箱数和费用。商品标价不含运费。

创建和查询订单

POST/orders

external_order_id 同时作为幂等键;重复提交同一合作方订单号不会重复创建。

{
  "external_order_id": "SHOP-20261023-0001",
  "shipping": {
    "name": "收件人",
    "phone": "13100000000",
    "address": "完整收货地址"
  },
  "items": [
    { "sku": "cxsku_由商品接口返回", "quantity": 1 }
  ],
  "note": "选填备注"
}
服务手续费按购买数量收取,每件固定 $1.20,不按商品金额比例计算,也不是每张订单只收一次。
GET/orders?external_order_id=SHOP-20261023-0001

不传外部订单号时返回最近 50 个订单。正式订单进入 ERP「销售订单」,管理员确认发货后扣减库存。

测试环境订单仅用于验证签名、参数与返回结构:不会扣减正式库存、不会扣除账户余额、不会创建真实仓库履约,也不会产生真实物流。

订单状态 Webhook

管理员确认发货或取消 API 订单时,系统向合作方配置的 HTTPS 地址发送 JSON。

{
  "event": "order.updated",
  "created_at": "2026-10-23T08:00:00.000Z",
  "data": {
    "id": "超鑫订单 ID",
    "external_order_id": "合作方订单 ID",
    "status": "shipped",
    "updated_at": "2026-10-23T08:00:00.000Z"
  }
}

使用 X-CX-Webhook-Timestamp 与原始请求体验证 X-CX-Webhook-Signature:

HMAC-SHA256(WebhookSecret, timestamp + "." + rawBody)

错误与限制

  • 默认每个合作方每分钟 60 次,可在 ERP 中设置为 1–600 次。
  • 浏览器跨域调用只允许 ERP 白名单中的完整 HTTPS 来源。
  • 错误响应包含 error.code、error.message 和 request_id。
  • 正式订单最多 50 种商品,每个 SKU 数量为 1–999。
  • 订单价格与库存以服务器接收请求时的数据为准。