查询桌台信息 - 客如云 API

(下行接口)合作方调用该接口可查询客如云商户后台所有的或指定的桌台信息

curl --location --request POST 'https://gldopenapi.keruyun.com/open/v1/table/fetchTables?appKey=&shopIdenty=&brandId=&version=&timestamp=&sign=' \ --header 'Content-Type: application/json' \ --data-raw '{ "enabledTS": "true", "enabledWM": "true" }'

{ "result": [ { "tableID": "201725075570586624", "tableNum": "105001", "tableName": "桌台1", "commercialId": 810094162, "tableType": 1, "tableArea": { "areaCode": "105", "areaName": "包厢区", "id": 201724816828167170, "floor": 3 }, "tablePersonCount": 18, "minConsum": 0, "canBooking": 0, "isSmoke": null, "floorId": null, "sort": 1000, "status": 0, "tableStatus": 0, "memo": null, "modifyDateTime": 1567059254000, "synFlag": "c054642f60a94183b3bf638eb8ead775" }, { "tableID": "201725075918713856", "tableNum": "105002", "tableName": "桌台2", "commercialId": 810094162, "tableType": 1, "tableArea": { "areaCode": "105", "areaName": "包厢区", "id": 201724816828167170, "floor": 3 }, "tablePersonCount": 18, "minConsum": 0, "canBooking": 0, "isSmoke": null, "floorId": null, "sort": 1000, "status": 0, "tableStatus": 0, "memo": null, "modifyDateTime": 1567059254000, "synFlag": "5873f300be484368ab01045f5a6fb562" } ], "code": 0, "message": "成功[OK]", "messageUuid": "cfd7d95cf5e94f03b94fe36083cd935c", "apiMessage": null }

请求参数

Query 参数

appKey

string

必需

开发者申请服务客如云分配的appKey

默认值:

shopIdenty

string

必需

客如云门店id （门店维度接口传递门店ID）

默认值:

brandId

string

必需

客如云品牌id（品牌授权的接口传递品牌ID）

默认值:

version

string

必需

版本,默认2.0（1.0版本仍可用）

默认值:

2.0

timestamp

string

必需

时间戳,单位:秒,时间戳校验签名,开放平台校验签名时用此参数和服务器当前时间戳对比不能大于300秒，我方服务器使用阿里云授时中心

默认值:

sign

string

必需

签名，64位长度的字符串，获取规则详见签名规则

默认值:

Body 参数application/json

ids

array[integer]

必需

桌台ID；不传值时默认查询已有的所有桌台

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码；0：成功；其他详见错误码

message

string

错误说明

必需

messageUuid

string

消息uuid

必需

result

array[object (OpenTableInfoVo) {17}]

可选

返回响应数据，json对象或数组，可空

tableID

string

桌台ID

可选

tableNum

string

桌台编号

可选

tableName

string

可选

桌台名称，同一区域不可重复

commercialId

integer

门店号ID

可选

tableType

integer

可选

桌台类型,0: 大厅,1: 包厢,2: 卡座,3: 露台,4: 其他

tableArea

object (Area)

区域信息

可选

tablePersonCount

integer

桌台人数

可选

minConsum

integer

可选

最低消费金额，单位：元

canBooking

integer

可选

是否可预定，0.可预订，1.不可预订

isSmoke

integer

可选

是否是吸烟区0,吸烟,1,不吸烟

floorId

integer

楼层ID

可选

sort

integer

排序

可选

status

integer

可选

桌台状态；0：可用，-1：不可用，1：未生效

tableStatus

integer

可选

桌台的状态,0空闲，1就餐，2待清台,3锁定中

memo

string

备注

可选

modifyDateTime

integer

更新时间

可选

synFlag

string

桌台uuid

必需