全部
电子面单
物流轨迹
物流发货
在线测试
电子面单 HTML
接口地址: http://api.vv-tool.com/tool/erps/kd-html-electronic-sheet
接口介绍: 通过快递公司或网点、菜鸟与淘宝提供的电子面单账号,提交生成电子面单号,返回固定面单模板,调用本地打印机即可打印出电子面单。
请求方式: POST
返回格式: JSON
接口收费: 联系客服
频率限制: 10 次/秒
请求头参数
参数 | 类型 | 必选 | 值 | 示例 |
---|---|---|---|---|
Authorization | string | 是 | 授权 access_token | Bearer 1798c6aadec33d1bc2f5b707f1049aefexxxx |
请使用新的生成 token 接口 点击查看详情
请求参数
参数 | 类型 | 必选 | 描述 |
---|---|---|---|
partnerId | string | 是 | 电子面单客户账户或月结账号,需贵司向当地快递公司网点申请(参考电子面单申请指南); 是否必填该属性,请查看参数字典 |
partnerKey | string | 否 | 电子面单密码,需贵司向当地快递公司网点申请; 是否必填该属性,其他请查看参数字典 |
partnerSecret | string | 否 | 电子面单密钥,需贵司向当地快递公司网点申请; 是否必填该属性,请查看参数字典 |
partnerName | string | 否 | 电子面单客户账户名称,需贵司向当地快递公司网点申请; 是否必填该属性,请查看参数字典 |
net | string | 否 | 收件网点名称,由快递公司当地网点分配,若使用淘宝授权填入(taobao),使用菜鸟授权填入(cainiao), 使用京东授权填入(jdalpha),使用拼多多授权填入(pinduoduoWx)。是否必填该属性,请查看参数字典(若通过第三方授权方式获取单号 partnerId,partnerKey 参数为必填,参数值可通过第三方授权接口获取) |
code | string | 否 | 电子面单承载编号,需贵司向当地快递公司网点申请; 是否必填该属性,请查看参数字典 |
checkMan | string | 否 | 电子面单承载快递员名,需贵司向当地快递公司网点申请; 是否必填该属性,请查看参数字典 |
tbNet | string | 否 | 在使用菜鸟/淘宝/拼多多授权电子面单时,若月结账号下存在多个网点,则 tbNet="网点名称,网点编号" ,注意此处为英文逗号 |
kuaidicom | string | 是 | 快递公司的编码,一律用小写字母,见参数字典 |
recMan | object | 是 | 收件人信息 |
--name | string | 是 | 收件人姓名 |
--mobile | string | 是 | 收件人的手机号,手机号和电话号二者其一必填 |
--printAddr | string | 是 | 收件人所在完整地址,如广东深圳市深圳市南山区科技南十二路 2 号金蝶软件园 B10 |
--company | string | 否 | 收件人所在公司名称 |
sendMan | object | 是 | 寄件人信息 |
--name | string | 是 | 寄件人姓名 |
--mobile | string | 是 | 寄件人的手机号,手机号和电话号二者其一必填 |
--printAddr | string | 是 | 寄件人所在的完整地址,如广东深圳市深圳市南山区科技南十二路 2 号金蝶软件园 B10 |
--company | string | 否 | 寄件人所在公司名称 |
cargo | string | 否 | 物品名称,例:文件 |
count | string | 是 | 物品总数量 另外该属性与子单有关,如果需要子单(指同一个订单打印出多张电子面单,即同一个订单返回多个面单号),needChild = 1、count 需要大于 1,如 count = 2 则一个主单 一个子单,count = 3 则一个主单 二个子单;返回的子单号码见返回结果的 childNum 字段 |
weight | string | 否 | 物品总重量 KG,例:1.5,单位 kg 极兔速递必填,其他快递公司非必填 |
payType | string | 否 | 支付方式: SHIPPER:寄方付(默认) CONSIGNEE:到付 MONTHLY:月结 THIRDPARTY:第三方支付 (详细请参考参数字典) |
expType | string | 否 | 产品类型: 标准快递(默认) 顺丰标快(陆运) EMS 经济 (详细请参考参数字典) |
remark | string | 否 | 备注 |
valinsPay | string | 否 | 保价额度 |
collection | string | 否 | 代收货款额度 |
needChild | string | 否 | 是否需要子单: 1:需要 0:不需要(默认) 如果需要子单(指同一个订单打印出多张电子面单,即同一个订单返回多个面单号); needChild = 1、count 需要大于 1,如 count = 2 一个主单 一个子单,count = 3 一个主单 二个子单,返回的子单号码见返回结果的 childNum 字段 |
needBack | string | 否 | 是否需要回单: 1:需要 0:不需要(默认) 返回的回单号见返回结果的 returnNum 字段 |
orderId | string | 否 | 贵司内部自定义的订单编号,需要保证唯一性,非必填 |
needTemplate | string | 否 | 是否返回面单: 0:不需要(默认) 1:需要 如果需要,则返回要打印的模版的 HTML 代码,贵司可以直接将之显示到 IE 等浏览器,然后通过浏览器进行打印 |
salt | string | 否 | 签名用随机字符串 |
op | string | 否 | 是否开启订阅功能: 0:不开启(默认) 1:开启 说明开启订阅功能时:pollCallBackUrl 必须填入此功能只针对有快递单号的单 |
pollCallBackUrl | string | 否 | 如果 op 设置为 1 时,pollCallBackUrl 必须填入,用于跟踪回调 |
resultv2 | string | 否 | 添加此字段表示开通行政区域解析或地图轨迹功能 。 0:关闭(默认) 1:开通行政区域解析功能(详见:快递信息推送接口文档-2.3 推送输入参数), 3:开通地图轨迹及时效返回(回调报文参考地图轨迹推送服务技术文档-推送接口) |
请求示例
{
"partnerId": "******",
"partnerKey": "",
"net": "",
"kuaidicom": "ems",
"recMan": {
"name": "张三",
"mobile": "13751866787",
"printAddr": "广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10",
"company": ""
},
"sendMan": {
"name": "李四",
"mobile": "13751866787",
"printAddr": "广东深圳市深圳市南山区科技南十二路2号金蝶软件园",
"company": ""
},
"cargo": "发票",
"count": "1",
"weight": "0.5",
"payType": "SHIPPER",
"expType": "标准快递",
"remark": "",
"valinsPay": "",
"collection": "",
"needChild": "0",
"needBack": "0",
"orderId": "2147895476",
"needTemplate": "1",
"salt": "",
"op": "0",
"pollCallBackUrl": "",
"resultv2": "0"
}
请求代码示例
cURL请求代码示例
PHP请求代码示例
JAVA请求代码示例
响应参数
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | int | 返回状态码 | |
msg | string | 返回码描述 | |
msec | int | 接口执行时间 | |
time | int | 接口返回时间 | |
data | object | 数据信息 | |
--result | boolean | 提交结果 true 提交成功,false 失败 | |
--status | string | 返回编码 | |
--message | string | 返回报文描述 | |
--data | data | JSON | |
--taskId | string | 任务 ID | |
--kuaidinum | string | 快递单号 | |
--returnNum | string | 回单号 | |
--childNum | string | 子单号,如果有多个,逗号分隔 如果需要子单 则需要提交报文 needChild = 1、count 需要大于 1。 如 count = 2 则一个主单、一个子单,count=3 则一个主单、二个子单 | |
--bulkpen | string | 大头笔 用于显示于电子面单上规定位置,非必需,是否有值取决于快递公司 | |
--orgCode | string | 始发地区域编码 | |
--orgName | string | 始发地/始发网点名称 | |
--destCode | string | 目的地区域编码 | |
--destName | string | 目的地/到达网点 | |
--orgSortingCode | string | 始发分拣编码 | |
--orgSortingName | string | 始发分拣名称 | |
--destSortingCode | string | 目的分栋编码 | |
--destSortingName | string | 目的分栋中心名称 | |
--orgExtra | string | 始发其他信息 | |
--destExtra | string | 目的其他信息 | |
--pkgCode | string | 集包编码 | |
--pkgName | string | 集包地名称 | |
--road | string | 路区 | |
--qrCode | string | 二维码 | |
--orderNum | string | 快递公司订单号 | |
--expressCode | string | 快递业务类型编码 | |
--expressName | string | 快递业务类型名称 | |
--templateurl | string | 在线显示电子面单模版的网址 用浏览器打开该网址,就能看到生成的电子面单,直接通过浏览器的打印功能即可完成打印 | |
--template | string | 电子面单模板内容 | |
--withholding_money | int | 该接口扣费金额(点券) |
返回数据
{
"code": 0,
"mag": "",
"msec": "",
"time": 1656564848,
"data": [
{
"kuaidinum": "606568155331",
"returnNum": "",
"childNum": "",
"bulkpen": "大头笔",
"orgCode": "755",
"orgName": "始发地区域编码",
"destCode": "755",
"destName": "目的地/到达网点",
"orgSortingCode": "始发分拣编码",
"orgSortingName": "始发分拣名称",
"destSortingCode": "目的分栋编码",
"destSortingName": "目的分栋中心名称",
"orgExtra": "始发其他信息",
"destExtra": "目的其他信息",
"pkgCode": "集包编码",
"pkgName": "集包地名称",
"road": "路区",
"qrCode": "二维码",
"orderNum": "快递公司订单号",
"expressCode": "快递业务类型编码",
"expressName": "标准快递"
}
]
}
响应代码
代码 | 代码描述 | 解决方案 |
---|---|---|
0 | 成功 | |
100 | 请求参数错误 | 检查您的请求参数是否正确 |
101 | 请求超时,请重试 | 检查您的网络情况或者联系客服解决 |
103 | 旺旺账号不存在 | 检查您输入的旺旺号是否正确 |
200 | 系统错误,请联系客服 | 检查您的接口地址填写是否正确,其他问题联系客服解决 |
203 | 暂不支持当前接口 | |
204 | 请求异常:无该接口权限,请前往官网开通正式接口。 | 前往官网开通该接口权限 |
204 | 请求异常:API 调用次数不足,请前往网站兑换次数。 | 前往官网充值该接口调用次数 |
302 | 未授权店铺 | 根据返回链接进行扫码授权 |