新手指南

接入流程

接入流程

一、申请成为开发者

路径:首页-成为开发者

申请成为开发者
  • 1.开发者在首页页面中部区域点击成为申请成为开发者
  • 2.按照页面提示信息,填写后提交申请
  • 3.平台会在1~2个工作日内完成信息审核
  • 4.开发者需根据实际情况选择开发者类型,提交信息与实际情况不予通过
  • 5.自研开发者和第三方开发者区别:
    • (1)自研开发者:商家自有研发团队申请,平台会审核商家的资质信息
    • (2)第三方开发者:为商家提供软件支持服务的研发团队申请,每次创建项目时可自行选择新项目支持管理连锁门店

二、创建项目

路径:开发者后台-项目列表-创建项目

创建项目
  • 1.开发者资质审核通过后,可在开发者后台-项目列表,创建新项目
  • 2.在项目内可以申请测试账号(source),用于开发测试
  • 3.平台对重要接口设置验收机制,此类接口需验收通过后才能在线上环境调用

三、开发测试

路径:开发者后台-项目列表-项目查看-项目详情

开发测试
  • 1.在项目详情添加测试合作方账号(source),添加成功后页面内新增展示测试合作方账号(source)信息
  • 2.添加合作方账号(source)时的下行接口地址是用于接收平台推送消息的服务地址
  • 3.测试合作方账号(source)创建成功后,平台会为此合作方账号(source)自动创建一个测试门店(商户列表可查看),账号密码和门店信息会通过邮箱下发
  • 4.开发者可使用合作方账号(source)和密钥进行接口测试

四、接口验收

路径:开发者后台-项目列表-项目验收

接口验收
  • 1.创建项目时勾选的需验收接口,必须验收通过后才能申请正式合作方账号(source)进入后续流程
  • 2.接口验收方法:调用需验收接口,调用成功后(调用后接口返回成功),在验收页面选择对应的合作方账号,点击去验收
  • 3.开发者接口验收列表可在“开发者后台-项目列表-项目查看-接口配置”中进行配置

五、商户授权

路径:开发者后台-项目列表-项目查看-门店绑定

商户授权
  • 1.开发者申请正式合作方账号(source)通过后,方可在门店绑定页面进行门店授权,测试合作方账号(source)和测试门店都无法进行门店授权,请不要将测试门店解除API授权
  • 2.每个正式合作方账号(source)对应一个绑定链接,打开绑定链接使用合作方账号(source)对应的供应商or门店的饿百商家端账号密码登录,勾选门店授权
  • 3.同一正式门店只能授权给一个合作方账号(source)
  • 4.门店关联合作方门店ID在“门店绑定-第三方门店ID映射”页面进行操作,或在商户列表点击对应门店的合作方商户ID进行操作,或可通过门店映射接口操作
  • 5.合作方商户ID在同一个合作方账号(source)内不能重复,关联后开发者可使用自有系统商户ID管理门店
  • 6.门店取消API关联,需使用取消绑定链接操作,打开此链接使用需解绑门店的饿百商家端账号密码登录,勾选门店解绑

接入方案

商品模块

应用场景:商家通过自有系统完成商品创建和修改,维护库存和价格,提高商品信息更新效率

建议对接接口:

  • sku.create-商品上传
  • sku.update-商品修改
  • sku.category.list-获取分类列表
  • sku.brand.list-获取品牌列表
  • sku.shop.category.create-新增商品自定义分类
  • sku.shop.category.map-绑定商品与自定义分类
  • sku.stock.update.batch-批量修改商品库存
  • sku.price.update.batch-批量修改商品价格

注意事项:

  • 1.创建商品接口中分类指后台分类,即平台归类使用,对用户不可见分类,通过获取分类列表接口获取
  • 2.创建商品成功后,需绑定自定义分类方可在用户端展示
  • 3.二级自定义分类最大值为20,有二级自定义分类的一级自定义分类不能绑定商品
  • 4.创建商品时upc字段命中平台标库upc,商品名称等信息默认使用平台标库信息
  • 5.不支持通过API修改商品upc
  • 6.若门店沿用供应商前台分类并且将此套分类同步到所有门店,对应门店首次调用自定义分类接口会触发解锁逻辑,即首次调用自定义分类接口报错

订单模块

售前方案

应用场景:商家系统确认订单,查看订单详情

建议对接接口:

  • order.create-创建订单
  • order.confirm-确认订单
  • order.get-查看订单详情

