客如云开放平台

菜品分页查询收费

(下行接口)第三方合作方调用此接口，可根据分页信息获取门店菜品信息

授权方式：门店授权

请求描述

HTTP请求方式：POST
HTTP请求头类型：Content-Type=application/json
URI:   /open/v1/cater/dish/dishMenu

请求参数

1.公共参数

详情可查看【公共说明】中的公共参数模块

2.业务参数

参数名	类型	是否必填	参数描述
shopIdenty	Long	是	客如云门店ID
startId	Long	否	开始记录ID(默认1),下一页需带上返回参数中startId的值，返回参数中startId为null表示无下一页
pageNum	Long	是	每页最大记录数(默认1000)

业务示例（JSON）

{
   "shopIdenty":247900001,
   "startId":1,
   "pageNum":1000
}

响应参数

参数名	类型	是否必填	参数描述
code	Int	是	错误码；0：成功；其他详见错误码
message	String	是	错误说明
messageUuid	String	是	消息uuid
result	OpenDishResultVO	否	返回业务参数 code !=0的情况下不返回业务参数

OpenDishResultVO

参数名	类型	是否必填	参数描述
hasnext	Boolean	是	是否还有下一条数据
startId	Long	是	返回最后一条的记录ID,为null表示无下一页，否则请求下一页时，入参startId需带上此ID
dishTOList	List<DishTO>	否	菜品别名

DishTO

参数名	类型	是否必填	参数描述
shopIdenty	Long	是	商户ID
name	String	是	菜品名称
aliasName	String	否	菜品别名
brandDishId	Long	是	品牌菜ID
id	Long	是	菜品id
dishCode	String	是	菜品编号
uuid	String	是	菜品UUID
type	Int	是	菜品类型： 0:单菜, 1:套餐
unit	String	是	菜品单位(如斤,份，杯，盘…)
saleType	Int	否	销售类型: 1：称重销售，2:非称重销售
upc	String	否	条码
price	Int	是	菜品价格(原价,基础价)，单位：分
shopSellPrice	Int	否	门店售价，单位：分
rank	Int	否	菜品排序，若商户后台未设置，默认未0
minOrderNum	Double	是	起卖份数，默认1
residueTotal	Double	是	剩余可售数量, 默认0表示无限量
saleTotal	Double	是	每日售卖限额,默认0表示无限量
boxQty	Int	是	餐盒数量，默认1
imgUrl	String	是	菜品图片，多图使用英文逗号分隔，像素：640x480
desc	String	是	菜品描述
categorys	List<category>	是	菜品分类，数组，见下category
saleTimes	List<saleTimes>	是	可售时间，可能为组合时间段，见下saleTimes
attrs	List<attr>	否	菜品属性，如规格，口味做法，备注等，见下attr
supplyCondiments	List<SupplyCondiments>	是	配料，见SupplyCondiments

菜品分类：category

参数名	类型	是否必填	参数描述
categoryId	Long	是	菜品分类id
categoryName	String	是	菜品分类名称
rank	Int	否	菜品分类排序

可售时间：saleTimes

参数名	类型	是否必填	参数描述
start	String	是	可售卖开始时间
end	String	是	结束时间

菜品属性：attr

参数名	类型	是否必填	参数描述
id	Long	是	菜品属性ID
type	Int	是	属性类型(1-口味做法，2-标签，3-备注，4-规格属性等)
name	String	是	菜品属性
uuid	String	是	菜品属性唯一标识UUID
reprice	Int	否	变价, 单位：分，正数加价，负数减价，若属性为做法，此字段一定返回

配料：SupplyCondiments

参数名	类型	是否必填	参数描述
id	Long	是	配料ID
name	String	是	配料名称
marketPrice	Long	是	加价

响应示例（JSON）

{
    "result":{
        "hasnext":false,
        "dishTOList":[
            {
                "shopIdenty":810094162,
                "name":"水煮牛肉",
                "aliasName":"",
                "brandDishId": 357218442118404096,
                "id":37931285196334080,
                "dishCode":"SKU0001",
                "uuid":"9cee13b0569f4a8d93fa8fee3b31d24c",
                "type":0,
                "unit":"份",
                "saleType":2,
                "upc":"",
                "clearStatus":1,
                "price":3000,
                "rank":1000,
                "minOrderNum":1,
                "residueTotal":1000,
                "saleTotal":1000,
                "boxQty":1,
                "imgUrl":null,
                "desc":"",
                "categorys":[
                    {
                        "categoryId":"37931006707131392",
                        "categoryName":"牛肉"
                    }
                ],
                "saleTimes":[
                    {
                        "start":"00:00:00",
                        "end":"00:00:00"
                    }
                ],
                "attrs":[
                    {
                        "id":"37930362206184448",
                        "type":4,
                        "name":"大份",
                        "uuid":"40e57c5f93814184beab086fb6832498",
                        "reprice":0
                    }
                ],
                "supplyCondiments":[
                    {
                        "id":"37930071142458368",
                        "name":"天山冰泉水",
                        "marketPrice":1000
                    }
                ]
            },
            {
                "shopIdenty":810094162,
                "name":"鱼香肉丝",
                "aliasName":"",
                "id":"50209127660493824",
                "dishCode":"009",
                "uuid":"f82950b011f2464ab56d5f1124eac0e0",
                "type":0,
                "unit":"份",
                "saleType":2,
                "upc":"",
                "clearStatus":1,
                "price":1500,
                "rank":1000,
                "minOrderNum":1,
                "residueTotal":1000,
                "saleTotal":1000,
                "boxQty":1,
                "imgUrl":null,
                "desc":"",
                "categorys":[
                    {
                        "categoryId":"37931006707131392",
                        "categoryName":"牛肉"
                    }
                ],
                "saleTimes":[
                    {
                        "start":"00:00:00",
                        "end":"00:00:00"
                    }
                ],
                "attrs":[

                ],
                "supplyCondiments":null
            },
            {
                "shopIdenty":810094162,
                "name":"炒豆芽",
                "aliasName":"",
                "id":"50209587146497024",
                "dishCode":"456",
                "uuid":"a41a70fc00dc4afca56b61b0368e8732",
                "type":0,
                "unit":"份",
                "saleType":2,
                "upc":"",
                "clearStatus":1,
                "price":999,
                "rank":1000,
                "minOrderNum":1,
                "residueTotal":1000,
                "saleTotal":1000,
                "boxQty":1,
                "imgUrl":null,
                "desc":"",
                "categorys":[
                    {
                        "categoryId":"37931006707131392",
                        "categoryName":"牛肉"
                    }
                ],
                "saleTimes":[
                    {
                        "start":"00:00:00",
                        "end":"00:00:00"
                    }
                ],
                "attrs":[

                ],
                "supplyCondiments":null
            }
        ],
        "startId":null
    },
    "code":0,
    "message":"成功[OK]",
    "messageUuid":"8b7ac33e52c3471d91ae518e0291adae",
    "apiMessage":null
}