快递鸟一次性对接1600+物流接口

首页 > API文档 > 预约取件API
预约取件API
申请API
预约取件API为用户提供了在线下单,预约快递员上门揽件的功能,为用户解决在线发货需求。现已支持快递、快运业务,同城配业务即将上线。已覆盖国内主流物流公司,更多公司持续接入入中。
应用场景
1.此接口用于通知快递公司快递员上门揽件,适用电商平台、打单工具、ERP系统、WEB端、APP移动端、小程序
2.支持自定义预约时间,实时预约,实时返回预约成功或失败结果,不遗漏订单,快递公司会在两小时内联系发件人并上门揽件
3.已支持顺丰速运、百世快递、中通快递、圆通速递、韵达速递、优速快递、德邦快递、EMS、宅急送等物流公司,并持续增加中
功能说明
使用流程
API参数
一、接口描述/说明
(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
请求系统级参数说明:
参数名称类型说明必须要求
RequestDataString请求内容需进行URL(utf-8)编码。请求内容JSON格式,须和DataType一致。
EBusinessIDString商户ID,请在我的服务页面查看。
RequestTypeString请求指令类型:1001
DataSignString数据内容签名:把(请求内容(未编码)+AppKey)进行MD5加密,然后Base64编码,最后 进行URL(utf-8)编码。详细过程请查看Demo。
DataTypeString请求、返回数据类型:只支持JSON格式
二、接口参数
请求内容字段定义:
参数类型说明必须要求
WarehouseIDString(50)仓库标识(备用字段)
WarehouseAddressString(50)仓库地址(备用字段)
CallBackString(50)用户自定义回传字段
MemberIDString(50)ERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识,用于区分其用户
ShipperCodeString(20)快递公司编码详细编码参考《快递鸟接口支持快递公司编码.xlsx》
FcBoxShipperCodeString(20)选择快递柜支持预约的快递公司 (ShipperCode为FCBOX时必填) SF:顺丰速运(仅支持ExpType为1和2两种业务类型)
ZTO:中通快递
STO:申通快递
YD:韵达速递
EMS:EMS
可选
LogisticCodeString(30)快递单号
ThrOrderCodeString(50)第三方订单号,即电商平台原始订单号(ShipperCode=SF且需要核销原订单时必传)可选
OrderCodeString(30)订单编号(自定义,不可重复)
PayTypeInt(1)运费支付方式: 1-现付,2-到付,3-月结,4-第三方付(仅SF支持)
MonthCodeString(20)月结编号可选
ExpTypeInt(2)详细快递类型参考《快递公司快递业务类型.xlsx》
IsReturnSignBillInt(1)是否要求签回单 0-不要求,1-要求
CostDouble(5)快递运费
OtherCostDouble(5)其他费用
ReceiverCompanyString(30)收件人公司
NameString(30)收件人
TelString(20)电话与手机,必填一个
MobileString(20)
PostCodeString收件地邮编(ShipperCode为EMS、YZPY、YZBK时必填)可选
ProvinceNameString(20)收件省 (如广东省,不要缺少“省”; 如是直辖市,请直接传北京、上海等; 如是自治区,请直接传广西壮族自治区等)
CityNameString(20)收件市(如深圳市,不要缺少“市; 如是市辖区,请直接传北京市、上海市等”)
ExpAreaNameString(20)收件区/县(如福田区,不要缺少“区”或“县”)
AddressString(100)收件人详细地址(不用传省市区)
SenderCompanyString(30)发件人公司
NameString(30)发件人
TelString(20)电话与手机,必填一个
MobileString(20)
PostCodeString(10)发件地邮编(ShipperCode为EMS、YZPY、YZBK时必填)可选
ProvinceNameString(20)发件省 (如广东省,不要缺少“省”; 如是直辖市,请直接传北京、上海等; 如是自治区,请直接传广西壮族自治区等)
CityNameString(20)发件市(如深圳市,不要缺少“市; 如是市辖区,请直接传北京市、上海市等”)
ExpAreaNameString(20)发件区/县(如福田区,不要缺少“区”或“县”)
AddressString(100)发件人详细地址(不用传省市区)
StartDateString(32)上门揽件开始时间,示例:2021-01-01 09:00:00
EndDateString(32)上门揽件结束时间,示例:2021-01-01 17:00:00
WeightDouble(10,3)包裹总重量kg,当选择IsInstallService时,必填可选
QuantityInt(2)包裹数,一个包裹对应一个运单号,如果是大于1个包裹,返回则按照子母件的方式返回母运单号和子运单号
VolumeDouble(20,3)包裹总体积m3
RemarkString(20)备注
Commoditys
CommodityGoodsNameString(100)商品名称
GoodsCodeString(20)商品编码
GoodsquantityInt(5)商品件数
GoodsPriceDouble(10)商品价格
GoodsWeightDouble(10,3)商品重量kg
GoodsDescString(50)商品描述
GoodsVolDouble(15,3)商品体积m3
InstallTypeCodeString(50)需送装时,必传安装品类编码(仅支持ShipperCode为SF)可选
IsInstallServiceInt(1)送装服务(仅支持ShipperCode为SF); 0-非安装订单,1-送装分离,2-送装一体,不填默认为0可选
PackingTypeInt(2)包装类型(快运字段); 0-纸,1-纤,2-木,3-托膜,4-木托,99-其他可选
DeliveryMethodInt(1)送货方式(快运字段); 自提,1-送货上门(不含上楼),2-送货上楼。可选
返回参数定义:
参数名称类型(字符长度)描述是否必须
EBusinessIDString(10)用户ID
OrderOrderCodeString(30)订单编号
ShipperCodeString(10)快递公司编码
LogisticCodeString(30)快递单号
SuccessBool(10)成功与否(true/false)
ResultCodeString(5)返回编号
ReasonString(50)失败原因
UniquerRequestNumberString(50)唯一标识
三、示例
请求示例 JSON
{
        "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": "小心轻放"
      }
返回示例 JSON
{
        "EBusinessID": "1237100",
        "Success": true,
        "Order": {
            "OrderCode": "012657018199",
            " ShipperCode ": " SF ",
            " LogisticCode ": "615123456789"
        },
        "ResultCode": "100",
        "Reason": ""
    }
接入流程
demo下载

相关文档与更多帮助?

30万+
数十万客户的选择
5.8亿次+
日均处理物流数据次数
1450万+
日均千万订单数据处理
1600家+
支持全国1600+家物流商
在线咨询

Hi~ 我在线

欢迎您随时咨询
×
技术对接
Q群941050476
免费获取
关注公众号
关注公众号
获取最新行业知识
电话咨询
400-8699-100
回到顶部