快递公司接入快递100电子面单接口技术文档
一、下订单接口
TMS_WAYBILL_DETAIL_SEND
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
msg_type | String | true | 消 息 类 型 : TMS_WAYBILL_DETAIL_SEND |
partner_code | String | true | 合作伙伴编码 |
data_digest | String | true | 请求签名 |
logistics_interface | String | true | 请求报文内容 |
请求报文内容
名称 | 类型 | 字段长度 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|---|
serialNo | string | 64 | true | 10000 | 订单id |
cpCode | string | 64 | true | DiSu | 快递公司编码 |
branchCode | string | 64 | true | 569019 | 网点编码信息 |
sellerId | string | 19 | true | 0382001 | 商家 ID |
sellerPwd | string | 64 | true | 商家密码 | |
consigneeName | string | 20 | true | 收货人姓名 | |
consigneePhone | string | 40 | false | 收货人电话 | |
consigneeMobile | string | 40 | false | 收货人手机 | |
sendAddress | WaybillAddress | true | 发货地址 | ||
cityName | string | ||||
areaName | string | ||||
detailAddress | string | ||||
provinceName | string | ||||
consigneeAddress | WaybillAddress | true | 收货地址 | ||
cityName | string | ||||
areaName | string | ||||
detailAddress | string | ||||
provinceName | string | ||||
status | int | 2 | true | 面单状态 1:取消 2:新分配或更新) | |
senderName | string | 20 | true | 发货人姓名 | |
senderPhone | string | 40 | false | 发货人电话 | |
senderMobile | string | 40 | false | 发货人手机 | |
cardType | string | 2 | false | 身份证类型 | |
cardNumber | string | 20 | false | 身份证号码 | |
itemList | List | false | 商品信息列表 | ||
name | string | 20 | false | ||
count | int | 19 | false | ||
weight | long | 19 | false | 重量 , 单位:克 | |
volume | long | 19 | false | 体积 ,单位:毫升 | |
productType | string | 32 | false | 标准快递 | 产品类型 |
goodsDescription | string | 32 | false | 物品描述 | |
createTime | date | 30 | true | 生成时间 | |
totalPackagesCount | long | 19 | false | 子母件中的总件数 |
响应参数
名称 | 类型 | 字段长度 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|---|
success | boolean | True | 成功: true, 失败:false | ||
waybillCode | String | True | 主单号 | ||
subwaybillCode | String | 子单号 | |||
daTouBi | String | True | 大头笔 | ||
pkgName | string | False | 集包地名称 | ||
PkgCode | String | False | 集包地代码 | ||
errorCode | String | 256 | False | 错误码 | |
errorMsg | string | 512 | False | 错误原因 |
请求示例
{
"serialNo": "1",
"cpCode": "DiSu",
"branchCode": "569019",
"sellerId": "0382001",
"sellerPwd": "Abes01211",
"consigneeName": "李**",
"consigneePhone": "0755-00101",
"consigneeMobile": "13022222222",
"consigneeAddress": {
"cityName": "济南市",
"areaName": "天桥区",
"detailAddress": "蓝翔路 15 号时代总部基地",
"provinceName": "山东省"
},
"senderName": " 王 **",
"senderPhone": "0755-0000",
"senderMobile": "1308584455",
"sendAddress": {
"cityName": "杭州市",
"areaName": "余杭区",
"detailAddress": "文一西路 969 号阿里巴巴西溪园区 3 号楼小邮局",
"provinceName": "浙江省"
},
"cardType": "",
"cardNumber": "",
"status": 2,
"weight": 1000,
"productType": "标准快递",
"goodsDescription": "",
"createTime": "2019-01-01 10:00:00",
"totalPackagesCount": 1,
"itemList": [
{
"name": "文件",
"count": 1
}
]
}
响应示例
{
"success": "true",
"waybillCode": "616800000001",
"subwaybillCode": "616800000001-01,616800000001-02",
"daTouBi": A10,
"errorCode": "S01",
"errorMsg": "*****"
}
签名算法
时间戳 +分配秘钥做 MD5 加密( 32 位小写) 秘钥:timestamp + DExp@986127 时间戳取 13 位,10 分钟以内的时间戳有效。
二、订单取消接口
TMS_WAYBILL_CANCEL
公共请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
msg_type | String | true | 消息类型:TMS_WAYBILL_CANCEL |
partner_code | String | true | 合作伙伴编码 |
data_digest | String | true | 请求签名 |
logistics_interface | String | true | 请求报文内容 |
timestamp | String | true | 时间戳 |
### 请求报文内容
名称 | 类型 | 字 段 长 度 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|---|
cpCode | string | 64 | true | DiSu | 快递公司编码 |
branchCode | string | 64 | true | 569019 | 网点编码信息 |
sellerId | string | 19 | true | 0382001 | 商家 ID |
sellerPwd | string | 64 | true | 商家密码 | |
serialNo | string | 64 | true | 10000 | 订单 id |
waybillCode | string | 64 | true | 616800000001 | 快递单号 |
响应参数
名称 | 类型 | 字段长度 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|---|
success | boolean | True | 成功: true, 失败:false | ||
errorCode | String | 256 | False | 错误码 | |
errorMsg | string | 512 | false | 错误原因 |
三、面单余额查询
TMS_WAYBILL_ACCOUNT_QUERY_BATCH
公共请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
msg_type | String | true | 消 息 类 型 : TMS_WAYBILL_ACCOUNT_QUERY_BATCH |
partner_code | String | true | 合作伙伴编码 |
data_digest | String | true | 请求签名 |
logistics_interface | String | true | 请求报文内容 |
timestamp | String | true | 时间戳 |
请求报文内容
名称 | 类型 | 字 段 长 度 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|---|
cpCode | string | 64 | true | DiSu | 快递公司 编码 |
branchCode | string | 64 | true | 569019 | 网点编码 信息 |
sellerId | string | 19 | true | 0382001 | 商家 ID |
sellerPwd | string | 64 | true | 商家密码 |
响应参数
名称 | 类型 | 字段长度 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|---|
success | boolean | true | 成功:true,失败:false | ||
errorCode | String | 256 | false | 错误码 | |
errorMsg | string | 512 | false | 错误原因 | |
quantity | int | 10 | false | 可用余额 | |
allocatedQuantity | int | 10 | false | 累计已经分配数量 | |
cancelQuantity | int | 10 | false | 取消的面单数量 | |
recycledQuantity | int | 10 | false | 回收的面单数量 | |
confirmQuantity | int | 10 | false | 确认使用数量 |
错误码
errorCode | errorMsg |
---|---|
S01 | 系统错误 |
S02 | 校验失败 |
S10 | 电子面单账号不正确 |
S11 | 电子面单余额不足 |
S12 | 订单信息不完整(包括收寄件人信息不完整, 物品名称等) |
S13 | 筛单失败(目的地不可达) |
S14 | 下单失败 |
四、电子面单模板示例
1、德邦logo:不用在模板上添加,我司提供的面单上已打印该logo
2、代收货款:下单选择了代收货款服务时,需打印该信息及代收货款金额,否则不用打印(空白即可),子母件打印整票的代收金额;
3、到付:下单时付款方式是“到付”时,打印出付款方式,并以黑底白字醒目提醒;
4、运输方式
5、大头笔信息:如“新下单服务接口” 取arrivedOrgSimpleName 字段的值, “快递同步筛单下单接口” 和“快递电子面单获取运单号下单接口” 取bigpen字段的值;
6、到达区域:收货人的到达行政区
7、货物件数
8、收货人信息:打印收货人姓名、电话、地址
9、寄件人信息:打印发货人姓名、电话
10、实名认证标记:打印固定文字“实名认证”
11、运单号条码:运单号条码,采用code128B规则生成
12、运单号:打印该运单条码对应的单号,若是子母件,请打印对应母件单号;
13、验视章:打印固定文字“已验视”
14、签回单返单:下单选择了签收返单服务时,需打印该信息及返单类型,否则不用打印(空白即可)
15、保价金额:下单选择了保价服务时,需打印该保价金额,否则不用打印(空白即可)
16、打印时间