请求描述
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时推送对应数据 |
timestamp | Timestamp | 是 | 当前请求毫秒时间戳 |
shopId | String | 是 | 门店ID |
Method
请求方法 | 参数描述 |
---|---|
menuUpdate | menuUpdate为菜单更新,用于实现智能菜单, (成功收到盒司令广播则推送一次) |
sellOutUpdate | sellOutUpdate为菜品沽清时更新,用于实现智能沽清, 当有商品沽清或撤销沽清是,仅推送沽清的商品列表 |
orderUpdate | orderUpdate为订单更新,用于实现点单详情 |
AppInfo
参数名 | 类型 | 是否必填 | 参数描述 |
---|---|---|---|
pkg | String | 否 | 第三方应用包名 |
name | String | 否 | 第三方应用名称 |
softVersion | String | 是 | 第三方软件版本号 |
Menu
参数名 | 是否必须 | 类型 | 说明 |
menu | 是 | ArrayList | 菜品信息 |
| 是 | String | 分类编号 |
| 是 | String | 分类名称(例如奶茶、果茶) |
| 是 | String | 菜品KEY, 应该为品牌下全门店相同商品公用的KEY |
| 是 | String | 菜品图片 |
| 是 | String | 菜品名称 |
| 是 | Bool | true为推荐或者必点菜品,默认为false(标识特定商品,加上特殊提示图标) |
| 是 | ArrayList | 菜品规格 |
| 是 | int | 此规格的菜品是否剩余:售罄:0;未售罄:100 |
| 是 | int | 原价,默认为0, 单位分 |
| 是 | int | 会员价,默认为0, 单位分 |
| 是 | int | 菜单实际显示价格,默认为0, 单位分 |
| 是 | String | 菜品规格,如大杯、中杯 |
| 否 | String | 规格KEY |
Order
参数名 | 是否必须 | 类型 | 说明 |
order | 是 | ArrayList | 菜品信息 |
| 是 | int | 原始总价格,默认为0, 单位分 |
| 是 | int | 已优惠价格,默认为0, 单位分 |
| 是 | int | 其他优惠价格,默认为0, 单位分 |
| 是 | int | 客人实际支付价格 realAmount = foodAmount- (promotionAmount + paidAmount), 单位分 |
| 是 | Array | 订单商品信息 |
| 是 | String | 菜品KEY, 应该为品牌下全门店相同商品公用的KEY |
| 是 | String | 菜品名称 |
| 是 | int | 点菜数量,默认为0, 单位分 |
| 是 | int | 商品原价,默认为0, 单位分,默认为0, 单位分 |
| 是 | int | 商品会员价 |
| 是 | int | 商品实际支付价格,默认为0, 单位分 |
| 是 | int | 菜品成交价和(商品实际支付价格 * 计价菜品数量),默认为0, 单位分 |
| 是 | String | 菜品备注,例如:(3分糖)(温热)(去冰) |
| 是 | String | 点单菜品规格,如大杯、中杯 |
| 是 | int | 是否配菜 {0:饮品,1:加料},此处是作为是饮品还是加料的依据,饮品为0,加料为1 |
响应参数
参数名 | 参数类型 | 是否必填 | 参数描述 |
---|---|---|---|
code | int | 是 | 错误码;200: 成功; 500: 失败; 404: 请求失败; |
rst | String | 是 | 说明 |