开放平台
  1. 点餐接口
开放平台
  • App/H5对接流程:
  • API开放接口对接流程
  • 小程序对接流程v1.1
  • 数据推送说明
  • 基础信息
    • 获取接口访问令牌
      POST
    • 更改密码
      POST
    • 企业用户信息 v1.1
      GET
    • 获取会员token
      POST
  • 电影票接口
    • 电影票回调通知
    • 获取城市列表
      GET
    • 热映电影(pageIndex从0开始)
      GET
    • 即将上映电影
      GET
    • 获取影院列表
      GET
    • 获取影院过滤列表(获取城市影院品牌和区域信息)
      GET
    • 获取电影的影院列表
      GET
    • 获取电影详情
      GET
    • 获取影院某个电影的排片列表
      GET
    • 获取电影场次(座位)详情
      GET
    • 创建订单
      POST
    • 订单简要信息(字段较简洁,用于发起订单支付)
      GET
    • 支付订单(用户付款成功后调用)
      GET
    • 订单列表(管理)
      POST
    • 订单详情
      GET
    • 返回所有电影
      GET
    • 获取广告列表
      GET
  • 卡券接口
    • GiftCard
      • 卡券商品分类列表
      • 卡券商品列表
      • 商品详情
      • 下单(自己做产品展示,才需要下单接口)
      • 订单支付通知
      • 订单列表
      • 订单详情
      • 卡券商品按类别列表(共二级分类)
  • 点餐接口
    • 点餐回调通知
    • 城市列表
      GET
    • 平台店铺列表
      GET
    • 店铺详情,如果传了经纬度,返回距离
      GET
    • 菜单
      GET
    • 商品详情(不同品牌商品详情会有所不同)
      GET
    • 创建订单(不同品牌的商品详情下单的参数会有所不同)
      POST
    • 订单支付通知(用户付款成功后调用)
      GET
    • 订单列表
      POST
    • 订单详情
      GET
    • 订单上传文件列表
      GET
  1. 点餐接口

点餐回调通知

回调地址在群通知我方技术人员在后台配置
推送方式为POST
统一的数据格式:{type:0电影订单 1生活卡券订单 2返利商品订单 3外卖订单 4吃喝玩乐订单 5点餐订单,data:{对应的业务数据}}
有重发机制,如果接收推送数据的接口返回的http状态不是200,则会按一定的间隔时间重发3次,如果都没有成功,则记录为失败,等对接方通知我们接口正常了以后可以重新推送
金额单位为元,保留两位小数点
点餐订单推送
参数说明

一、orderState点餐订单状态枚举:#

0: 等待支付(创建订单)
1: 订单已付
3: 已出码(订单成功)
6: 订单退款
7: 超时未付(取消)
8: 部分退款
12: 配送中(仅外卖单)

二、回调推送:#

当订单状态流转到0、1、3、6、7、8、12状态和人工更改订单数据(如变更取餐码,当一个订单有多个取餐码时候,可能会推送多次,因为第一次可能会只显示一个取餐码,然后第二餐推送时候由人工变更更新完整取餐码)时,我方将发起回调推送。
正常推送情况:出单成功推送codes取餐码;退款推送refundAmount退款金额。

三、出单成功处理:#

当订单状态变为 3(已出码) 时,表示订单已经成功出单,系统会推送取餐码(codes)。这个取餐码是用户取餐时使用的唯一标识。
对于已完成订单,成本结算价为:订单详情接口的epCostPric(企业成本)字段获取结算价格(注:如果订单在出码后发生部分退款业务,订单状态将更新为 8(部分退款)。此时,订单的结算价格也会发生变化,需要重新获取最新的结算价格。)

四、退款处理:#

退款商品数量某些情况不下退款商品的数量不一定准确,只能作为参考,建议处理部分退款时通过退款金额计算退款比率来设置实际退款金额
-订单整体退款比率 = 订单退款总金额 / 用户总价(totalRefundAmount / totalUserPrice )
-订单内某个品的退款比率 = refundProducts里面的totalRefundAmount/(quantity*selPrice)
部分退款订单成本结算价=可从订单详情接口的epCostPric(企业成本)字段获取结算价格。

