文档中心
一、下订单接口 二、订单取消接口 三、面单余额查询 四、电子面单模板示例

快递公司接入快递100电子面单接口技术文档

一、下订单接口

TMS_WAYBILL_DETAIL_SEND

名称类型是否必须描述
msg_typeStringtrue消 息 类 型 : TMS_WAYBILL_DETAIL_SEND
partner_codeStringtrue合作伙伴编码
data_digestStringtrue请求签名
logistics_interfaceStringtrue请求报文内容

请求报文内容

名称类型字段长度是否必须示例值描述
serialNostring64true10000订单id
cpCodestring64trueDiSu快递公司编码
branchCodestring64true569019网点编码信息
sellerIdstring19true0382001商家 ID
sellerPwdstring64true 商家密码
consigneeNamestring20true 收货人姓名
consigneePhonestring40false 收货人电话
consigneeMobilestring40false 收货人手机
sendAddressWaybillAddress true 发货地址
cityNamestring
areaNamestring
detailAddressstring
provinceNamestring
consigneeAddressWaybillAddress true 收货地址
cityNamestring
areaNamestring
detailAddressstring
provinceNamestring
statusint2true 面单状态 1:取消 2:新分配或更新)
senderNamestring20true 发货人姓名
senderPhonestring40false 发货人电话
senderMobilestring40false 发货人手机
cardTypestring2false 身份证类型
cardNumberstring20false 身份证号码
itemListList false 商品信息列表
namestring20false
countint19false
weightlong19false 重量 , 单位:克
volumelong19false 体积 ,单位:毫升
productTypestring32false标准快递产品类型
goodsDescriptionstring32false 物品描述
createTimedate30true 生成时间
totalPackagesCountlong19false 子母件中的总件数

响应参数

名称类型字段长度是否必须示例值描述
successboolean True 成功: true, 失败:false
waybillCodeString True 主单号
subwaybillCodeString 子单号
daTouBiString True 大头笔
pkgNamestring False 集包地名称
PkgCodeString False 集包地代码
errorCodeString256False 错误码
errorMsgstring512False 错误原因

请求示例

{
    "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_typeStringtrue消息类型:TMS_WAYBILL_CANCEL
partner_codeStringtrue合作伙伴编码
data_digestStringtrue请求签名
logistics_interfaceStringtrue请求报文内容
timestampStringtrue时间戳

### 请求报文内容

名称类型字 段 长 是否必须示例值描述
cpCodestring64trueDiSu快递公司编码
branchCodestring64true569019网点编码信息
sellerIdstring19true0382001商家 ID
sellerPwdstring64true 商家密码
serialNostring64true10000订单 id
waybillCodestring64true616800000001快递单号

响应参数

名称类型字段长度是否必须示例值描述
successboolean True 成功: true, 失败:false
errorCodeString256False 错误码
errorMsgstring512false 错误原因

三、面单余额查询

TMS_WAYBILL_ACCOUNT_QUERY_BATCH

公共请求参数

名称类型是否必须描述
msg_typeStringtrue消 息 类 型 : TMS_WAYBILL_ACCOUNT_QUERY_BATCH
partner_codeStringtrue合作伙伴编码
data_digestStringtrue请求签名
logistics_interfaceStringtrue请求报文内容
timestampStringtrue时间戳

请求报文内容

名称类型字 段 长 是否必须示例值描述
cpCodestring64trueDiSu快递公司 编码
branchCodestring64true569019网点编码 信息
sellerIdstring19true0382001商家 ID
sellerPwdstring64true 商家密码

响应参数

名称类型字段长度是否必须示例值描述
successboolean true 成功:true,失败:false
errorCodeString256false 错误码
errorMsgstring512false 错误原因
quantityint10false 可用余额
allocatedQuantityint10false 累计已经分配数量
cancelQuantityint10false 取消的面单数量
recycledQuantityint10false 回收的面单数量
confirmQuantityint10false 确认使用数量

错误码

errorCodeerrorMsg
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、打印时间