全部
电子面单
物流轨迹
物流发货
在线测试
淘宝电子面单打印
接口地址: http://api.vv-tool.com/tool/accounts/tb-print-electronic-sheet
接口介绍: 淘宝电子面单打印
请求方式: POST
返回格式: JSON
接口收费: 联系客服
频率限制: 10 次/秒
请求头参数
参数 | 类型 | 必选 | 值 | 示例 |
---|---|---|---|---|
Authorization | string | 是 | 授权 access_token | Bearer 1798c6aadec33d1bc2f5b707f1049aefexxxx |
请使用新的生成 token 接口 点击查看详情
请求参数
参数 | 类型 | 必选 | 描述 |
---|---|---|---|
data | object | 是 | 数据 |
--param_waybill_cloud_print_apply_new_request | WaybillCloudPrintApplyNewRequest | 是 | 入参信息 |
----cp_code | String | 是 | 物流公司 Code,长度小于 20 |
----product_code | String | 否 | 目前仅顺丰支持此字段,传入快递产品编码 |
----sender | UserInfoDto | 是 | 发货人信息 |
------address | AddressDto | 是 | 发货地址需要通过 search 接口 |
--------city | String | 否 | 城市,长度小于 20 |
--------detail | String | 是 | 详细地址,长度小于 256 |
--------district | String | 否 | 区,长度小于 20 |
--------province | String | 是 | 省,长度小于 20 |
--------town | String | 否 | 街道,长度小于 30 |
------mobile | String | 否 | 手机号码(手机号和固定电话不能同时为空),长度小于 20 |
------name | String | 是 | 姓名,长度小于 40 |
------phone | String | 否 | 固定电话(手机号和固定电话不能同时为空),长度小于 20 |
----trade_order_info_dtos | TradeOrderInfoDto[] | 是 | 请求面单信息,数量限制为 10 |
------logistics_services | String | 否 | 物流服务值(详见https://support-cnkuaidi.taobao.com/doc.htm#?docId=106156&docType=1,如无特殊服务请置空) |
------object_id | String | 是 | 请求 ID |
------order_info | OrderInfoDto | 是 | 订单信息 |
------order_channels_type | String | 是 | 订单渠道平台编码 |
--------trade_order_list | String[] | 是 | 订单号,数量限制 100,订单号(只限传入数字、字母、下划线和中划线,为避免出现冲突,请按电商平台真实订单号传入,请避免使用同个订单号重复取号) |
--------out_trade_order_list | String[] | 否 | 外部电商平台交易单号集合,非必填,数量限制 100 |
--------out_trade_sub_order_list | String[] | 否 | 外部电商平台交易子单号集合,非必填,数量限制 100 |
------package_info | PackageInfoDto | 是 | 包裹信息 |
--------id | String | 否 | 包裹 id,用于拆合单场景(只能传入数字、字母和下划线;批量请求时值不得重复,大小写敏感,即 123A,123a 不可当做不同 ID,否则存在一定可能取号失败) |
--------items | Item[] | 是 | 商品信息,数量限制为 100 |
----------count | Number | 是 | 数量 |
----------name | String | 是 | 名称 |
--------volume | Number | 否 | 体积, 单位 ml |
--------weight | Number | 否 | 重量,单位 g |
--------total_packages_count | Number | 否 | 子母件模式中的总包裹数/总件数,用于打印当前包裹处于总件数的位置比如 5-2,可以表示总包裹数为 5,当前为第 2 个包裹,只有快运公司需要传入,其他的可以不用传入 |
--------packaging_description | String | 否 | 大件快运中的包装方式描述 |
--------goods_description | String | 否 | 大件快运中的货品描述,比如服装,家具。 顺丰取号必须传此参数 |
--------length | Number | 否 | 包裹长,单位厘米 |
--------width | Number | 否 | 包裹宽,单位厘米 |
--------height | Number | 否 | 包裹高,单位厘米 |
--------good_value | String | 否 | 物品价值,单位元 |
------recipient | RecipientInfoDto | 是 | 收件人信息 |
--------address | AddressDto | 是 | 地址 |
----------city | String | 否 | 城市 |
----------detail | String | 是 | 详细地址 |
----------district | String | 否 | 区 |
----------province | String | 是 | 省 |
----------town | String | 否 | 街道 |
--------mobile | String | 否 | 手机号码 |
--------name | String | 是 | 姓名 |
--------phone | String | 否 | 固定电话 |
--------oaid | String | 否 | 淘宝订单收件人 ID (Open Addressee ID),长度不超过 128 个字符,淘宝订单加密情况用于解密。 |
--------tid | String | 否 | 电商平台真实交易订单号,针对电商平台订单隐私加密场景使用,非必填,如果填写则必须是电商平台真实的交易订单 ID |
--------caid | String | 否 | 菜鸟解密地址 ID,用于电商平台收件人信息加密的场景使用,非订单加密场景请勿使用。 |
------template_url | String | 是 | 云打印标准模板 URL(组装云打印结果使用,值格式http://cloudprint.cainiao.com/template/standard/${模板 ID}) |
------user_id | Number | 是 | 使用者 ID(使用电子面单账号的实际商家 ID,如存在一个电子面单账号多个店铺使用时,请传入店铺的商家 ID) |
------waybill_code | String | 否 | 带面单号模式取号,目前仅顺丰支持 |
------store_code | String | 否 | 仓 code, 仓库 WMS 系统对接落地配业务,其它场景请不要使用 |
----resource_code | String | 否 | 配送资源 code, 仓库 WMS 系统对接落地配业务,其它场景请不要使用 |
----dms_sorting | Boolean | 否 | 是否使用智分宝预分拣, 仓库 WMS 系统对接落地配业务,其它场景请不要使用 |
----three_pl_timing | Boolean | 否 | 订单上是否带 3PLtiming 属性, 该属性需要严格与订单上属性保持一致,如果不确定,请使用默认 false。 |
----need_encrypt | Boolean | 否 | 设定取号返回的云打印报文是否加密 |
----multi_packages_shipment | Boolean | 否 | 快递公司支持一票多件,快运公司子母件请勿使用该参数 |
----brand_code | String | 否 | 品牌编码 |
----extra_info | String | 否 | 扩展参数 |
----customer_code | String | 否 | 月结卡号 |
----call_door_pick_up | Boolean | 否 | 是否预约上门 |
----door_pick_up_time | String | 否 | 预约上门收件时间 |
----door_pick_up_end_time | String | 否 | 预约上门截止时间 |
----shipping_branch_code | String | 否 | 寄件网点编码 |
请求示例
请求代码示例
cURL请求代码示例
PHP请求代码示例
JAVA请求代码示例
响应参数
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | int | 返回状态码 | |
msg | string | 返回码描述 | |
msec | int | 接口执行时间 | |
time | int | 接口返回时间 | |
data | object | 数据信息 | |
--waybill_cloud_print_response | WaybillCloudPrintResponse [] | 系统自动生成 | |
----object_id | String | 请求 id | |
----waybill_code | String | 面单号, 子母件模式下为子面单号 | |
----print_data | String | 云打印内容(encryptedData 表示加密结果,data 表示非加密结果);模板内容,具体解释见链接 | |
----parent_waybill_code | String | 子母件中的母单号,当为子母件模式时,需要此单号为实际挂载物流详情的单号,需要使用此单号进行发货,查询物流详情,非子母件,此字段为空 | |
----extra_info | String | 拓展信息,特殊场景下使用 | |
----cp_code | String | cp_code,跟入参传入的 cp_code 保持一致 | |
----real_cp_code | String | 真实取号的 cp_code,在淘特官方物流等虚拟 cp 的场景中 real_cp_code 和入参中的 cp_code 不一样,其他场景二者一样 | |
--withholding_money | int | 该接口扣费金额(点券) |
返回数据
{
"code": 0,
"mag": "",
"msec": "",
"time": 1656564848,
"data": {
"waybill_cloud_print_response":[
{
"object_id":"12",
"waybill_code":"9890000160004",
"print_data":"{\\\"data\\\":{\\\"recipient\\\":{\\\"address\\\":{\\\"city\\\":\\\"北京市\\\",\\\"detail\\\":\\\"花家地社区卫生服务站\\\",\\\"district\\\":\\\"朝阳区\\\",\\\"province\\\":\\\"北京\\\",\\\"town\\\":\\\"望京街道\\\"},\\\"mobile\\\":\\\"1326443654\\\",\\\"name\\\":\\\"Bar\\\",\\\"phone\\\":\\\"057123222\\\"},\\\"routingInfo\\\":{\\\"consolidation\\\":{},\\\"origin\\\":{\\\"code\\\":\\\"POSTB\\\"},\\\"sortation\\\":{\\\"name\\\":\\\"杭州\\\"}},\\\"dmsSortingInfo\\\": {\\\"siteAreaCode\\\": \\\"A2\\\"},\\\"sender\\\":{\\\"address\\\":{\\\"city\\\":\\\"北京市\\\",\\\"detail\\\":\\\"花家地社区卫生服务站\\\",\\\"district\\\":\\\"朝阳区\\\",\\\"province\\\":\\\"北京\\\",\\\"town\\\":\\\"望京街道\\\"},\\\"mobile\\\":\\\"1326443654\\\",\\\"name\\\":\\\"Bar\\\",\\\"phone\\\":\\\"057123222\\\"},\\\"shippingOption\\\":{\\\"code\\\":\\\"COD\\\",\\\"services\\\":{\\\"SVC-COD\\\":{\\\"value\\\":\\\"200\\\"}},\\\"title\\\":\\\"代收货款\\\"},\\\"waybillCode\\\":\\\"9890000160004\\\"},\\\"signature\\\":\\\"RSA:hqUkugCY2FFXJK10fRcUE0TsvDppxXuBdOEnPVntF3u4H2yaYiPsPXqjdI1C5oXs60vVCfqd8YC6vZx57TnN9\/u0VYM\/TiFmMtxix9ouPQ2p7G64UyX9BrnRQQCp5ETqJogSzIpxVlz5rx3hy19C+VQrqWgQEw5JqOkoBFXhMi8\\u003d\\\",\\\"templateURL\\\":\\\"http:\/\/cloudprint.cainiao.com\/cloudprint\/template\/getStandardTemplate.json?template_id\\u003d1001\\\"}",
"parent_waybill_code":"9890000160004",
"extra_info":"{\"remark\": \"\"}",
"cp_code":"STO",
"real_cp_code":"STO"
}
]
}
}
响应代码
代码 | 代码描述 | 解决方案 |
---|---|---|
0 | 成功 | |
100 | 请求参数错误 | 检查您的请求参数是否正确 |
101 | 请求超时,请重试 | 检查您的网络情况或者联系客服解决 |
103 | 旺旺账号不存在 | 检查您输入的旺旺号是否正确 |
200 | 系统错误,请联系客服 | 检查您的接口地址填写是否正确,其他问题联系客服解决 |
203 | 暂不支持当前接口 | |
204 | 请求异常:无该接口权限,请前往官网开通正式接口。 | 前往官网开通该接口权限 |
204 | 请求异常:API 调用次数不足,请前往网站兑换次数。 | 前往官网充值该接口调用次数 |
302 | 未授权店铺 | 根据返回链接进行扫码授权 |