五、epCostPric结算价(企业成本)在部分退款订单的特殊性:#

针对部分退款业务,涉及的结算和余额逻辑可以分为两种情况:
1.
退款后会充值的情况( 这种情况发生在订单先全部扣款成功后,部分商品退款时,系统会将对应退款商品的金额充值回余额中)。
流程说明:
订单出单成功,系统从余额中扣除全部商品金额。
部分商品退款,系统会将退款商品的金额重新充值到余额中。
在财务菜单 → 余额明细中,能看到一笔扣款记录和一笔充值记录。
2.
退款后不充值,直接扣除对应金额的情况
这种情况发生在部分退款直接扣除对应的结算价格,系统会直接扣除退款之后的商品金额,而不会再进行充值操作。
流程说明:
部分商品退款时,系统直接扣除对应退款之后的商品金额,结算价格自动更新。
在财务菜单 → 余额明细中,能看到一笔扣费明细记录(不会出现充值记录)。

六、部分退款订单的特殊性:#

部分退款订单推送比较特殊,部分退款订单可能从 3(订单成功) 流转到 8(部分退款)
部分退款订单也可能不经过3直接流转到8,部分退款订单(不经过3直接到8)推送包含取餐码和退款产品信息,但不两者不一定同时推送,如果第一次部分退款推送其中一种信息,那么后续将推送另一种信息(建议对接方以实际接收到数据处理业务逻辑,接收到取餐码就更新取餐码,接收到退款信息就更新退款信息)当部分退款的商品的金额全部退完之后,订单的状态会转换为 6(订单退款) 的状态。
部分退款订单推送不包含具体商品规格参数,只提供一个规格名称组合(spec)的文本描述,如果需要将退款商品和下单商品规格对应,请调用订单详情并解析refundProducts/productsInfo字段,产生退款的商品规格有具体的退款信息(hasRefund:是否为退款商品、refundAmount:退款金额、refundCount:退款数量)。
"totalRefundAmount ":"总退款金额"为企业退款金额,"totalEpPrice":"企业总成本价",--企业订单总成本,(注:如果有部分退款的订单,总结算价是需要减去订单退款的金额才是最终的结算价,通过totalEpPrice-totalRefundAmount)为才是当前的部分退款订单的结算价。
推送参数示例
{
    "type": 5,
    "data": {
        "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",(uuid形式的订单id),
        "orderType": "1肯德基 2麦当劳 4星巴克 8奈雪的茶 16瑞幸咖啡 32喜茶",
        "orderState": 3,
        "entPara": "自定义参数(可在创建订单接口中传入,这里原样返回)",
        "totalUserPrice": "用户价格",
        "commission": "佣金",
        "orderName": "订单名称",
        "codes": "取餐码,多个用空格分开,如(A3301 A3302)",
        "qrCodes": "点餐生成二维码的值,点餐品牌为瑞幸时,需要生成二维码,多个用空格分开,如(Z2jMdwQ3AAM= Z2jMvwQ3AAM= Z2jM4gQ3AAM=)",
        "refundAmount":"当前退款金额",
        "totalRefundAmount ":"总退款金额",--企业退款金额
        "totalChanelPrice":"总渠道价格",
        "totalEpPrice":"企业总成本价",--企业订单总成本
        "epRefundAmount":"渠道退款总额:",
        "refundId":"退款id",
        "refundProducts":[{"productId":"产品id","quantity":"订单商品数量","selPrice":"销售单价",  "hasRefund": true,"spec":"规格名称组合","refundCount":"退款商品数量(只用于参考,某些情况下值不一定准确)","refundAmount":"退款金额"}],
        "totalOriginPrice":"60(原价总价)",
        "createTime":"2020-09-08 10:20:00(订单创建时间)",
        "updateTime":"2020-09-08 10:20:00 (订单最后更新时间)",
        "courierLocationH5":"https://abc123xyz890.com/courierLocationH5(外卖订单骑手位置H5页面URL)"
        }
}
修改于 2025-03-24 05:03:10
上一页
卡券商品按类别列表(共二级分类)
下一页
城市列表
Built with