koubei.merchant.kbdevice.devices.batchquery(查询门店下设备列表) 在线调试(沙箱环境)

查询门店下设备列表

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 koubei.merchant.kbdevice.devices.batchquery
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 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
shop_id String 必选 64 门店ID 2018100900077000000022728611
device_type String 可选 64 需要筛选的设备类型。目前只支持取餐柜(FOOD_DISPENSER)类型的设备查询,必须填写FOOD_DISPENSER FOOD_DISPENSER

响应参数

参数 类型 是否必填 最大长度 描述 示例值
device_info_list DeviceInfo 必填 门店下设备列表
device_id String 必填 64 设备ID 4b95bfc4c3ca6f41b4e7a57d39984cb6150
device_type String 必填 32 设备类型 FOOD_DISPENSER
dv_sn String 必填 64 设备sn编号 3ffde95c5efe170d3be02877d24a5dc0110
manufacturer String 必填 64 生产厂商 PINYUAN
product_model String 必填 64 产品型号 D2

请求示例

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

响应示例

{
    "koubei_merchant_kbdevice_devices_batchquery_response": {
        "code": "10000",
        "msg": "Success",
        "device_info_list": [
            {
                "device_id": "4b95bfc4c3ca6f41b4e7a57d39984cb6150",
                "device_type": "FOOD_DISPENSER",
                "dv_sn": "3ffde95c5efe170d3be02877d24a5dc0110",
                "manufacturer": "PINYUAN",
                "product_model": "D2"
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
SYSTEM_ERROR 系统繁忙 系统异常,需要重试
ILLEGAL_ARGUMENTS 参数有误 参数有误,请结合文档检查入参
onlineServer