首页 > API文档 > 预约取件API
预约取件API为用户提供了在线下单,预约快递员上门揽件的功能,为用户解决在线发货需求。现已支持快递、快运业务,同城配业务即将上线。已覆盖国内主流物流公司,更多公司持续接入入中。
(1)接口永久免费
(2)对接物流公司官方接口,订单实时预约,实时返回预约成功或失败标识
(3)支持自定义预约时间,不遗漏订单
(4)已支持三通一达(申通不支持)、顺丰、EMS、宅急送、德邦、优速等物流公司,并持续增加中
(5)快递公司会在两小时内联系发件人并上门揽件
(6)需实名认证
一、接口描述/说明
(1)在线下单接口是快递鸟提供给独立电商、仓储管理系统、物流供应链等物流系统平台使用的下单接口。
(2)为客户解决在线发货需求,商户通过网络选择快递公司发送请求通知快递公司有快递要发货。
(3) 客户把数据通过此接口转发到快递鸟,由快递鸟为您安排快递员上门取件的服务。
(4)订单编号(OrderCode)不可重复提交,重复提交系统会返回具体错误代码。
(5)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
(6)接口地址: API测试地址:http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址:https://api.kdniao.com/api/OOrderService
请求系统级参数说明:
参数名称 | 类型 | 说明 | 必须要求 |
---|
RequestData | String | 请求内容需进行URL(utf-8)编码。请求内容JSON格式,须和DataType一致。 | R |
EBusinessID | String | 商户ID,请在我的服务页面查看。 | R |
RequestType | String | 请求指令类型:1001 | R |
DataSign | String | 数据内容签名:把(请求内容(未编码)+AppKey)进行MD5加密,然后Base64编码,最后
进行URL(utf-8)编码。详细过程请查看Demo。 | R |
DataType | String | 请求、返回数据类型:只支持JSON格式 | R |
备注:R-必填(Required),O-可选(Optional),C-报文中该参数在一定条件下可选(Conditional)
二、接口参数
请求内容字段定义:
参数 | 类型 | 说明 | 必须要求 |
---|
WarehouseID | String | 仓库标识 | O |
WarehouseAddress | String | 仓库地址 | O |
CallBack | String | 商户标识 | O |
MemberID | String | 会员标识 | O |
ShipperCode | String | 快递公司编码 | R |
LogisticCode | String | 快递单号 | O |
IsNotice | Int | 发货方式:0-上门揽件,1-网点自寄,默认为1 | O |
PackingType | Int | 包装类型:包装类型(快运字段)默认为 0; 0- 纸 1- 纤 2- 木 3- 托膜 4- 木托 99-其他 | O |
IsReturnSignBill | Int | 签收回单:1-需要,0-不需要,默认为0 | O |
DeliveryMethod | Int | 送货方式:0-自提,1-送货上门(不含上楼)2-送货上楼。(适用于快运类型订单,物流公司可能会收取费用),默认为0 | O |
OrderCode | String | 订单编号 | R |
MonthCode | String | 月结编码 | C |
PayType | Int | 邮费支付方式:1-现付,2-到付,3-月结,4-第三方支付 | R |
ExpType | Int | 快递类型:1-标准快件 | R |
Cost | Double | 寄件费(运费) | O |
OtherCost | Double | 其他费用 | O |
Receiver | Company | String | 收件人公司 | O |
Name | String | 收件人 | R |
Tel | String | 电话与手机,必填一个 | R |
Mobile | String |
PostCode | String | 收件人邮编 | O |
ProvinceName | String | 收件省(如广东省,不要缺少“省”) | R |
CityName | String | 收件市(如深圳市,不要缺少“市”) | R |
ExpAreaName | String | 收件区(如福田区,不要缺少“区”或“县”) | O |
Address | String | 收件人详细地址 | R |
Sender | Company | String | 发件人公司 | O |
Name | String | 发件人 | R |
Tel | String | 电话与手机,必填一个 | R |
Mobile | String |
PostCode | String | 发件人邮编 | O |
ProvinceName | String | 发件省(如广东省,不要缺少“省”) | R |
CityName | String | 发件市(如深圳市,不要缺少“市”) | R |
ExpAreaName | String | 发件区(如福田区,不要缺少“区”或“县”) | O |
Address | String | 发件人详细地址 | R |
StartDate | String | 上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有时间格式相同 | O |
EndDate | String | O |
Weight | Double | 物品总重量kg | O |
Quantity | Int | 件数/包裹数 | O |
Volume | Double | 物品总体积m3 | O |
Remark | String | 备注 | O |
AddServices |
AddService | Name | String | 增值服务名称 | O |
Value | String | 增值服务值 | O |
CustomerID | String | 客户标识(选填) | O |
Commoditys |
Commodity | GoodsName | String | 商品名称 | R |
GoodsCode | String | 商品编码 | O |
Goodsquantity | Int | 商品数量 | O |
GoodsPrice | Decimal | 商品价格 | O |
GoodsWeight | Decimal | 商品重量 | O |
GoodsDesc | String | 商品描述 | O |
GoodsVol | Double | 商品体积m3 | O |
返回参数定义:
参数名称 | 类型 | 说明 | 必须要求 |
---|
EBusinessID | String | 用户ID | R |
Order | OrderCode | String | 订单编号 | R |
ShipperCode | String | 快递公司编码 | R |
LogisticCode | String | 快递单号 | O |
Success | Bool | 成功与否 | R |
ResultCode | String | 结果编码 | R |
Reason | String | 失败原因 | O |
UniquerRequestNumber | String | 唯一标识 | R |
三、示例
{
"OrderCode": "012657018199",
"ShipperCode": "SF",
"PayType": 1,
"MonthCode": "7553045845",
"ExpType": 1,
"Cost": 1.0,
"OtherCost": 1.0,
"Sender": {
"Company": "LV",
"Name": "Taylor",
"Mobile": "15018442396",
"ProvinceName": "上海",
"CityName": "上海",
"ExpAreaName": "青浦区",
"Address": "明珠路"
},
"Receiver": {
"Company": "GCCUI",
"Name": "Yann",
"Mobile": "15018442396",
"ProvinceName": "北京",
"CityName": "北京",
"ExpAreaName": "朝阳区",
"Address": "三里屯街道"
},
"Commodity": [
{
"GoodsName": "鞋子",
"Goodsquantity": 1,
"GoodsWeight": 1.0
}
],
"AddService": [
{
"Name": "COD",
"Value": "1020"
}
],
"Weight": 1.0,
"Quantity": 1,
"Volume": 0.0,
"Remark": "小心轻放"
}
失败:
{
"EBusinessID": "1237100",
"Success": false,
"ResultCode": "105",
"Reason": "该订单已经存在,请勿重复操作",
"UniquerRequestNumber":"451d3c7c-b428-490a-a4ed-e368f15f6c74"
}
成功:
{
"EBusinessID": "1237100",
"Success": true,
"Order": {
"OrderCode": "012657018199",
" ShipperCode ": " SF ",
" LogisticCode ": ""
},
"ResultCode": "100",
"Reason": ""
}