• 全国空气质量公报:华中华北有利臭氧生成 2019-05-21
  • 炎炎夏日要怎么养生? 这些妙招不错! 2019-05-21
  • (Dos sesiones) Enfoque de China Presidente Xi promete servir al pueblo en clausura de sesión anual de APN Spanish.xinhuanet.com 2019-05-21
  • 重构城市体系——论中国区域和城市可持续发展战略 2019-05-20
  • 特朗普:晋三,送你2500万墨西哥移民,你立马下台 2019-05-20
  • 点赞!5名男子冰河接力救人 2个孩子成功获救 2019-05-19
  • 北京将为人才提供住房支持 ——凤凰网房产北京 2019-05-19
  • 人民日报社天津分社公开招聘工作人员公告 2019-05-19
  • 铜梁这位30岁小伙抱上吉他骑着摩托去北极过生! 2019-05-19
  • 法兰克福投“中国人所好”改造老城区 吸引游客来此“怀旧” 2019-05-18
  • 端午假期铁路迎来返程客流高峰 2019-05-18
  • 河北阜城:“粽情飘香”敬老院 2019-05-18
  • 揭秘劣质红木家具的惯用造假手段 2019-05-18
  • 曹鸿鸣:为国家经济社会发展发挥致公党应有作用 2019-05-17
  • 中央环保督察组约见南昌分管副市长 2019-05-17
  • 首页 > API文档 > 预约取件API
    预约取件API
    申请API
    预约取件API为用户提供了在线下单,预约快递员上门揽件的功能,为用户解决在线发货需求。现已支持快递、快运业务,同城配业务即将上线。已覆盖国内主流物流公司,更多公司持续接入入中。
    应用场景
    (1)接口永久免费
    (2)对接物流公司官方接口,订单实时预约,实时返回预约成功或失败标识
    (3)支持自定义预约时间,不遗漏订单
    (4)已支持三通一达(申通不支持)、顺丰、EMS、宅急送、德邦、优速等物流公司,并持续增加中
    (5)快递公司会在两小时内联系发件人并上门揽件
    (6)需实名认证
    功能说明
    使用流程
    API参数
    一、接口描述/说明
    (1)在线下单接口是快递鸟提供给独立电商、仓储管理系统、物流供应链等物流系统平台使用的下单接口。
    (2)为客户解决在线发货需求,商户通过网络选择快递公司发送请求通知快递公司有快递要发货。
    (3) 客户把数据通过此接口转发到快递鸟,由快递鸟为您安排快递员上门取件的服务。
    (4)订单编号(OrderCode)不可重复提交,重复提交系统会返回具体错误代码。
    (5)接口支持的消息接收方式为HTTP POST,请求方法的编码格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
    (6)接口地址: API测试地址://sandboxapi.www.ahgdo.tw:8080/kdniaosandbox/gateway/exterfaceInvoke.json
    API正式地址://api.kdniao.com/api/OOrderService
    请求系统级参数说明:
    参数名称类型说明必须要求
    RequestDataString请求内容需进行URL(utf-8)编码。请求内容JSON格式,须和DataType一致。R
    EBusinessIDString商户ID,请在我的服务页面查看。R
    RequestTypeString请求指令类型:1001R
    DataSignString数据内容签名:把(请求内容(未编码)+AppKey)进行MD5加密,然后Base64编码,最后 进行URL(utf-8)编码。详细过程请查看Demo。R
    DataTypeString请求、返回数据类型:只支持JSON格式R
    备注:R-必填(Required),O-可?。∣ptional),C-报文中该参数在一定条件下可?。–onditional)
    二、接口参数
    请求内容字段定义:
    参数类型说明必须要求
    WarehouseIDString仓库标识O
    WarehouseAddressString仓库地址O
    CallBackString商户标识O
    MemberIDString会员标识O
    ShipperCodeString快递公司编码R
    LogisticCodeString快递单号O
    IsNoticeInt发货方式:0-上门揽件,1-网点自寄,默认为1O
    PackingTypeInt包装类型:包装类型(快运字段)默认为 0; 0- 纸 1- 纤 2- 木 3- 托膜 4- 木托 99-其他O
    IsReturnSignBillInt签收回单:1-需要,0-不需要,默认为0O
    DeliveryMethodInt送货方式:0-自提,1-送货上门(不含上楼)2-送货上楼。(适用于快运类型订单,物流公司可能会收取费用),默认为0O
    OrderCodeString订单编号R
    MonthCodeString月结编码C
    PayTypeInt邮费支付方式:1-现付,2-到付,3-月结,4-第三方支付R
    ExpTypeInt快递类型:1-标准快件R
    CostDouble寄件费(运费)O
    OtherCostDouble其他费用O
    ReceiverCompanyString收件人公司O
    NameString收件人R
    TelString电话与手机,必填一个R
    MobileString
    PostCodeString收件人邮编O
    ProvinceNameString收件?。ㄈ绻愣?,不要缺少“省”)R
    CityNameString收件市(如深圳市,不要缺少“市”)R
    ExpAreaNameString收件区(如福田区,不要缺少“区”或“县”)O
    AddressString收件人详细地址R
    SenderCompanyString发件人公司O
    NameString发件人R
    TelString电话与手机,必填一个R
    MobileString
    PostCodeString发件人邮编O
    ProvinceNameString发件?。ㄈ绻愣?,不要缺少“省”)R
    CityNameString发件市(如深圳市,不要缺少“市”)R
    ExpAreaNameString发件区(如福田区,不要缺少“区”或“县”)O
    AddressString发件人详细地址R
    StartDateString上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化,本文中所有时间格式相同O
    EndDateStringO
    WeightDouble物品总重量kgO
    QuantityInt件数/包裹数O
    VolumeDouble物品总体积m3O
    RemarkString备注O
    AddServices
    AddServiceNameString增值服务名称O
    ValueString增值服务值O
    CustomerIDString客户标识(选填)O
    Commoditys
    CommodityGoodsNameString商品名称R
    GoodsCodeString商品编码O
    GoodsquantityInt商品数量O
    GoodsPriceDecimal商品价格O
    GoodsWeightDecimal商品重量O
    GoodsDescString商品描述O
    GoodsVolDouble商品体积m3O
    返回参数定义:
    参数名称类型说明必须要求
    EBusinessIDString用户IDR
    OrderOrderCodeString订单编号R
    ShipperCodeString快递公司编码R
    LogisticCodeString快递单号O
    SuccessBool成功与否R
    ResultCodeString结果编码R
    ReasonString失败原因O
    UniquerRequestNumberString唯一标识R
    三、示例
    请求示例 JSON
    {
    "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": "小心轻放"
    }
    返回示例 JSON
    失败:
    {
        "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": ""
    }
    接入流程
    demo下载

    相关文档与更多帮助?

    30万+
    数十万客户的选择
    5.8亿次+
    日均处理物流数据次数
    1450万+
    日均千万订单数据处理
    418家+
    支持全国418家物流商
    在线咨询
    商务合作群:
    847086973
    技术对接群10:
    790953829
    分析港彩平特肖尾软件
    400-9633321
    免费获取API
  • 全国空气质量公报:华中华北有利臭氧生成 2019-05-21
  • 炎炎夏日要怎么养生? 这些妙招不错! 2019-05-21
  • (Dos sesiones) Enfoque de China Presidente Xi promete servir al pueblo en clausura de sesión anual de APN Spanish.xinhuanet.com 2019-05-21
  • 重构城市体系——论中国区域和城市可持续发展战略 2019-05-20
  • 特朗普:晋三,送你2500万墨西哥移民,你立马下台 2019-05-20
  • 点赞!5名男子冰河接力救人 2个孩子成功获救 2019-05-19
  • 北京将为人才提供住房支持 ——凤凰网房产北京 2019-05-19
  • 人民日报社天津分社公开招聘工作人员公告 2019-05-19
  • 铜梁这位30岁小伙抱上吉他骑着摩托去北极过生! 2019-05-19
  • 法兰克福投“中国人所好”改造老城区 吸引游客来此“怀旧” 2019-05-18
  • 端午假期铁路迎来返程客流高峰 2019-05-18
  • 河北阜城:“粽情飘香”敬老院 2019-05-18
  • 揭秘劣质红木家具的惯用造假手段 2019-05-18
  • 曹鸿鸣:为国家经济社会发展发挥致公党应有作用 2019-05-17
  • 中央环保督察组约见南昌分管副市长 2019-05-17