商家寄件下单接口
POST
https://poll.kuaidi100.com/order/borderapi.do选择快递公司进行下单。
沙箱请求地址:https://api.kuaidi100.com/apiMock/border(订单将不推至快递公司:沙箱下单后,可通过:调试工具-商家寄件-下单回调,调试订单各阶段状态。)
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
kuaidicom | 是 | string | 快递公司的编码,一律用小写字母,见《快递公司编码》 |
recManName | 是 | string | 收件人姓名 |
recManMobile | 是 | string | 收件人的手机号,手机号和电话号二者其一必填 |
recManPrintAddr | 是 | string | 收件人所在完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园 |
sendManName | 是 | string | 寄件人姓名 |
sendManMobile | 是 | string | 寄件人的手机号,手机号和电话号二者其一必填 |
sendManPrintAddr | 是 | string | 寄件人所在的完整地址,如广东深圳市深圳市南山区科技南十二路2号金蝶软件园B10 |
callBackUrl | 是 | string | callBackUrl订单信息回调地址 |
cargo | 否 | string | 物品名称,例:文件。当kuaidicom=jd,yuantong时,必填 |
payment | 否 | string | 支付方式,SHIPPER: 寄付(默认)。不支持到付 |
serviceType | 否 | string | 业务类型,默认为标准快递,各快递公司业务类型对照参考:七、业务类型参数表 |
weight | 否 | string | 物品总重量KG,不需带单位,例:1.5 |
remark | 否 | string | 备注 |
dayType | 否 | string | 预约日期,例如:今天/明天/后天 |
pickupStartTime | 否 | string | 预约起始时间(HH:mm),例如:09:00,顺丰必填 |
pickupEndTime | 否 | string | 预约截止时间(HH:mm),例如:10:00,顺丰必填 |
channelSw | 否 | string | 渠道ID,如有多个同品牌运力,请联系商务提供后传入 |
下单扩展属性 | |||
valinsPay | 否 | string | 保价额度,单位:元 |
realName | 否 | string | 寄件人实名信息(圆通、极兔支持 ) |
sendIdCardType | 否 | string | 寄件人证件类型,1:居民身份证 ;2:港澳居民来往内地通行证 ;3:台湾居民来往大陆通行证 ;4:中国公民护照(圆通、极兔支持 ) |
sendIdCard | 否 | 寄件人证件号码 (圆通、极兔支持 ) | |
passwordSigning | 否 | string | 是否口令签收,Y:需要 N: 不需要,默认值为N(德邦快递专属参数) |
op | 否 | string | 是否开启订阅功能 0:不开启(默认) 1:开启 说明开启订阅功能时:pollCallBackUrl必须填入 此功能只针对有快递单号的单 |
pollCallBackUrl | 否 | string | 如果op设置为1时,pollCallBackUrl必须填入,用于跟踪回调,回调内容通过五、快递信息推送接口返回(免费服务) |
resultv2 | 否 | string | 添加此字段表示开通行政区域解析功能 。 0:关闭(默认) 1:开通行政区域解析功能以及物流轨迹增加物流状态名称 4:开通行政解析功能以及物流轨迹增加物流高级状态名称、状态值并且返回出发、目的及当前城市信息(详见:快递信息推送接口文档) |
returnType | 否 | string | 面单返回类型,默认为空,不返回面单内容。10:设备打印,20:生成图片短链回调。 |
siid | 否 | string | 设备码,returnType为10时必填 |
tempid | 否 | string | 模板编码,通过管理后台的电子面单模板信息获取 ,returnType不为空时必填 |
printCallBackUrl | 否 | string | 打印状态回调地址,returnType为10时必填 |
salt | 否 | string | 签名用随机字符串,用于验证签名sign。salt值不为null时,推送数据将包含该加密签名,加密方式:md5(param+salt)。注意: salt值为空串时,推送的数据也会包含sign,此时可忽略sign的校验。 |
eOrder数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
bulkpen | string | 大头笔 | 用于显示于电子面单上规定位置,非必需,是否有值取决于快递公司 |
orgCode | string | 始发地区域编码 | |
orgName | string | 始发地/始发网点名称 | |
destCode | string | 目的地区域编码 | |
destName | string | 目的地/到达网点 | |
orgSortingCode | string | 始发分拣编码 | |
orgSortingName | string | 始发分拣名称 | |
destSortingCode | string | 目的分栋编码 | |
destSortingName | string | 目的分栋中心名称 | |
orgExtra | string | 始发其他信息 | |
destExtra | string | 目的其他信息 | |
pkgCode | string | 集包编码 | |
pkgName | string | 集包地名称 | |
road | string | 路区 | |
qrCode | string | 二维码 | |
kdComOrderNum | string | 快递公司订单号 | |
expressCode | string | 快递业务类型编码 | |
expressName | string | 快递业务类型名称 | |
waterMark | string | 水印 | |
agingName | string | 时效 | |
abFlag | string | 电子产品类型图标 | |
proCode | string | 时效产品图标 | |
codingMapping | string | 进港映射码 | |
codingMappingOut | string | 出港信息 | |
printIcon | string | 图标名称 | |
destRouteLabel | string | 目的地(路由信息) | |
twoDimensionCode | string | 二维码信息 | |
xbFlag | string | 顺丰面单标识,快运必填,xbFlag=1,打印SX标;xbFlag=2,打印融通标 |
注意:eOrder实际返回的字段各家快递公司不同,以实际返回为准
说明:
信息代码 | 信息内容描述 | 原因及建议处理方式 |
---|---|---|
200 | 提交成功 | 提交成功 |
400 | 参数错误等 | 请根据技术文档请求,注意参数类型及是否必填 |
500 | 服务器错误 | 快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误 |
501 | 重复提交 | 重复提交了请求 |
503 | 验证签名失败 | 请检查加密方式,param + t + key + secret 的顺序进行MD5加密,加密后字符串转大写,不用加上“+”号 |
600 | 您不是合法的用户(即授权Key出错) | 账号无可用余额,需要充值 |
601 | KEY已过期 | 账号无可用余额,需要充值 |
700 | 错误的回调地址 | 检查回调地址,或者联系快递100工作人员 |
请求参数
Body 参数application/x-www-form-urlencoded
method
string
必需
业务类型(默认:bOrder)
示例值:
bOrder
key
string
必需
授权码,请到快递100页面申请企业版接口获取
sign
string
必需
32位大写签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号secret在授权邮件里面有
t
string
必需
时间戳如:1576123932000
示例值:
1576123932000
param
string
由其他字段拼接
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
result
boolean
必需
提交结果。true提交成功,false失败
returnCode
string
返回编码
message
string
返回报文描述
data
object
必需
taskId
string
任务ID
orderId
string
订单ID
示例
{
"result": true,
"returnCode": "200",
"message": "提交成功",
"data": {
"taskId": "", // 任务ID
"orderId": "" // 订单ID
"kuaidinum": "" // 快递单号
"eOrder": "[\"destName\":null,\"orgName\":null,\"pkgCode\":null,\"pkgName\":null,\"bulkpen\":\"上海-S33-K27-P\",\"orgExtra\":null}]"
}
}
最后修改时间: 2 年前