客如云 API
  1. 菜品
客如云 API
  • 平台简介
  • 对接流程-API接口对接流程及操作步骤(不上架服务市场)
  • 对接流程-API接口对接流程及操作步骤(上架服务市场)
  • 认证指南-服务商认证
  • 认证指南-品牌商认证
  • 接口能力大图
  • https对接说明
  • 接口请求公共参数
  • 响应参数
  • V2签名规则
  • 订单取消原因表
  • 订单状态
  • 错误码
  • 订单配送状态
  • 订单支付状态表
  • 回调接口编码
  • 支付机构代码
  • 接收菜品分类变更通知
  • 接收菜品变更通知
  • 订单状态推送通知收费
  • 自配送场景介绍
  • 客如云下发配送通知
  • 订单配送状态通知
  • 优惠券核销通知接口-上行
  • 第三方券核销介绍
  • 登录成功回调收费
  • 获取授权码code收费
  • 新手指南
    • 平台简介
    • 对接流程-API接口对接流程及操作步骤(不上架服务市场)
    • 对接流程-API接口对接流程及操作步骤(上架服务市场)
    • 认证指南-服务商认证
    • 认证指南-品牌商认证
  • 接口能力大图
    • 接口能力大图
  • 公共说明
    • https对接说明
    • 接口请求公共参数
    • 响应参数
    • V2签名规则
    • 附录
      • 订单取消原因表
      • 订单状态
      • 错误码
      • 订单配送状态
      • 订单支付状态表
      • 回调接口编码
      • 支付机构代码
    • 获取门店token
  • 接口列表
    • 门店信息
      • 获取服务下可用门店
      • 获取门店列表
      • 获取门店信息
      • 获取门店经营时间
      • 查询门店营业状态
      • 修改门店营业状态
      • 查询桌台信息
      • 附加费配置查询接口
      • 支付类型查询
      • 门店设备列表查询接口
      • 门店设备状态推送接口
    • 菜品
      • 接收菜品分类变更通知
      • 接收菜品变更通知
      • 菜品分类信息查询
        POST
      • 菜品父级信息查询
        POST
      • 菜品分类查询
        POST
      • 菜品分页查询
        POST
      • 菜品精确查询
        POST
      • 批量修改门店菜品售卖数量
        POST
    • 订单信息
      • 订单状态推送通知收费
      • 查询订单详情
      • 查询订单列表
    • 后厨管理服务
      • 后厨菜品制作状态变更推送
    • 配送服务
      • 自配送场景介绍
      • 客如云下发配送通知
      • 订单配送状态通知
      • 商家自配送状态推送
    • 会员1.0
      • 会员基本信息1.0
        • 创建顾客
        • 创建/升级会员
        • 查询会员实体卡列表
        • 会员详情查询
        • 修改会员详情
        • 查询品牌下会员等级
        • 修改会员等级信息
      • 会员登录1.0
        • 会员登录
        • 会员登录二维码
        • 获取免登录token
      • 会员充值1.0
        • 会员充值接口
        • 查询门店储值消费金额
        • 会员充值/消费记录查询
      • 积分 1.0
        • 会员积分增加
        • 会员积分扣减
    • 优惠券1.0
      • 优惠券核销通知接口-上行
      • 查询优惠券列表
      • 查询券模板列表
      • 查询优惠券详情
      • 查询门店营销规则
      • 券模板发券接口
      • 客如云券核销
    • 第三方券核销
      • 第三方券核销介绍
      • 券查询
      • 券核销
      • 券反核销
    • 供应链1.0
      • 供应链基础数据1.0
        • 查询供应链物品接口
        • 查询仓库列表
        • 查询物品分类
        • 查询供应链物品库存
        • 查询商品库存收费
        • 接收商品库存变更
        • 查询供应商类别
        • 查询供应商列表
        • 查询交易记录
        • 获取交易凭证
        • 查询商户余额
      • 采购单据1.0
        • 查询采购入库单列表
        • 查询采购订单收费
        • 查询采购入库单明细
        • 查询采购退货单明细
        • 采购退货单列表收费
      • 销售单据1.0
        • 查询非销售单出库明细收费
      • 库存单据1.0
        • 入库单保存
        • 入库详情查询
        • 入库分页查询
        • 收货单详情
        • 收货单分页查询
        • 调拨单详情查询
        • 调拨单分页查询
        • 出库单保存
        • 出库详情查询
        • 出库分页查询
        • 配送签收单修改保存
        • 查询配送签收单详情
        • 配送签收单分页查询
        • 退回单详情查询
        • 退回单分页查询
        • 退回入库单分页查询
        • 退回入库单详情查询
        • 盘点单详情查询
        • 盘点单分页查询
        • 报废单详情查询收费
        • 报废单分页查询
    • 支付收银服务
      • 支付状态查询
      • 扫码支付(主扫)
      • 扫码支付(被扫)
      • 退款状态查询
      • 退款申请
    • OAUTH 授权服务
      • 登录成功回调收费
      • 获取授权码code收费
      • 获取用户信息
      • 获取token
  1. 菜品