注意事项:

  • 1.用户下单后,商家可处理的时间为5分钟,超时未接单订单将自动无效
  • 2.平台通过接口推送订单均为已支付订单
  • 3.双平台订单推送和操作均以order_id字段为准,饿了么订单在order.get接口中单独给出eleme_order_id
  • 4.非自配送订单由骑手回传订单完成状态,自配送订单在商家接单一段时间后自动完成(饿了么订单接单3小时后、饿了么星选订单接单4小时后自动完成)
售前方案

售中方案-用户取消订单

应用场景:商家系统处理用户取消订单申请

建议对接接口:

  • order.user.cancel-用户申请订单取消/退款
  • order.agreerefund-同意用户取消订单/退款
  • order.disagreerefund-拒绝用户取消订单/退款
  • order.cancellist-获取未处理取消单/退单

注意事项:

  • 1.发起流程节点:订单完成前,用户可发起订单取消申请
  • 2.商家需在用户申请取消15分钟内处理用户申请,超时未处理默认同意用户取消申请
  • 3.商家拒绝用户取消申请,用户可以发起客服仲裁,由客服联系商家和用户处理订单取消事宜
  • 4.其他用户直接取消订单场景(无需商家同意,系统默认同意用户取消申请)
  • (1)非自配送订单商家接单1分钟内骑手未取货,或自配送订单商家接单1分钟内,用户可直接取消订单
  • (2)非自配送订单,订单超过预计送达时间+10分钟(预计送达时间由平台计算,在用户提交订单时页面展示)骑手还未取货,用户可直接取消订单
  • (3)非自配送订单且非预订单,订单超过预计送达时间+30分钟(预计送达时间由平台计算,在用户提交订单时页面展示)骑手还未送达,用户可直接取消订单
  • 5.开启门店订单取消功能路径:开发者后台->项目列表->项目详情->修改账号(source)->开启全单取消/退单
售中方案

售中方案-商家取消/部分退

应用场景:商家拣货过程中发现部分商品缺货,将缺货商品或整单商品退款给用户

建议对接接口:

  • order.partrefund.push-部分退款订单信息推送
  • order.partrefund-商户发起部分退款申请
  • order.partrefund.get-查看部分退款订单详情
  • order.cancel-取消订单

注意事项:

  • 1.发起流程节点:
    • (1)非自配送商家:商家接单后,骑手取餐前商家可发起部分退款或取消订单
    • (2)自配送商家:商家接单后至订单完成前,商家可发起部分退款或取消订单
  • 2.每笔订单订单完成前后各支持一次部分退款
  • 3.饿了么订单商家发起部分退款,系统默认用户同意(暂不支持饿了么星选订单部分退款)
  • 4.开启门店部分退款功能路径:开发者后台->项目列表->项目详情->修改账号(source)->开启部分退款

售后方案

应用场景:订单完成后,处理用户的全单/部分退款申请

建议对接接口:

  • order.user.cancel-用户申请订单取消/退款
  • order.partrefund.push-部分退款订单信息推送
  • order.agreerefund-同意用户取消订单/退款
  • order.disagreerefund-拒绝用户取消订单/退款
  • order.cancellist-获取未处理取消单/退单
  • order.partrefund.untrelist-获取未处理部分退订单
  • order.partrefund.get-查看部分退款订单详情

注意事项:

  • 1.发起流程节点:订单完成后,用户可发起全单退款或部分退款
  • 2.商家需在24小时内处理用户全单或部分退款申请,超时未处理默认同意用户全单或部分退款
  • 3.如果商家拒绝用户全单或部分退款申请,用户可以发起客服仲裁,由客服联系双方处理用户退款事宜
  • 4.开启门店全单退款功能路径:开发者后台->项目列表->项目详情->修改账号(source)->开启全单取消/退单
  • 5.开启门店部分退款功能路径:开发者后台->项目列表->项目详情->修改账号(source)->开启部分退款
售后方案

商户模块

应用场景:商家通过商家系统维护门店信息

建议对接接口:

  • shop.get-查看商户
  • shop.update-修改商户
  • shop.open-商户开业
  • shop.close-商户歇业
  • picture.upload-上传图片

注意事项:

  • 1.创建、修改商户的配送信息只对自配送生效,非自配送的配送范围需平台业务侧修改
  • 2.合作方门店ID在创建门店时可上传,存量门店可在“开发者后台-项目列表-项目查看-商户列表”或“开发者后台-项目列表-项目查看-门店绑定”进行修改
  • 3.图片参数需使用上传图片接口返回的url
商户模块

其他

【新零售商户端下载】

PC电脑客户端下载:点击下载

Android手机版下载:点击下载

ios手机版下载:直接应用商店搜索 饿百商家版

网页版直接登录:be.ele.me