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

正在查看旧版本。 查看 当前版本.

与当前比较 查看页面历史记录

« 前一个 版本 9 当前 »

请求地址

http://ip:port/kds


参数名 

参数描述

IP 

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


请求参数


参数名

类型

是否必填

参数描述

method

String

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

appInfo

List

请求的应用信息

version

String

对接的接口版本,默认3.0

order

ArrayList

method为orderUpdate时推送对应数据

timestampTimestamp

当前请求毫秒时间戳

shopIdString门店ID


Method

请求方法 

参数描述

orderUpdate

orderUpdate为订单更新,用于实现KDS叫号(推送时机:成功接受到盒司令的广播 或者 订单更新时)


AppInfo

参数名

类型

是否必填

参数描述

pkg

String

第三方应用包名

name

String

第三方应用名称

softVersion

String

第三方软件版本号


Order

参数名是否必须类型说明

updatedAt

Timestamp订单最近一次操作时间戳(叫号、完成等动作时)
orderArrayList菜品信息
  • order.foodAmount

int

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

  • order.promotionAmount

int

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

  • order.paidAmount

int

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

  • order.realAmount

int

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

  • order.channel

int

订单的渠道类型,1:堂食、2:小程序、3:美团、4:饿了么、5:公众号点单。(其他渠道请先联系盒司令)
  • order.pickupCode
String取餐号
  • order.status
int订单状态,0 备餐中,1 请取餐
  • order.food
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

说明

  • 无标签