菜品精确查询

测试环境
https://gldopenapi.keruyun.com
测试环境
https://gldopenapi.keruyun.com
POST
/open/v1/cater/dish/dishMe

(下行接口)合作方调用此接口,根据门店ID与门店菜ID获取门店菜品信息

响应参数

参数名类型是否必填参数描述
codeint是错误码;0:成功;其他详见错误码
messagestring是错误说明
messageUuidstring是消息uuid
resultobject否返回业务参数 code !=0的情况下不返回业务参数

result

参数名类型是否必填参数描述
shopIdentyLong是门店ID
nameString是菜品名称
aliasNameString否菜品别名
brandDishIdLong是品牌菜ID
idLong是菜品id
dishCodestring是菜品编号
uuidString是菜品UUID
typeint是菜品类型 : 菜品种类 0:单菜 ,1:套餐,2:加料
unitString是菜品单位(如斤,份,杯,盘…)
saleTypeint否销售类型:1:称重销售 ,2:非销售称重
upcString否条码
priceint是菜品价格(原价,基础价),单位:分
rankint否菜品排序,若商户后台未设置,默认是0
minOrderNumDouble是起卖份数,默认1
residueTotalDouble是剩余可售数量, 默认0表示无限量
saleTotalDouble是每日售卖限额,默认0表示无限量
saleTotalWechatDouble是外卖可售数量,默认0表示无限量
boxQtyint是餐盒数量,默认1,商户后台可设置
imgUrlstring是菜品图片,多图使用英文逗号分隔,像素:640x480
descString是菜品描述
categorysList<category>是菜品分类,数组,见下category
saleTimesList<saleTimes>是可售时间,可能为组合时间段,见下saleTimes
attrsList<attr>否菜品属性,如规格,口味做法,备注等,见下attr
supplyCondimentssupplyCondiments是配料,见supplyCondiments
clearStatusInteger是估清 1-在售,2-售罄

菜品分类:category

参数名类型是否必填参数描述
categoryIdLong是菜品分类id
categoryNameString是菜品分类名称
rankint否菜品分类排序

可售时间:saleTimes

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

菜品属性:attr

参数名类型是否必填参数描述
groupIdLong否做法组id
groupNameString否做法组名称
idLong是菜品属性ID
typeint是属性类型(1-口味做法,2-标签,3-备注,4-规格属性等)
nameString是菜品属性
uuidString是菜品属性唯一标识UUID
repriceInt否变价, 单位:分,正数加价,负数减价

配料:supplyCondiments

参数名类型是否必填参数描述
idLong是配料ID
nameString是配料名称
marketPriceLong是加价
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://gldopenapi.keruyun.com/open/v1/cater/dish/dishMe?appKey=&shopIdenty=&brandId=&version=&timestamp=&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 参数

Body 参数application/json

示例

返回响应

🟢200成功
application/json
Body

【如客云】API开发者 微信交流群

用微信扫右侧二维码,加入【如客云】API开发者 交流群,互助沟通

扫码加入交流群
修改于 2021-12-16 06:36:24
上一页
菜品分页查询
下一页
批量修改门店菜品售卖数量
Built with