📦 接口文档

🌐 English Version

对外 API 接口说明：

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

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

POST set-web-hook 设置轨迹推送地址

地址：/api/vendor/set-web-hook　·　说明：设置当前客户的轨迹推送回调地址；传空字符串表示清除 / 停用推送。

说明：轨迹推送地址用于接收订单轨迹的回调通知。设置成功后，订单轨迹发生变化时系统会向该地址推送； 地址留空（传空字符串）即表示停用推送。该接口作用于当前 vendor-token 对应的客户。

参数说明

参数 必填 类型 说明
tracking_hook 选填 string 轨迹推送回调地址，最大 255 字符；传空字符串表示清除 / 停用推送

请求示例

POST /api/vendor/set-web-hook
Header: vendor-token: xxxxx
Content-Type: application/json
{
    "tracking_hook": "https://www.example.com/api/tracking/callback"
}
停用推送：将 tracking_hook 传为空字符串 "" 即可清除已设置的地址。

返回示例

{
    "success": true,
    "message": "tracking_hook 设置成功",
    "code": 200,
    "data": {
        "vendor_id": 1024,
        "tracking_hook": "https://www.example.com/api/tracking/callback"
    }
}
data 字段 类型 说明
vendor_id int 当前客户 ID
tracking_hook string 设置后的轨迹推送地址（空字符串表示已清除 / 未设置）