菜品精确查询
测试环境
https://gldopenapi.keruyun.com
测试环境
https://gldopenapi.keruyun.com
POST
/open/v1/cater/dish/dishMe
(下行接口)合作方调用此接口，根据门店ID与门店菜ID获取门店菜品信息
响应参数
| 参数名 | 类型 | 是否必填 | 参数描述 |
|---|---|---|---|
| code | int | 是 | 错误码；0：成功；其他详见错误码 |
| message | string | 是 | 错误说明 |
| messageUuid | string | 是 | 消息uuid |
| result | object | 否 | 返回业务参数 code !=0的情况下不返回业务参数 |
result
| 参数名 | 类型 | 是否必填 | 参数描述 |
|---|---|---|---|
| shopIdenty | Long | 是 | 门店ID |
| name | String | 是 | 菜品名称 |
| aliasName | String | 否 | 菜品别名 |
| brandDishId | Long | 是 | 品牌菜ID |
| id | Long | 是 | 菜品id |
| dishCode | string | 是 | 菜品编号 |
| uuid | String | 是 | 菜品UUID |
| type | int | 是 | 菜品类型 : 菜品种类 0:单菜 ，1：套餐，2：加料 |
| unit | String | 是 | 菜品单位(如斤,份，杯，盘…) |
| saleType | int | 否 | 销售类型:1：称重销售 ，2:非销售称重 |
| upc | String | 否 | 条码 |
| price | int | 是 | 菜品价格(原价,基础价)，单位：分 |
| rank | int | 否 | 菜品排序，若商户后台未设置，默认是0 |
| minOrderNum | Double | 是 | 起卖份数，默认1 |
| residueTotal | Double | 是 | 剩余可售数量, 默认0表示无限量 |
| saleTotal | Double | 是 | 每日售卖限额,默认0表示无限量 |
| saleTotalWechat | Double | 是 | 外卖可售数量,默认0表示无限量 |
| boxQty | int | 是 | 餐盒数量，默认1，商户后台可设置 |
| imgUrl | string | 是 | 菜品图片，多图使用英文逗号分隔，像素：640x480 |
| desc | String | 是 | 菜品描述 |
| categorys | List<category> | 是 | 菜品分类，数组，见下category |
| saleTimes | List<saleTimes> | 是 | 可售时间，可能为组合时间段，见下saleTimes |
| attrs | List<attr> | 否 | 菜品属性，如规格，口味做法，备注等，见下attr |
| supplyCondiments | supplyCondiments | 是 | 配料，见supplyCondiments |
| clearStatus | Integer | 是 | 估清 1-在售，2-售罄 |
菜品分类：category
| 参数名 | 类型 | 是否必填 | 参数描述 |
|---|---|---|---|
| categoryId | Long | 是 | 菜品分类id |
| categoryName | String | 是 | 菜品分类名称 |
| rank | int | 否 | 菜品分类排序 |
可售时间：saleTimes
| 参数名 | 类型 | 是否必填 | 参数描述 |
|---|---|---|---|
| start | String | 是 | 可售卖开始时间 |
| end | String | 是 | 结束时间 |
菜品属性：attr
| 参数名 | 类型 | 是否必填 | 参数描述 |
|---|---|---|---|
| groupId | Long | 否 | 做法组id |
| groupName | String | 否 | 做法组名称 |
| id | Long | 是 | 菜品属性ID |
| type | int | 是 | 属性类型(1-口味做法，2-标签，3-备注，4-规格属性等) |
| name | String | 是 | 菜品属性 |
| uuid | String | 是 | 菜品属性唯一标识UUID |
| reprice | Int | 否 | 变价, 单位：分，正数加价，负数减价 |
配料：supplyCondiments
| 参数名 | 类型 | 是否必填 | 参数描述 |
|---|---|---|---|
| id | Long | 是 | 配料ID |
| name | String | 是 | 配料名称 |
| marketPrice | Long | 是 | 加价 |
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://gldopenapi.keruyun.com/open/v1/cater/dish/dishMe?appKey=&shopIdenty=&brandId=&version=×tamp=&sign=' \
--header 'Content-Type: application/json' \
--data-raw '{
"shopIdenty":247900001,
"ids":[266582035542376448,248921597135188992]
}'响应示例响应示例
{
"result": [
{
"shopIdenty": 810094162,
"name": "a单规格套餐",
"aliasName": "",
"id": 344855050821482500,
"dishCode": "SKU1456",
"uuid": "632d0ab81d284d7a8a28baa3d7b6d893",
"type": 1,
"unit": "套",
"unitId": 305716374740448260,
"saleType": 2,
"upc": null,
"clearStatus": 1,
"price": 12311,
"rank": 0,
"minOrderNum": 1,
"residueTotal": 1000,
"saleTotal": 1000,
"boxQty": 1,
"imgUrl": "https://img-static.keruyun.com/kry-dir/rc-upload-1586414383543-89.jpg?x-oss-process=image/resize,w_640,h_480,https://img-static.keruyun.com/kry-dir/rc-upload-1586414383543-93.jpg?x-oss-process=image/resize,w_640,h_480,https://img-static.keruyun.com/kry-dir/rc-upload-1586414383543-95.jpg?x-oss-process=image/resize,w_640,h_480",
"desc": "a单规格套餐",
"categorys": [
{
"categoryId": 344558134170671100,
"categoryName": "单规格套餐"
}
],
"saleTimes": [
{
"start": "00:00:00",
"end": "00:00:00"
}
],
"attrs": [
{
"id": 236114201746463740,
"groupId": null,
"groupName": null,
"type": 2,
"name": "TOP",
"uuid": "f3d5b59e4ad241c2997ed821f767d2dd",
"reprice": 0
}
],
"dishTaxes": null,
"brandDishId": 344855050762762240,
"barcode": null,
"supplyCondiments": null,
"saleTotalWechat": 1000,
"dishQty": null,
"brandDishUuid": "b10e05acd4c4423d8e87da734009fd2b"
}
],
"code": 0,
"message": "成功[OK]",
"messageUuid": "433abbd6253a4a319e65125ed7c74933",
"apiMessage": null
}请求参数
Query 参数
appKey
string
必需
默认值:
{{appKey}}
shopIdenty
string
必需
默认值:
{{shopIdenty}}
brandId
string
必需
默认值:
{{brandId}}
version
string
必需
默认值:
2.0
timestamp
string
必需
默认值:
{{timestamp}}
sign
string
必需
默认值:
{{sign}}
Body 参数application/json
返回响应
扫码加入交流群