获取电子面单(2合1)
说明: 权限对应: ISV、POP后台推送运单接口
一、请求参数
请求URL:
公共参数
| 参数名称 | 参数类型 | 是否必须 | 示例值 | 参数描述 |
|---|---|---|---|---|
| appid | String | 是 | 合作伙伴AppId | |
| timestamp | String | 是 | 1657525936 | 当前Unix时间戳,秒 |
| seller_nick | String | 是 | 38173182 | 京东的账号,对应蜂巢授权返回jdseller字段 |
| sign | String | 是 | ||
| sysid | 可选 | 应用标识,不清楚请咨询客服 |
业务参数
| 名称 | 类型 | 必须 | 示例值 | 描述 |
|---|---|---|---|---|
| - request_data | String | 否 | 参考接口文档 | 报文内容,注意是一个集合,每个对象是content类型, 最多一次取号100个. |
content的各字段含义参见: https://cloud.jdl.com/#/open-business-document/api-doc/207/464,
request_data的报文示例,注意是一个集合:
1、 明文订单取号的示例
[{ "waybillType":1, "waybillCount":1, "providerCode":"SF", "platformOrderNo":"25xxxx29", "vendorCode":"2xx81", "vendorName":"x旗舰店", "vendorOrderCode":"9999", "salePlatform":"0010001", "childMotherOrder":true, "fromAddress":{ "provinceName":"上海", "cityName":"上海市", "countrysideName":"浦东新区", "address":"xxxxxx", "contact":"王小姐", "phone":"13601812022", "mobile":"13601812022" }, "toAddress":{ "provinceId":12, "provinceName":"XXX", "cityId":232, "cityName":"YYY", "countryId":1232, "countryName":"ZZZ", "countrysideId":10098, "countrysideName":"CCC", "address":"北京市海淀区XXX小区", "contact":"李小溪", "phone":"010-19999999", "mobile":"189xx28" }, "weight":0, "volume":0, "payType":0, "shouldPayMoney":0, "needGuarantee":false, "settlementCode":"0210603333", "expressPayMethod":"1", "expressType":"1", "promiseTimeType":0, "guaranteeMoney":0, "objectId":"obj1000"}]取号入参数字段中,几个核心字段说明
| **序号** | **字段名称** | 字段类型 | **字段描述** | **是否必须** | **示例值** | **注意事项** |
|---|---|---|---|---|---|---|
| 1 | salePlatform | String | 销售平台 | 是 | 0010001代表京东平台下的订单 0010002天猫、t&b订单 0030001 其他平台订单 | **京东平台必须传0010001,否则可能影响业务履约** |
| 2 | platformOrderNo | String | 平台订单号,即pop订单号,如果多订单合并发货, 每个订单号之间用“,”逗号分隔,每个订单号最多32位 | 是 | 20000000100 非京东平台填所对应平台的订单号 | **京东平台必须传平台原始订单号,否则可能影响业务履约** |
| 3 | mobile | String | 收货人手机号 | 是 | 1. 13100000001(真实手机号); 2.70位密文(POP订单desen_mobile脱敏字段);3. 13141245588-1234(虚拟号) | **支持传输70位密文或虚拟号; 如果是11-4虚拟号,需传输完整11-4虚拟号** |
2、 使用OAID取号
京东于2024年06月新增oaid字段,用于保护收件人隐私(隐掉收件人详细地址,手机号等密文),统一用密文oaid代替,类似淘宝的oaid。可在增强型订单列表中找到对应订单oaid字段的值。下面是使用oaid取号示例。
[ { "branchCode": "571165", "fromAddress": { "address": "浙江杭州市xxxxxx", "cityName": "杭州市", "contact": "李先生", "countryName": "萧山区", "mobile": "1852xxxxxx", "phone": "1852xxxxxx", "provinceName": "浙江省" }, "guaranteeMoney": 0, "needGuarantee": false, "payType": 0, "platformOrderNo": "298xxxxxx39", "promiseTimeType": 0, "providerCode": "ZTO", "salePlatform": "0010001", "shouldPayMoney": 0, "templateUrl": "https://template-content.jd.com/template-content?type=standards&id=10000101", "toAddress": { "address": "山东威海市环翠区怡园街道新的*",// 订单中返回的脱敏收件人详细地址 "cityName": "威海市", "contact": "付**", // 订单中返回的脱敏收件人姓名 "countryName": "环翠区", "mobile": "177*******6",// 订单中返回的脱敏收件人手机号 "phone": "177*******6",// 订单中返回的脱敏收件人电话 "provinceName": "山东", "oaid": "YmQxxxxxxTxxxxxxIdf7xxxxxx==" }, "vendorCode": "151xxxxxx8", "vendorName": "xxxxxx店铺", "vendorOrderCode": "18xxxxxx65154", "volume": 0, "waybillCount": 1, "waybillType": 1, "weight": 0, "objectId":"obj1000" }]顺丰取号的重点参数说明
| 名称 | 类型 | 必须 | 示例值 | 描述 |
|---|---|---|---|---|
| - salePlatform | String | 否 | 销售平台;0010001代表京东平台下的订单 |
expressPayMethod: //快递费付款方式(顺丰必填),1:寄方付 2:收方付 3:第三方付 expressType : // 快件产品类别(顺丰 必填), 快件产品类别,目前顺丰使用,后续可根据承运商自己定义 。1-顺丰标快;2-顺丰特惠
platformOrderNo: 平台订单号,指京东侧的订单号,如255919279479 vendorOrderCode: 商家订单号指商家自己定义的订单号.
二、请求示例代码
Java
请求示例代码
@Test public void wayBillReceive() throws Exception {
String sellerNick = Config.JDSellerNick ; //业务参数 Map<String, String> data = new HashMap<String, String>(); data.put("appid", Config.AppId); data.put("seller_nick", sellerNick); Long timestamp = System.currentTimeMillis() / 1000; data.put("timestamp", timestamp.toString()); String content ="[" + " {" + " \"branchCode\": \"xxxxxx5\"," + " \"fromAddress\": {" + " \"address\": \"浙江杭州xxxxxx8号\"," + " \"cityName\": \"杭州市\"," + " \"contact\": \"李先生\"," + " \"countryName\": \"萧山区\"," + " \"mobile\": \"185xxxxxx2\"," + " \"phone\": \"185xxxxxx322\"," + " \"provinceName\": \"浙江省\"" + " }," + " \"guaranteeMoney\": 0," + " \"needGuarantee\": false," + " \"payType\": 0," + " \"platformOrderNo\": \"298146510339\"," + " \"promiseTimeType\": 0," + " \"providerCode\": \"ZTO\"," + " \"salePlatform\": \"0010001\"," + " \"shouldPayMoney\": 0," + " \"templateUrl\": \"https://template-content.jd.com/template-content?type=standards&id=10000101\"," + " \"toAddress\": {" + " \"address\": \"山东威海市环翠区怡园街道新的*\",// 订单中返回的脱敏收件人详细地址" + " \"cityName\": \"威海市\"," + " \"contact\": \"付**\", // 订单中返回的脱敏收件人姓名" + " \"countryName\": \"环翠区\"," + " \"mobile\": \"177*******6\",// 订单中返回的脱敏收件人手机号" + " \"phone\": \"177*******6\",// 订单中返回的脱敏收件人电话" + " \"provinceName\": \"山东\"," + " \"oaid\": \"YmQ4MDU2ABTxxxxxxxxxxxxg==\"" + " }," + " \"vendorCode\": \"151xxxxxx8\"," + " \"vendorName\": \"薇薇店铺\"," + " \"vendorOrderCode\": \"181xxxxxx154\"," + " \"volume\": 0," + " \"waybillCount\": 1," + " \"waybillType\": 1," + " \"weight\": 0" + " }" + "]"; data.put("request_data", content); data.put("sign", Utils.Sign(data, Config.AppSecret)); doHttpRequest(Config.JDwayBillReceive, data); }三、返回结果
返回结果
{ "code": 0, "message": "ok", "data": [ { "code": 0, "msg": "", "packageCode": "", "perPrintData": "QMNwNAcTB3TJQ==", "wayBillNo": "428177014xxxx", "objectId": "obj10001", "orderSn": "3271224xxx" } ], "trace_id": "ecd0de43-90d4-4e1b-8426-9da4bb5aef2f"}业务成功与否参见内层code为0表示成功, 同时返回对应的订单号.
四、说明
4.1 电子面单解绑 如果订单信息,如收件人信息地址改动、修改承运商等,需要调用电子面单解绑接口,然后重新获取单号及大头笔信息 (解绑的运单就作废了,不能再次使用,如果没有解绑,用同样的订单信息,二次获取返回的还是之前的,不会重新生成) 由于顺丰快递一个订单号只允许获取一个运单号,顺丰快递暂不支持解绑 如果解绑顺丰快递时,系统返回“您的订单已绑定一个运单号,顺丰快递暂不支持解除绑定!”
4.2 关于拆单发货 下单接口,平台订单号platformOrderNo相同,商家自有订单号vendorOrderCode不同,也支持获取不同的三方运单号 1.7.1使用拆单功能场景 补发货的情况,同一平台订单,在第一个包裹已经打单发货后,可以使用不同商家自有订单号vendorOrderCode再获取运单号; 多库房发货未知包裹数,需要使用不同的商家自有订单号vendorOrderCode,可以分多次获取运单号;
4.3 关于直营型快递取号 直营型快递会有月结结算编码,相关入参看此文档 https://jos.jd.com/commondoc?listId=335 第2.3.2入参说明
4.4 错误提示:该11位号码为京东虚拟号主号 界电子面单下单接口(jingdong.ldop.alpha.waybill.receive)报错:该11位号码为京东虚拟号主号,请使用完整11-4虚拟号下单。 解答:消费者在APP下单时把虚拟号写到收货人手机号里了,请联系客户修改手机号。
4.5 京东快递产品清单
| 产品名称 | 产品编码 | 支持的下单来源(orderOrigin) |
|---|---|---|
| 京东标快 | ed-m-0001 | 0-C2C;1-B2C;2-C2B |
| 京东特快 | ed-m-0002 | 0-C2C;1-B2C;2-C2B |
| 生鲜标快 | LL-HD-M | 0-C2C;1-B2C |
| 生鲜特快 | LL-SD-M | 0-C2C;1-B2C |
| 函速达 | ed-m-0017 | 1-B2C |
| 特惠包裹 | ed-m-0012 | 1-B2C |
| 电商特惠 | ed-m-0059 | 1-B2C |
| 特惠小件 | ed-m-0019 | 1-B2C |
| 特快零担 | fr-m-0001 | 4-kyb2c;5-kyc2c |
| 特惠零担 | fr-m-0002 | 4-kyb2c |
| 特快重货 | fr-m-0004 | 4-kyb2c;5-kyc2c |
| 快运零担 | fr-m-0006 | 4-kyb2c |
| 特惠专配 | fr-m-0017 | 4-kyb2c |
| 智能分单 | ed-m-00000 | 1-B2C;4-kyb2c |