01 1. 适用范围
API 目录用于指导三方电商客户把店铺、ERP 或平台账号接入 Burton WMS Ai。接入完成后,订单、商品、库存、客户、发货状态和物流信息可以在销售渠道与仓库系统之间同步。
本文档不提供真实密钥、客户订单明细或平台后台截图中的敏感字段。运营人员在对外发送截图前,需要确认截图中没有 Token、Secret、客户邮箱、收货地址或订单号明细。
安全原则:API 凭证只用于授权配置,不进入公开文档,不通过群聊公开传播,也不写在截图备注里。
02 2. 文档目录
| 章节 | 适合对象 | 解决的问题 |
|---|---|---|
| API 接入总览与文档目录 | 客户负责人 / 实施 / 管理员 | 明确接入范围、角色分工、上线顺序和验收清单。 |
| API 授权操作指引 | 店铺管理员 / 实施 | 说明 OAuth、API Key、Token 授权入口和验证方式。 |
| API 同步规则 | 运营 / 仓库 / 客户成功 | 说明订单、商品、库存、发货回传如何流转。 |
| API 常见问题与报错排查 | 客服 / 实施 / 管理员 | 快速定位授权失败、无订单、SKU 不匹配、物流不可用等问题。 |
03 3. 接入生命周期
| 阶段 | 客户需要做什么 | Burton 团队检查什么 |
|---|---|---|
| 准备账号 | 确认登录账号、店铺管理员权限和 API 授权权限。 | Approvals、Access Control、工作区和角色权限。 |
| 连接渠道 | 选择 Shopify、TikTok Shop、Amazon、eBay、Wayfair、Walmart 等渠道。 | Integrations 或 Setup Wizard 的连接状态。 |
| 验证同步 | 检查 Orders、Products、Inventory Products 是否出现数据。 | 同步日志、SKU 映射、仓库范围和渠道范围。 |
| 履约回传 | 确认 Carrier、Tracking、Ship Date、Fulfillment Status 的回传规则。 | 发货回传开关、物流渠道、平台要求字段。 |
| 对账复盘 | 导出订单、商品、库存报表进行核对。 | Reports 导出、异常订单和活动日志。 |
04 4. 推荐角色分工
| 角色 | 建议权限 | 工作重点 |
|---|---|---|
| 客户店铺管理员 | Integrations 授权、店铺后台授权 | 提供合法授权,确认店铺范围和授权账号。 |
| 客户运营 | Orders、Products、Inventory、Reports | 核对订单、商品、SKU 和库存是否同步正确。 |
| 仓库团队 | Inventory、Receiving、Work Orders | 执行收货、拣货、打包、发货和库存调整。 |
| 实施顾问 | Integrations、Setup Wizard、Activity Logs | 连接渠道、检查日志、处理上线异常。 |
| 系统管理员 | Access Control、Approvals | 管理用户、权限、审批和敏感配置入口。 |
05 5. 上线验收清单
- 账号已审批,用户可以进入正确工作区。
- 渠道状态为 Connected 或已通过连接测试。
- 至少抽查 3 到 5 个 SKU,确认平台 SKU、仓库 SKU、系统 SKU 的映射一致。
- 至少抽查 3 到 5 个订单,确认订单状态、收货信息、商品明细和履约状态正确。
- 库存字段 On Hand、Committed、Incoming、Available 可以解释清楚,并与仓库口径一致。
- 发货回传字段和平台要求一致,尤其是 Carrier、Tracking、Ship Date。
- Reports 可以导出客户需要的订单、商品和库存 CSV。

Integrations 是渠道连接和授权管理的主要入口。

Access Control 用于限制哪些用户可以管理授权、凭证和后台设置。