页面树结构
Skip to end of metadata
Go to start of metadata

请求描述

HTTP请求方式:POST

HTTP请求头类型:Content-Type=application/json


请求地址

http://ip:port/allfood


参数名 

参数描述

IP 

盒司令广播到第三方的IP地址
port固定为41210


请求参数


参数名

类型

是否必填

参数描述

method

String

请求方法,详情见下方Method对应解释

appInfo

List

请求的应用信息

version

String

对接的接口版本,默认3.0

menu

ArrayList

method为menuUpdate或sellOutUpdate时推送对应数据

order

ArrayList

method为orderUpdate时推送对应数据

timestampTimestamp

当前请求毫秒时间戳

shopIdString门店ID


Method

请求方法 

参数描述

menuUpdate 

menuUpdate为菜单更新,用于实现智能菜单, (成功收到盒司令广播则推送一次)

sellOutUpdate

sellOutUpdate为菜品沽清时更新,用于实现智能沽清, 当有商品沽清或撤销沽清是,仅推送沽清的商品列表

orderUpdate

orderUpdate为订单更新,用于实现点单详情


AppInfo

参数名

类型

是否必填

参数描述

pkg

String

第三方应用包名

name

String

第三方应用名称

softVersion

String

第三方软件版本号


Menu

参数名是否必须类型说明
menuArrayList菜品信息
  • menu.foodCategoryCode
String

分类编号

  • menu.foodCategoryName
String

分类名称(例如奶茶、果茶)

  • menu.foodKey
String菜品KEY, 应该为品牌下全门店相同商品公用的KEY
  • menu.foodImage
String菜品图片
  • menu.foodName
String菜品名称
  • menu.isRecommend
Bool

true为推荐或者必点菜品,默认为false(标识特定商品,加上特殊提示图标)

  • menu.units
ArrayList菜品规格
    • menu.units.localValue

int

此规格的菜品是否剩余:售罄:0;未售罄:100

    • menu.units.originalPrice
int原价,默认为0, 单位分
    • menu.units.vipPrice
int会员价,默认为0, 单位分
    • menu.units.price
int菜单实际显示价格,默认为0, 单位分
    • menu.units.unit
String菜品规格,如大杯、中杯
    • menu.units.unitKey
String规格KEY





Order

参数名是否必须类型说明
orderArrayList菜品信息
  • order.foodAmount

int

原始总价格,默认为0, 单位分

  • order.promotionAmount

int

已优惠价格,默认为0, 单位分

  • order.paidAmount

int

其他优惠价格,默认为0, 单位分

  • order.realAmount

int

客人实际支付价格 realAmount = foodAmount- (promotionAmount + paidAmount), 单位分

  • order.orderData
Array订单商品信息
    • order.food.foodKey
String菜品KEY, 应该为品牌下全门店相同商品公用的KEY
    • order.food.foodName
String

菜品名称

    • order.food.foodNumber

int

点菜数量,默认为0, 单位分

    • order.food.originalPrice
int商品原价,默认为0, 单位分,默认为0, 单位分
    • order.food.vipPrice
int商品会员价
    • order.food.realPrice
int商品实际支付价格,默认为0, 单位分
    • order.food.realPriceTotal
int

菜品成交价和(商品实际支付价格 * 计价菜品数量),默认为0, 单位分

    • order.food.remark
String

菜品备注,例如:(3分糖)(温热)(去冰)

    • order.food.unit
String点单菜品规格,如大杯、中杯
    • order.food.isBatching
int

是否配菜 {0:饮品,1:加料},此处是作为是饮品还是加料的依据,饮品为0,加料为1


响应参数

参数名

参数类型

是否必填

参数描述

code

int

错误码;200: 成功; 500: 失败; 404: 请求失败;

rst

String

说明

  • 无标签