API文档

API

0.公共参数

请求地址:

环境 HTTP请求地址
测试环境 https://e8dev.boudata.com
生产环境 https://tms.boudata.com

公共请求参数 header:

编码 描述 备注
uName 对接账号 uName和uToken由我方提供
uSign 签名 MD5(uToken + timestamp)
timestamp 时间戳 System.currentTimeMillis()

1.下单

接口地址:/tss/openapi/v1/order/create


body参数:

编码 类型 必填 示例 描述
customerOrderNo String TRUE 客户订单号
sendMan String TRUE 寄件人
sendPhone String TRUE 寄件人电话
sendProvince String TRUE 浙江省 寄件省份
sendCity String TRUE 杭州市 寄件城市
sendDistrict String FALSE 江干区 寄件区县
sendTown String FALSE 寄件乡镇
sendStreetNo String TRUE 寄件人详细地址
receiveCompany String FALSE 收件公司
receiveMan String TRUE 收件人
receivePhone String TRUE 收件人电话
receiveProvince String TRUE 浙江省 收件省份
receiveCity String TRUE 杭州市 收件城市
receiveDistrict String FALSE 江干区 收件区县
receiveTown String FALSE 收件乡镇
receiveStreetNo String TRUE 收件人详细地址
receiveStreetNo String TRUE 算力小镇 收件人详细地址
serviceMode String FALSE 派送, 站点自提, 中心自提, 自提 派送方式
settleType String TRUE 寄付, 到付, 月结 结算方式
insuranceLimit BigDecimal FALSE 保价额
cod BigDecimal FALSE 代收货款金额
ifVisit Boolean TRUE 需要上门提货
remark String FALSE 备注
subOrderList List<Object> TRUE 子单集合
└ amount Integer TRUE └ 件数
└ weight BigDecimal TRUE └ 重量
└ volume BigDecimal TRUE └ 体积
└ cargo String TRUE └ 货物
└ pack String FALSE └ 包装

响应参数:

编码 类型 必填 示例 描述
result Boolean TRUE 结果
code String TRUE 响应编码 编码
errorMsg String 错误信息
data Object 新建订单返回对象
└ orderNo String └ TMS单号

2.查轨迹

接口地址:/tss/openapi/v1/order/trace


body参数:

编码 类型 必填 示例 描述
orderNo String TRUE TMS单号

响应参数:

编码 类型 必填 示例 描述
result Boolean TRUE 结果
code String TRUE 响应编码 编码
errorMsg String Result=false时会有该属性 错误信息
data List<Object> 轨迹对象集合
└ scanDate Date TRUE 2025-12-12 12:12:12 └ 时间
└ scanType String TRUE normal,sign └ 类型
└ description String TRUE └ 描述

3.取消订单

接口地址:/tss/openapi/v1/order/cancel


body参数:

编码 类型 必填 示例 描述
orderNo String TRUE TMS单号
cancelReason String TRUE 取消原因

响应参数:

编码 类型 必填 示例 描述
result Boolean TRUE 结果
code String TRUE 响应编码 编码
errorMsg String Result=false时会有该属性 错误信息

4.签收面单

接口地址:/tss/openapi/v1/order/sign/picture


body参数:

编码 类型 必填 示例 描述
orderNo String TRUE TMS单号

响应参数:

编码 类型 必填 示例 描述
result Boolean TRUE 结果
code String TRUE 响应编码 编码
errorMsg String Result=false时会有该属性 错误信息
data List<Object> 签收面单对象集合
└ fileName String TRUE 123.png └ 文件名
└ fileSrc String TRUE 一个oss地址 └ 文件地址

9.Apipost Demo

                // 0 预执行操作脚本, 处理所有请求公共header参数
                var uName = "xxx";
                var uToken = "xxx";
                var timestamp = new Date().getTime();
                var uSign = $.md5(uToken + timestamp);
                console.log(
                    "uName = " + uName
                    + ", timestamp = " + timestamp
                    + ", uSign = " + uSign
                )
                apt.setRequestHeader("uName", uName);
                apt.setRequestHeader("timestamp", timestamp);
                apt.setRequestHeader("uSign", uSign);
            
                // 1 新建订单body
                {
                    "customerOrderNo": "2025031105",
                    "sendMan": "张三x",
                    "sendPhone": "18767166333",
                    "sendProvince": "浙江省",
                    "sendCity": "杭州市",
                    "sendDistrict": "江干区",
                    "sendStreetNo": "一号大街华媒科创园",
                    "receiveMan": "李四yz",
                    "receivePhone": "18767166449",
                    "receiveProvince": "北京市",
                    "receiveCity": "北京市",
                    "receiveDistrict": "东城区",
                    "receiveStreetNo": "中关村",
                    "cod": 9999.0,
                    "insuranceLimit": 4000.0,
                    "ifVisit": true,
                    "serviceMode": "派送",
                    "settleType": "月结",
                    "remark": "请尽快上门取货",
                    "subOrderList": [
                        {
                            "amount": "1",
                            "volume": "112.22",
                            "weight": "1100.41",
                            "cargo": "电脑",
                            "pack": "纸箱"
                        },
                        {
                            "amount": "2",
                            "volume": "112.22",
                            "weight": "1100.41",
                            "cargo": "冰箱",
                            "pack": "纸箱"
                        }
                    ]
                }
            
                // 2 查轨迹body
                {
                    "orderNo": "8600491480"
                }
            
                // 3 取消订单body
                {
                    "orderNo": "8600491480",
                    "cancelReason": "不发了"
                }
            
                // 4 查签收面单body
                {
                    "orderNo": "8600491480"
                }