📦 接口文档

🌐 English Version

对外 API 接口说明：

1：使用 vendor-token 请求头鉴权，请联系业务经理。

2：使用 域名，请联系业务经理。

1. 通用说明

以下约定对全部接口通用：订单接口 / Vendor 接口 / 批量操作接口。

对接域名与凭证

对接域名与 vendor-token 均由业务经理提供，请联系你的业务经理获取后再开始接口对接。
项目 说明 获取方式
对接域名 接口请求的基础地址；与下方接口路径拼接即为完整请求地址，例如 https://<对接域名>/api/order/rate 联系业务经理获取
vendor-token 客户身份凭证，每次请求通过请求头携带（见下方「身份认证」） 联系业务经理获取

接口分组与地址

分组 地址 接口
订单接口 /api/order/<action> rate / print / cancel / label / tracking / scan-form
Vendor 接口 /api/vendor/<action> set-web-hook / get-web-hook
批量操作接口 /api/order-batch/<action> create / lists / detail
请求方法：订单接口统一使用 POST； Vendor / 批量接口的查询类接口使用 GET、提交类使用 POST，具体以各接口页标注为准。
参数 说明
Content-Type application/json

身份认证

请求头：所有接口都需要携带 vendor-token 请求头，值为客户表的 token 字段； 该 token 请联系业务经理获取（见上方「对接域名与凭证」）。
未携带、token 失效或客户被禁用时返回 code = 100，需要重新登录。
请求头 必填 说明
vendor-token 是 客户登录 token（客户表 token 字段），联系业务经理获取

统一响应结构

{
    "success": true,   // true=成功 false=失败
    "message": "操作提示",
    "msg":      "操作提示",   // 与 message 一致
    "code":    200,      // 200=成功 400=失败 100=需重新登录
    "data":    {}                     // 业务数据，失败时为空数组
}

状态码

code 含义 说明
200 成功 success = true，业务数据在 data 中
400 失败 success = false，错误信息在 message / msg 中
100 登录失效 token 缺失 / 客户不存在 / 被禁用 / 登录过期，需重新获取 token