网站API对接文档
POST
获取账户余额
POST
获取快递列表
POST
获取仓库列表
POST
获取礼品/自提件列表
POST
购买礼品/自提件
POST
查询快递单号
POST
删除订单并退款
POST
更新取件码
获取账户余额 更新时间：2022-02-10 17:28:00
基本信息
- 温馨提示： 下面URL的域名为开发时本地测试用，实际使用时须更改为对接网站域名！
- 接口URL：
http://127.0.0.11:8086/apiv1/get_money.html - 请求方式：
POST - Content-Type：
application/x-www-form-urlencoded
请求参数
body参数及说明
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| u | 90000 | String | 是 | UID（在"会员中心"→"账号管理"查看） |
| m | 13888888888 | String | 是 | 登录账号 |
| t | 1644484214 | String | 是 | 当前时间戳 |
| sign | 514de2babf88504ecc78c24020c15306 | String | 是 | "ApiKey+8b795683fb9485430ce84ceb78cda9786d564150+UID+登录账号+当前时间戳"拼接后进行32位md5加密 （ApiKey在"会员中心"→"账号管理"查看） |
响应示例
获取快递列表 更新时间：2022-02-10 17:28:00
基本信息
- 温馨提示： 下面URL的域名为开发时本地测试用，实际使用时须更改为对接网站域名！
- 接口URL：
http://127.0.0.11:8086/apiv1/get_express_list.html - 请求方式：
POST - Content-Type：
application/x-www-form-urlencoded
请求参数
body参数及说明
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| u | 90000 | String | 是 | UID（在"会员中心"→"账号管理"查看） |
| m | 13888888888 | String | 是 | 登录账号 |
| t | 1644484214 | String | 是 | 当前时间戳 |
| sign | 514de2babf88504ecc78c24020c15306 | String | 是 | "ApiKey+8b795683fb9485430ce84ceb78cda9786d564150+UID+登录账号+当前时间戳"拼接后进行32位md5加密 （ApiKey在"会员中心"→"账号管理"查看） |
响应示例
成功响应示例
{
"success": true,
"msg": "快递列表",
"datalist": [
{
"kdid": "258", //快递ID
"platform": "1", //1淘宝天猫 2拼多多 3阿里 4京东 9抖音 10快手
"express_type": "3", //1普通面单 2拼多多电子面单 3菜鸟电子面单 4京东无界面单 5抖音电子面单 6快手电子面单
"type": "3", //1系统单号 2寄自提件 3礼品代发 4无货源中转 5无货源安抚
"state": "2", //1正常 2暂停 3下架
"name": "中通快递", //快递名称
"text": "支持【淘宝】【天猫】【阿里】", //支持平台说明
"remarks": "【1秒-10秒出单号】【不可删】" //备注说明
},
{
"kdid": "259",
"platform": "2",
"express_type": "2",
"type": "3",
"state": "1",
"name": "中通快递",
"text": "支持【拼多多】",
"remarks": "【1秒-10秒出单号】【地址错误会导致揽收不了，出不了物流】【不可删】"
}
]
}失败响应示例
{
"success": false,
"code": 402,
"message": "签名已过期-1644403644"
}获取仓库列表 更新时间：2022-02-10 17:28:00
基本信息
- 温馨提示： 下面URL的域名为开发时本地测试用，实际使用时须更改为对接网站域名！
- 接口URL：
http://127.0.0.11:8086/apiv1/get_warehouse_list.html - 请求方式：
POST - Content-Type：
application/x-www-form-urlencoded
请求参数
body参数及说明
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| u | 90000 | String | 是 | UID（在"会员中心"→"账号管理"查看） |
| m | 13888888888 | String | 是 | 登录账号 |
| t | 1644483142 | String | 是 | 当前时间戳 |
| sign | a584259da2ff478cf0e477468b4f43b2 | String | 是 | "ApiKey+8b795683fb9485430ce84ceb78cda9786d564150+UID+登录账号+当前时间戳"拼接后进行32位md5加密 （ApiKey在"会员中心"→"账号管理"查看） |
| kdid | 77 | String | 是 | 快递ID，请先获取快递列表查询 |
响应示例
成功响应示例
{
"success": true,
"smg": "仓库列表",
"datalist": [
{
"warehouse": "218", //仓库ID
"kdid": "77", //快递ID
"type": "3", //1系统单号 2寄自提件 3礼品代发 4无货源中转 5无货源安抚
"name": "福建泉州", //仓库名称
"state": "1", //1正常 2暂停 3下架
"province": "福建省", //省
"city": "泉州市", //市
"district": "安溪县", //区/县
"address": "祥云路吾都", //详细地址
"zipcode": "000000" //邮编
},
{
"warehouse": "3059",
"kdid": "77",
"type": "3",
"name": "苏州邮政",
"state": "1",
"province": "江苏省",
"city": "苏州市",
"district": "昆山市",
"address": "车站路99号",
"zipcode": "000000"
}
]
}失败响应示例
{
"success": false,
"code": 402,
"message": "签名错误"
}获取礼品/自提件列表 更新时间：2022-02-10 17:28:00
基本信息
- 温馨提示： 下面URL的域名为开发时本地测试用，实际使用时须更改为对接网站域名！
- 接口URL：
http://127.0.0.11:8086/apiv2/get_gift_list.html - 请求方式：
POST - Content-Type：
application/x-www-form-urlencoded
请求参数
body参数及说明
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| u | 90000 | String | 是 | UID（在"会员中心"→"账号管理"查看） |
| m | 13888888888 | String | 是 | 登录账号 |
| t | 1644483142 | String | 是 | 当前时间戳 |
| sign | a584259da2ff478cf0e477468b4f43b2 | String | 是 | "ApiKey+8b795683fb9485430ce84ceb78cda9786d564150+UID+登录账号+当前时间戳"拼接后进行32位md5加密 （ApiKey在"会员中心"→"账号管理"查看） |
响应示例
成功响应示例
{
"success": true,
"msg": "礼品/自提件列表",
"datalist": [
{
"id": "156-3324-11648", //礼品代发 快递ID-仓库ID-礼品ID（礼品ID为0时代表是自提件） 下单时传这个
"money": 1.53, //下单价格
"express_name": "圆通快递", //快递名称
"platform": "抖音", //支持的电商平台
"gift_image": "http://tupian.aliyuncs.com/61753c03eb9ca.jpg", //礼品图片
"gift_name": "洗衣粉", //礼品名称
"weight": "0.10", //礼品重量
"lipin_money": "0.20", //礼品价格
"state": "正常", //礼品状态
"store_name": "绍兴市上虞区", //仓库名称
"store_address": "浙江省 绍兴市 上虞区 五星西路22号" //仓库地址
},
{
"id": "95-3589-0", //自提件 快递ID-仓库ID-礼品ID（礼品ID为0时代表是自提件） 下单时传这个
"money": 0.75,
"state": "正常",
"express_name": "圆通快递",
"platform": "拼多多",
"gift_image": "http://tupian.aliyuncs.com/101/236-1605447255.png",
"gift_name": "自提件",
"store_name": "泉州市鲤城区",
"store_address": "福建省 泉州市 鲤城区 鲤城区滨江路480号"
}
]
}失败响应示例
{
"success": false,
"code": 402,
"message": "签名错误"
}购买礼品/自提件 更新时间：2022-02-10 17:28:00
基本信息
- 温馨提示： 下面URL的域名为开发时本地测试用，实际使用时须更改为对接网站域名！
- 接口URL：
http://127.0.0.11:8086/apiv2/buy_waybill_no.html - 请求方式：
POST - Content-Type：
application/x-www-form-urlencoded
请求参数
body参数及说明
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| u | 90000 | String | 是 | UID（在"会员中心"→"账号管理"查看） |
| m | 13888888888 | String | 是 | 登录账号 |
| t | 1644483142 | String | 是 | 当前时间戳 |
| sign | a584259da2ff478cf0e477468b4f43b2 | String | 是 | "ApiKey+8b795683fb9485430ce84ceb78cda9786d564150+UID+登录账号+当前时间戳"拼接后进行32位md5加密 （ApiKey在"会员中心"→"账号管理"查看） |
| id | 77-218-526 | String | 是 | 快递ID-仓库ID-礼品ID（礼品ID为0时代表是自提件） |
| repeat | 0 | String | 是 | 是否允许重复下单（1禁止重复下单，0允许重复下单） |
| s_name | 钟先生 | String | 是 | 发件人 - 姓名 |
| s_mobile | 15899996666 | String | 是 | 发件人 - 手机 |
| s_province | 浙江省 | String | 是 | 发件人 - 省 |
| s_city | 杭州市 | String | 是 | 发件人 - 市 |
| s_district | 西湖区 | String | 是 | 发件人 - 区/县 |
| s_address | 健康路88号 | String | 是 | 发件人 - 详细地址 |
| s_zipcode | 258258 | String | 是 | 发件人 - 邮编 |
| receiver_list | [{"pid":1000005,"r_name":"\u9648\u5148\u751f","r_mobile":"18866669999","r_province":"\u5e7f\u4e1c\u7701","r_city":"\u5e7f\u5dde\u5e02","r_district":"\u767d\u4e91\u533a","r_address":"\u592a\u548c\u9547\u5e78\u798f\u8def99\u53f7","r_zipcode":"528000","r_order":"191228-503460987812219"},{"pid":1000006,"r_name":"\u9648\u5148\u751f","r_mobile":"18866669999","r_province":"\u5e7f\u4e1c\u7701","r_city":"\u5e7f\u5dde\u5e02","r_district":"\u767d\u4e91\u533a","r_address":"\u592a\u548c\u9547\u5e78\u798f\u8def99\u53f7","r_zipcode":"528000","r_order":"191228-503460987812219"}] | String | 是 | 收件人列表，json字符串格式，最高支持6000条。pid：唯一PID，获取单号时，通过pid获取对应的快递单号，重复的pid会显示已购买的单号，不会重复扣款，但可能会提示错误；r_name：收件人；r_mobile：手机号码；r_province：省；r_city：市；r_district：区/县；r_address：详细地址；r_zipcode：邮编；r_order：订单号（电商平台的订单号）；oaid：淘宝接口的id号（淘宝密文取单号时必填）；receive_name_jiami：拼多多收货人名字加密字符串（拼多多密文取单号时必填）；receive_mobile_jiami：拼多多收货人电话加密字符串（拼多多密文取单号时必填）；shipping_address_jiami：拼多多收货人街道加密字符串（拼多多密文取单号时必填）；tracking_number：实际发出快递单号（无货源专用必填） |
响应示例
成功响应示例
{
"success": true,
"batch": 1644476623,
"datalist": [
{
"oid": "114934482", //订单编号
"pid": "1000005", //唯一标识
"waybill_no": "9868143371510" //成功返回的快递单号，如果没有立即返回单号可稍后再进行查询
},
{
"oid": "114934483",
"pid": "1000006",
"waybill_no": "9868143016187"
}
],
"message": "下单成功，点击确定进入单号记录查看单号获取情况。"
}失败响应示例
{
"success": false,
"message": "仓库地址参数有误，请选择其他仓库地址（218）"
}查询快递单号 更新时间：2022-02-10 17:28:00
基本信息
- 温馨提示： 下面URL的域名为开发时本地测试用，实际使用时须更改为对接网站域名！
- 接口URL：
http://127.0.0.11:8086/apiv2/get_waybill_no.html - 请求方式：
POST - Content-Type：
application/x-www-form-urlencoded
请求参数
body参数及说明
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| u | 90000 | String | 是 | UID（在"会员中心"→"账号管理"查看） |
| m | 13888888888 | String | 是 | 登录账号 |
| t | 1644483142 | String | 是 | 当前时间戳 |
| sign | a584259da2ff478cf0e477468b4f43b2 | String | 是 | "ApiKey+8b795683fb9485430ce84ceb78cda9786d564150+UID+登录账号+当前时间戳"拼接后进行32位md5加密 （ApiKey在"会员中心"→"账号管理"查看） |
| pid_list | [1000005,1000006] | String | 是 | 通过pid查询快递单号，json字符串格式，最多支持5000条 |
响应示例
成功响应示例
{
"success": true,
"datalist": [
{
"oid": "114934482", //订单编号
"pid": "1000005", //唯一标识
"state": "3", //订单状态 0等待出单号 1已发出 2待截单 3打单中 7准备出单号 11有错误 12封禁 13问题件
"waybill_no": "9868143371510", //成功返回的快递单号
"msg": "" //错误提示
},
{
"oid": "114934483",
"pid": "1000006",
"state": "3",
"waybill_no": "9868144224112",
"msg": ""
}
]
}失败响应示例
{
"success": false,
"code": 402,
"message": "签名错误"
}删除订单并退款 更新时间：2022-02-10 17:28:00
基本信息
- 温馨提示： 下面URL的域名为开发时本地测试用，实际使用时须更改为对接网站域名！
- 接口URL：
http://127.0.0.11:8086/apiv2/del_waybill_no.html - 请求方式：
POST - Content-Type：
application/x-www-form-urlencoded
请求参数
body参数及说明
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| u | 90000 | String | 是 | UID（在"会员中心"→"账号管理"查看） |
| m | 13888888888 | String | 是 | 登录账号 |
| t | 1644483577 | String | 是 | 当前时间戳 |
| sign | 07110eb9eb5a21fe83ba561246813627 | String | 是 | "ApiKey+8b795683fb9485430ce84ceb78cda9786d564150+UID+登录账号+当前时间戳"拼接后进行32位md5加密 （ApiKey在"会员中心"→"账号管理"查看） |
| type | 1 | String | 是 | 传入的ID类型（1、购买时返回的订单编号oid， 2、快递单号） |
| id_list | [114934481,114934487,114934488,114934489] | String | 是 | 要删除的oid或快递单号列表，json字符串格式，最多支持20条 |
响应示例
成功响应示例
{
"success": 3, //删除成功订单数量
"success_waybill_no": [ //删除成功订单列表
{
"oid": "114934487", //订单号
"waybill_no": "" //快递单号
},
{
"oid": "114934488",
"waybill_no": ""
},
{
"oid": "114934489",
"waybill_no": ""
}
],
"fail": 1, //删除失败订单数量
"message": "订单 114934481：正在打印快递单号。" //删除失败原因
}失败响应示例
{
"success": false,
"code": 402,
"message": "签名错误"
}更新取件码 更新时间：2025-02-18 17:28:00
基本信息
- 温馨提示： 下面URL的域名为开发时本地测试用，实际使用时须更改为对接网站域名！
- 接口URL：
http://127.0.0.11:8086/apiv2/update_codes.html - 请求方式：
POST - Content-Type：
application/x-www-form-urlencoded
请求参数
body参数及说明
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| u | 90000 | String | 是 | UID（在"会员中心"→"账号管理"查看） |
| m | 13888888888 | String | 是 | 登录账号 |
| t | 1644483577 | String | 是 | 当前时间戳 |
| sign | 07110eb9eb5a21fe83ba561246813627 | String | 是 | "ApiKey+8b795683fb9485430ce84ceb78cda9786d564150+UID+登录账号+当前时间戳"拼接后进行32位md5加密 （ApiKey在"会员中心"→"账号管理"查看） |
| data | [{"tracking_number":"4320579563215","code":"1234","pickup_address":"广州市天河区天河路1号"}] | String | 是 | 取件码数据列表，JSON字符串格式，每个元素包含tracking_number(原单号)、code(取件码)和pickup_address(取件地址，可选) |
响应示例
成功响应示例
{
"success": true,
"code": 200,
"message": "成功更新 2 条记录",
"data": {
"total": 2, //总数据条数
"success_count": 1, //成功更新数量
"failed_count": 1, //更新失败数量
"failed_items": [ //更新失败的项目
{
"tracking_number": "4320579563215", //原单号
"reason": "未找到匹配的订单或已经更新过该取件码" //失败原因
}
],
"error_items": [ //数据验证失败的项目
{
"index": 2, //数据索引
"reason": "原单号和取件码不能为空", //失败原因
"data": { //原始数据
"tracking_number": "",
"code": "1-2-9012"
}
}
]
}
}失败响应示例
{
"success": false,
"code": 400,
"message": "没有接收到有效的导入数据"
}