电子面单和预分拣接口(淘系专用)
基本信息
接口名称 | TMS_WAYBILLNO_AND_PRESORT |
---|---|
请求方式 | post application/x-www-form-urlencoded |
功能描述 | 淘系商家调用该接口获取运单号及预分拣信息 |
编码 | UTF-8 |
入参
项目 | 名称 | 类型 | 必填 | 描述 |
---|---|---|---|---|
对接码 | logistic_provider_id | String | 是 | 菜鸟侧提供 |
签名 | data_digest | String | 是 | Base64(Md5(logistics_interface+双方约定的secretKey)),0.2 签名方法 |
业务报文 | logistics_interface | String | 是 | JSON |
logistics_interface内容
项目 | 名称 | 类型 | 必填 | 描述 |
---|---|---|---|---|
仓储订单号LBX | storeOrderCode | String | 是 | |
是否获取预分拣 | getPreSort | Boolean | 是 | |
是否获取电子面单 | getWaybillNo | Boolean | 是 | |
电子面单补充参数 | getWaybillNoParam | GetWaybillNoParam | 否 | getWaybillNo为true时必填 |
扩展字段 | extendFields | List<ExtendField> | 否 | privacy-隐私面单标,1为隐私面单 taobaoTradeId-淘宝订单号 changeDelivery-换配标,换配场景传1 upDeliveryCpCode 配送资源编码 |
GetWaybillNoParam内容
项目 | 名称 | 类型 | 必填 | 描述 |
---|---|---|---|---|
包裹信息 | packageInfos | List<PackageInfo> | 否 | |
发件人信息 | sender | UserInfo | 否 | getWaybillNo为true时必填 |
扩展信息 | extendFields | List<ExtendField> | 否 |
PackageInfo内容
项目 | 名称 | 类型 | 必填 | 描述 |
---|---|---|---|---|
详细地址 | detail | String | 否 | getWaybillNo为true时必填 |
请求id | objectId | String | 否 | getWaybillNo为true时必填 |
商品列表 | items | List<Item> | ||
扩展信息 | extendFields | List<ExtendField> |
Item内容
项目 | 名称 | 类型 | 必填 | 描述 |
---|---|---|---|---|
扩展信息 | extendFields | List<ExtendField> | ||
名称 | name | String | getWaybillNo为true时必填 | |
数量 | count | Integer | getWaybillNo为true时必填 |
UserInfo内容
项目 | 名称 | 类型 | 必填 | 描述 |
---|---|---|---|---|
姓名 | name | String | 否 | getWaybillNo为true时必填 |
手机 | mobile | String | 否 | 电话手机二选一 |
电话 | phone | String | 否 | 电话手机二选一 |
省 | province | String | 否 | getWaybillNo为true时必填 |
市 | city | String | 否 | |
区 | district | String | 否 | |
街道 | town | String | 否 | |
详细地址 | detail | String | 否 | getWaybillNo为true时必填 |
ExtendField内容
项目 | 名称 | 类型 |
---|---|---|
键 | key | String |
值 | value | String |
出参
项目 | 名称 | 类型 | 必填 |
---|---|---|---|
成功标识 | success | boolean | 是 |
错误码 | errorCode | String | 否 |
错误说明 | errorMsg | String | 否 |
仓储订单号 | storeOrderCode | String | |
电子面单号列表 | waybillNoInfoList | List<WaybillNoInfo> | |
预分拣信息 | PreSortInfo | PreSortInfo | |
扩展信息 | extendFields | List<ExtendField |
WaybillNoInfo信息
项目 | 名称 | 类型 |
---|---|---|
请求id | objectId | String |
面单号 | waybillNo | String |
扩展信息 | extendFields | List<ExtendField> |
PreSortInfo信息
项目 | 名称 | 类型 | 必填 | 描述 |
---|---|---|---|---|
预分拣类型 | preSortType | String | 0城市1站点 | |
Cp简码 | cpShortCode | String | ||
城市简码 | cityShortCode | String | ||
站点简码 | siteShortCode | String | ||
分拨路径 | routePath | String | ||
站点id | siteId | Long | ||
城市id | cityAreaId | Long | ||
站点编号 | siteCode | String | ||
承运商编号 | carrierCode | String | ||
预分拣坐标 | preSortCoordinate | String | ||
子区域编码 | siteAreaId | Long | ||
子区域编号 | siteAreaCode | String | ||
小区名称 | aoiCommunityName | String | ||
签收顺序标识 | deliveryOrder | String | ||
始发分拨简码 | firstRdcShortName | String | ||
目的分拨简码 | endRdcShortName | String | ||
始发分拨滑道号 | firstChuteShortName | String | ||
目的分拨滑道号 | endChuteShortName | String | ||
扩展信息 | extendFields | List<ExtendField> | privacyMobile-隐私小号 firstRdcShortDesc-始发分拨简称 endRdcShortDesc-末分拨简称 siteName-站点名称 |
示例报文
URL:
http://edi-daily.xpm.cainiao.com/ext/gateway/ediStandardWaybillAndSort/ediStandardWaybillAndSort/api
请求: 仅供参考,实际测试账号需联系菜鸟速递开发提供
logistic_provider_id: edi_test_json
logistics_interface:
{
"getPreSort": true,
"getWaybillNo": true,
"getWaybillNoParam": {
"packageInfos": [{
"items": [{
"count": 1,
"name": "衣服"
}],
"objectId": "1"
}],
"sender": {
"city": "杭州市",
"detail": "西溪首座",
"district": "西湖区",
"mobile": "138888888888",
"name": "张三",
"phone": "0571-88888888",
"province": "浙江省",
"town": "蒋村街道"
}
},
"storeOrderCode": "LBX032749145237499"
}
data_digest: CXH31svNPo1QTf5RCeJHRQ==
返回:
{
"PreSortInfo": {
"carrierCode": "zqtest3",
"cityAreaId": 150100,
"cityShortCode": "51",
"cpShortCode": "wx",
"preSortCoordinate": "111.578066,39.787661",
"preSortType": "1",
"routePath": "4阡陌联调公共分拨004-3阡陌联调公共分拨003-阡陌联调站点1",
"siteCode": "qmltzd1",
"siteId": 2331254,
"siteShortCode": "qmltzd1"
},
"storeOrderCode": "LBX032749145237499",
"waybillNoInfoList": [{
"objectId": "1",
"waybillNo": "604000015704694"
}],
"success": true
}