koubei.merchant.kbdevice.dispenser.query(取餐柜所有单元格详情查询) 在线调试(沙箱环境)

智慧餐厅取餐柜场景下,查询门店指定取餐柜所有格子明细数据

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 koubei.merchant.kbdevice.dispenser.query
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
device_id String 必选 64 取餐柜的唯一设备ID 4b95bfc4c3ca6f41b4e7a57d39984cb6150

响应参数

参数 类型 是否必填 最大长度 描述 示例值
device_id String 必填 64 取餐柜的唯一设备ID 4b95bfc4c3ca6f41b4e7a57d39984cb6150
availability Boolean 必填 10 取餐柜设备是否可用 true
cell_info_list FoodDispenserCellInfo 选填 取餐柜的单元格详情列表
cell_code String 必填 32 单元格编号 1
cell_name String 必填 32 单元格名称 A1
biz_status String 必填 32 业务状态
空闲:IDLE
预占:FREEZE
占用:OCCUPIED
IDLE
column_no String 必填 32 列数 2
row_no String 必填 32 行数 1

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
KoubeiMerchantKbdeviceDispenserQueryRequest request = new KoubeiMerchantKbdeviceDispenserQueryRequest();
request.setBizContent("{" +
"\"device_id\":\"4b95bfc4c3ca6f41b4e7a57d39984cb6150\"" +
"  }");
KoubeiMerchantKbdeviceDispenserQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "koubei_merchant_kbdevice_dispenser_query_response": {
        "code": "10000",
        "msg": "Success",
        "device_id": "4b95bfc4c3ca6f41b4e7a57d39984cb6150",
        "availability": true,
        "cell_info_list": [
            {
                "cell_code": "1",
                "cell_name": "A1",
                "biz_status": "IDLE",
                "column_no": "2",
                "row_no": "1"
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "koubei_merchant_kbdevice_dispenser_query_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
SYSTEM_ERROR 系统繁忙 系统异常,需要重试
NO_DEVICE_FOUND 没有查到当前设备 传入设备ID查不到相关数据,请确认对应设备已经存在
ILLEGAL_ARGUMENTS 参数有误,请结合文档检查入参
onlineServer