首页 > API文档 > 预约取件API
预约取件API为用户提供了在线下单，预约快递员上门揽件的功能，为用户解决在线发货需求。现已支持快递、快运业务，同城配业务即将上线。已覆盖国内主流物流公司，更多公司持续接入入中。
1.此接口用于通知快递公司快递员上门揽件，适用电商平台、打单工具、ERP系统、WEB端、APP移动端、小程序
2.支持自定义预约时间，实时预约，实时返回预约成功或失败结果，不遗漏订单，快递公司会在两小时内联系发件人并上门揽件
3.已支持顺丰速运、百世快递、中通快递、圆通速递、韵达速递、优速快递、德邦快递、EMS、宅急送等物流公司，并持续增加中
一、接口描述/说明
（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一致。 | 是 |
| EBusinessID | String | 商户ID，请在我的服务页面查看。 | 是 |
| RequestType | String | 请求指令类型：1001 | 是 |
| DataSign | String | 数据内容签名：把(请求内容(未编码)+AppKey)进行MD5加密，然后Base64编码，最后
进行URL(utf-8)编码。详细过程请查看Demo。 | 是 |
| DataType | String | 请求、返回数据类型：只支持JSON格式 | 是 |
二、接口参数
请求内容字段定义：
| 参数 | 类型 | 说明 | 必须要求 |
|---|
| WarehouseID | String(50) | 仓库标识(备用字段) | 否 |
| WarehouseAddress | String(50) | 仓库地址(备用字段) | 否 |
| CallBack | String(50) | 用户自定义回传字段 | 否 |
| MemberID | String(50) | ERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识，用于区分其用户 | 否 |
| ShipperCode | String(20) | 快递公司编码详细编码参考《快递鸟接口支持快递公司编码.xlsx》 | 是 |
| FcBoxShipperCode | String(20) | 选择快递柜支持预约的快递公司
(ShipperCode为FCBOX时必填)
SF：顺丰速运(仅支持ExpType为1和2两种业务类型)
ZTO：中通快递
STO：申通快递
YD：韵达速递
EMS：EMS | 可选 |
| LogisticCode | String(30) | 快递单号 | 否 |
| ThrOrderCode | String(50) | 第三方订单号，即电商平台原始订单号(ShipperCode=SF且需要核销原订单时必传) | 可选 |
| OrderCode | String(30) | 订单编号(自定义，不可重复) | 是 |
| PayType | Int(1) | 运费支付方式：
1-现付，2-到付，3-月结，4-第三方付(仅SF支持) | 是 |
| MonthCode | String(20) | 月结编号 | 可选 |
| ExpType | Int(2) | 详细快递类型参考《快递公司快递业务类型.xlsx》 | 是 |
| IsReturnSignBill | Int(1) | 是否要求签回单
0-不要求，1-要求 | 否 |
| Cost | Double(5) | 快递运费 | 否 |
| OtherCost | Double(5) | 其他费用 | 否 |
| Receiver | Company | String(30) | 收件人公司 | 否 |
| Name | String(30) | 收件人 | 是 |
| Tel | String(20) | 电话与手机，必填一个 | 是 |
| Mobile | String(20) |
| PostCode | String | 收件地邮编(ShipperCode为EMS、YZPY、YZBK时必填) | 可选 |
| ProvinceName | String(20) | 收件省
(如广东省，不要缺少“省”；
如是直辖市，请直接传北京、上海等；
如是自治区，请直接传广西壮族自治区等) | 是 |
| CityName | String(20) | 收件市(如深圳市，不要缺少“市；
如是市辖区，请直接传北京市、上海市等”) | 是 |
| ExpAreaName | String(20) | 收件区/县(如福田区，不要缺少“区”或“县”) | 是 |
| Address | String(100) | 收件人详细地址(不用传省市区) | 是 |
| Sender | Company | String(30) | 发件人公司 | 否 |
| Name | String(30) | 发件人 | 是 |
| Tel | String(20) | 电话与手机，必填一个 | 是 |
| Mobile | String(20) |
| PostCode | String(10) | 发件地邮编(ShipperCode为EMS、YZPY、YZBK时必填) | 可选 |
| ProvinceName | String(20) | 发件省
(如广东省，不要缺少“省”；
如是直辖市，请直接传北京、上海等；
如是自治区，请直接传广西壮族自治区等) | 是 |
| CityName | String(20) | 发件市(如深圳市，不要缺少“市；
如是市辖区，请直接传北京市、上海市等”) | 是 |
| ExpAreaName | String(20) | 发件区/县(如福田区，不要缺少“区”或“县”) | 是 |
| Address | String(100) | 发件人详细地址(不用传省市区) | 是 |
| StartDate | String(32) | 上门揽件开始时间，示例：2021-01-01 09:00:00 | 否 |
| EndDate | String(32) | 上门揽件结束时间，示例：2021-01-01 17:00:00 | 否 |
| Weight | Double(10,3) | 包裹总重量kg，当选择IsInstallService时，必填 | 可选 |
| Quantity | Int(2) | 包裹数，一个包裹对应一个运单号，如果是大于1个包裹，返回则按照子母件的方式返回母运单号和子运单号 | 是 |
| Volume | Double(20,3) | 包裹总体积m3 | 否 |
| Remark | String(20) | 备注 | 否 |
| Commoditys |
| Commodity | GoodsName | String(100) | 商品名称 | 是 |
| GoodsCode | String(20) | 商品编码 | 否 |
| Goodsquantity | Int(5) | 商品件数 | 否 |
| GoodsPrice | Double(10) | 商品价格 | 否 |
| GoodsWeight | Double(10,3) | 商品重量kg | 否 |
| GoodsDesc | String(50) | 商品描述 | 否 |
| GoodsVol | Double(15,3) | 商品体积m3 | 否 |
| InstallTypeCode | String(50) | 需送装时，必传安装品类编码(仅支持ShipperCode为SF) | 可选 |
| IsInstallService | Int(1) | 送装服务(仅支持ShipperCode为SF)；
0-非安装订单，1-送装分离，2-送装一体，不填默认为0 | 可选 |
| PackingType | Int(2) | 包装类型(快运字段)；
0-纸，1-纤，2-木，3-托膜，4-木托，99-其他 | 可选 |
| DeliveryMethod | Int(1) | 送货方式(快运字段)；
自提，1-送货上门（不含上楼），2-送货上楼。 | 可选 |
返回参数定义：
| 参数名称 | 类型(字符长度) | 描述 | 是否必须 |
|---|
| EBusinessID | String(10) | 用户ID | 是 |
| Order | OrderCode | String(30) | 订单编号 | 是 |
| ShipperCode | String(10) | 快递公司编码 | 是 |
| LogisticCode | String(30) | 快递单号 | 否 |
| Success | Bool(10) | 成功与否(true/false) | 是 |
| ResultCode | String(5) | 返回编号 | 是 |
| Reason | String(50) | 失败原因 | 否 |
| UniquerRequestNumber | String(50) | 唯一标识 | 是 |
三、示例
{
"OrderCode": "012657018199",
"ShipperCode": "SF",
"PayType": 1,
"MonthCode": "1234567890",
"ExpType": 1,
"Cost": 1.0,
"OtherCost": 1.0,
"Sender": {
"Company": "LV",
"Name": "快递鸟",
"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",
"CustomerID": "1234567890"
}
],
"Weight": 1.0,
"Quantity": 1,
"Volume": 0.0,
"Remark": "小心轻放"
}
{
"EBusinessID": "1237100",
"Success": true,
"Order": {
"OrderCode": "012657018199",
" ShipperCode ": " SF ",
" LogisticCode ": "615123456789"
},
"ResultCode": "100",
"Reason": ""
}
粤公安备案号：44030402002993
