客如云 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/categoryAll
(下行接口)合作方调用此接口,根据菜品分类id获取菜品列表
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://gldopenapi.keruyun.com/open/v1/cater/dish/categoryAll?appKey=&shopIdenty=&brandId=&version=&timestamp=&sign=' \
--header 'Content-Type: application/json' \
--data-raw '{
   "dishTypeId":261813213542561792
}'
响应示例响应示例
{
  "result": {
    "dishList": [
      {
        "aliasName": "",
        "boxQty": 1,
        "brandDishId": 344855050762762240,
        "clearStatus": 1,
        "currRemainTotal": null,
        "dishDesc": "a单规格套餐",
        "dishIncreaseUnit": 1,
        "dishQty": 1,
        "dishTypeId": 344558134170671100,
        "productId": null,
        "id": 344855050821482500,
        "marketPrice": 123.11,
        "name": "a单规格套餐",
        "residueTotal": 1000,
        "residueTotalWechat": 1000,
        "richDesc": null,
        "uuid": "632d0ab81d284d7a8a28baa3d7b6d893",
        "saleTotal": 1000,
        "saleTotalWechat": 1000,
        "saleType": 2,
        "stepNum": 1,
        "type": 1,
        "unitId": 305716374740448260,
        "unitName": "套",
        "videoUrl": "",
        "dishSetmealGroups": [
          {
            "dishSetmealGroupChildInfos": [
              {
                "boxQty": 1,
                "brandDishId": 344853255009253400,
                "clearStatus": 1,
                "dishQty": 1,
                "id": 344853255109916700,
                "isDefault": 2,
                "isMulti": 1,
                "isReplace": 2,
                "leastCellNum": 120,
                "marketPrice": 4,
                "name": "b单规格有起卖份数-称重",
                "residueTotal": 1000,
                "residueTotalWechat": 1000,
                "saleTotal": 1000,
                "saleTotalWechat": 1000,
                "saleType": 2,
                "sort": 0,
                "unitName": "套",
                "dishIngredientInfoVo": null,
                "dishPropertyTypeInfos": [],
                "imageUrls": null,
                "price": 0
              },
              {
                "boxQty": 1,
                "brandDishId": 344853255009253400,
                "clearStatus": 1,
                "dishQty": 1,
                "id": 344853255109916700,
                "isDefault": 2,
                "isMulti": 1,
                "isReplace": 1,
                "leastCellNum": 0.11,
                "marketPrice": 2,
                "name": "b单规格有菜品图片",
                "residueTotal": 1000,
                "residueTotalWechat": 1000,
                "saleTotal": 1000,
                "saleTotalWechat": 1000,
                "saleType": 2,
                "sort": 0,
                "unitName": "套",
                "dishIngredientInfoVo": null,
                "dishPropertyTypeInfos": [],
                "imageUrls": null,
                "price": 0
              },
              {
                "boxQty": 1,
                "brandDishId": 344853255009253400,
                "clearStatus": 1,
                "dishQty": 1,
                "id": 344853255109916700,
                "isDefault": 2,
                "isMulti": 1,
                "isReplace": 1,
                "leastCellNum": 14,
                "marketPrice": 5,
                "name": "b单规格有菜品描述",
                "residueTotal": 1000,
                "residueTotalWechat": 1000,
                "saleTotal": 1000,
                "saleTotalWechat": 1000,
                "saleType": 2,
                "sort": 0,
                "unitName": "套",
                "dishIngredientInfoVo": null,
                "dishPropertyTypeInfos": [],
                "imageUrls": null,
                "price": 0
              },
              {
                "boxQty": 1,
                "brandDishId": 344853255009253400,
                "clearStatus": 1,
                "dishQty": 1,
                "id": 344853255109916700,
                "isDefault": 2,
                "isMulti": 1,
                "isReplace": 2,
                "leastCellNum": 120,
                "marketPrice": 3.51,
                "name": "b单规格有起卖份数-非称重",
                "residueTotal": 1000,
                "residueTotalWechat": 1000,
                "saleTotal": 1000,
                "saleTotalWechat": 1000,
                "saleType": 2,
                "sort": 0,
                "unitName": "套",
                "dishIngredientInfoVo": null,
                "dishPropertyTypeInfos": [],
                "imageUrls": null,
                "price": 0
              },
              {
                "boxQty": 1,
                "brandDishId": 344853255009253400,
                "clearStatus": 1,
                "dishQty": 1,
                "id": 344853255109916700,
                "isDefault": 2,
                "isMulti": 1,
                "isReplace": 2,
                "leastCellNum": 120,
                "marketPrice": 1,
                "name": "b单规格商品",
                "residueTotal": 1000,
                "residueTotalWechat": 1000,
                "saleTotal": 1000,
                "saleTotalWechat": 1000,
                "saleType": 2,
                "sort": 0,
                "unitName": "套",
                "dishIngredientInfoVo": null,
                "dishPropertyTypeInfos": [],
                "imageUrls": null,
                "price": 0
              }
            ],
            "id": 344855050905368600,
            "name": "1",
            "orderMax": 15,
            "orderMin": 0,
            "sort": 0
          },
          {
            "dishSetmealGroupChildInfos": [
              {
                "boxQty": 1,
                "brandDishId": 344853255009253400,
                "clearStatus": 1,
                "dishQty": 1,
                "id": 344853255109916700,
                "isDefault": 2,
                "isMulti": 1,
                "isReplace": 1,
                "leastCellNum": 1,
                "marketPrice": 4,
                "name": "b单规格有起卖份数-称重",
                "residueTotal": 1000,
                "residueTotalWechat": 1000,
                "saleTotal": 1000,
                "saleTotalWechat": 1000,
                "saleType": 2,
                "sort": 0,
                "unitName": "套",
                "dishIngredientInfoVo": null,
                "dishPropertyTypeInfos": [],
                "imageUrls": null,
                "price": 0
              },
              {
                "boxQty": 1,
                "brandDishId": 344853255009253400,
                "clearStatus": 1,
                "dishQty": 1,
                "id": 344853255109916700,
                "isDefault": 2,
                "isMulti": 1,
                "isReplace": 2,
                "leastCellNum": 1,
                "marketPrice": 2,
                "name": "b单规格有菜品图片",
                "residueTotal": 1000,
                "residueTotalWechat": 1000,
                "saleTotal": 1000,
                "saleTotalWechat": 1000,
                "saleType": 2,
                "sort": 0,
                "unitName": "套",
                "dishIngredientInfoVo": null,
                "dishPropertyTypeInfos": [],
                "imageUrls": null,
                "price": 0
              },
              {
                "boxQty": 1,
                "brandDishId": 344853255009253400,
                "clearStatus": 1,
                "dishQty": 1,
                "id": 344853255109916700,
                "isDefault": 2,
                "isMulti": 1,
                "isReplace": 2,
                "leastCellNum": 1,
                "marketPrice": 5,
                "name": "b单规格有菜品描述",
                "residueTotal": 1000,
                "residueTotalWechat": 1000,
                "saleTotal": 1000,
                "saleTotalWechat": 1000,
                "saleType": 2,
                "sort": 0,
                "unitName": "套",
                "dishIngredientInfoVo": null,
                "dishPropertyTypeInfos": [],
                "imageUrls": null,
                "price": 0
              },
              {
                "boxQty": 1,
                "brandDishId": 344853255009253400,
                "clearStatus": 1,
                "dishQty": 1,
                "id": 344853255109916700,
                "isDefault": 2,
                "isMulti": 1,
                "isReplace": 2,
                "leastCellNum": 1,
                "marketPrice": 3.51,
                "name": "b单规格有起卖份数-非称重",
                "residueTotal": 1000,
                "residueTotalWechat": 1000,
                "saleTotal": 1000,
                "saleTotalWechat": 1000,
                "saleType": 2,
                "sort": 0,
                "unitName": "套",
                "dishIngredientInfoVo": null,
                "dishPropertyTypeInfos": [],
                "imageUrls": null,
                "price": 0
              },
              {
                "boxQty": 1,
                "brandDishId": 344853255009253400,
                "clearStatus": 1,
                "dishQty": 1,
                "id": 344853255109916700,
                "isDefault": 2,
                "isMulti": 1,
                "isReplace": 2,
                "leastCellNum": 1,
                "marketPrice": 1,
                "name": "b单规格商品",
                "residueTotal": 1000,
                "residueTotalWechat": 1000,
                "saleTotal": 1000,
                "saleTotalWechat": 1000,
                "saleType": 2,
                "sort": 0,
                "unitName": "套",
                "dishIngredientInfoVo": null,
                "dishPropertyTypeInfos": [],
                "imageUrls": null,
                "price": 0
              }
            ],
            "id": 344855050905368600,
            "name": "2",
            "orderMax": 1,
            "orderMin": 0,
            "sort": 1
          }
        ],
        "dishIngredientInfoVo": null,
        "dishPropertyTypeInfos": [],
        "largeImgList": [
          "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"
        ],
        "smallImgUrls": [
          "https://img-static.keruyun.com/kry-dir/rc-upload-1586414383543-89.jpg?x-oss-process=image/resize,w_180,h_135",
          "https://img-static.keruyun.com/kry-dir/rc-upload-1586414383543-93.jpg?x-oss-process=image/resize,w_180,h_135",
          "https://img-static.keruyun.com/kry-dir/rc-upload-1586414383543-95.jpg?x-oss-process=image/resize,w_180,h_135"
        ],
        "enabledFlag": 1,
        "statusFlag": 1,
        "guaranteeDate": null,
        "guaranteeDateType": null,
        "dishCode": "SKU1456"
      },
      {
        "aliasName": "",
        "boxQty": 1,
        "brandDishId": 355728750365288450,
        "clearStatus": 1,
        "currRemainTotal": null,
        "dishDesc": "",
        "dishIncreaseUnit": 1,
        "dishQty": 1,
        "dishTypeId": 344558134170671100,
        "productId": null,
        "id": 355728792601929700,
        "marketPrice": 20,
        "name": "烧鹅套餐",
        "residueTotal": 1000,
        "residueTotalWechat": 1000,
        "richDesc": null,
        "uuid": "e3021a521ac74d008a9757d01b73bc6c",
        "saleTotal": 1000,
        "saleTotalWechat": 1000,
        "saleType": 2,
        "stepNum": 1,
        "type": 1,
        "unitId": 37930747935351810,
        "unitName": "份",
        "videoUrl": "",
        "dishSetmealGroups": [
          {
            "dishSetmealGroupChildInfos": [
              {
                "boxQty": 1,
                "brandDishId": 218063411072732160,
                "clearStatus": 1,
                "dishQty": 1,
                "id": 218063455586880500,
                "isDefault": 1,
                "isMulti": 1,
                "isReplace": 2,
                "leastCellNum": 1,
                "marketPrice": 0.12,
                "name": "满满鲜奶茶",
                "residueTotal": -299,
                "residueTotalWechat": 400,
                "saleTotal": 1000,
                "saleTotalWechat": 400,
                "saleType": 2,
                "sort": 1,
                "unitName": "份",
                "dishIngredientInfoVo": null,
                "dishPropertyTypeInfos": [
                  {
                    "dishBrandId": 218063411072732160,
                    "id": 123800111624990720,
                    "name": "甜度",
                    "properties": [
                      {
                        "id": 123800944504713220,
                        "isChecked": 2,
                        "name": "无糖",
                        "reprice": 1,
                        "sort": 0
                      },
                      {
                        "id": 123800237852569600,
                        "isChecked": 2,
                        "name": "少糖",
                        "reprice": 0,
                        "sort": 0
                      },
                      {
                        "id": 123800185813839870,
                        "isChecked": 2,
                        "name": "常规糖",
                        "reprice": 0,
                        "sort": 0
                      },
                      {
                        "id": 123800780016693250,
                        "isChecked": 2,
                        "name": "半糖",
                        "reprice": 0,
                        "sort": 0
                      }
                    ],
                    "type": 1
                  },
                  {
                    "dishBrandId": 218063411072732160,
                    "id": 284377835830688770,
                    "name": "做法测试",
                    "properties": [
                      {
                        "id": 284378071001119740,
                        "isChecked": 2,
                        "name": "小杯+奶盖",
                        "reprice": 0,
                        "sort": 0
                      },
                      {
                        "id": 284377939648101380,
                        "isChecked": 2,
                        "name": "大杯",
                        "reprice": 2,
                        "sort": 0
                      }
                    ],
                    "type": 1
                  }
                ],
                "imageUrls": null,
                "price": 1
              },
              {
                "boxQty": 1,
                "brandDishId": 222748246185872400,
                "clearStatus": 1,
                "dishQty": 1,
                "id": 298129153307613200,
                "isDefault": 1,
                "isMulti": 1,
                "isReplace": 2,
                "leastCellNum": 1,
                "marketPrice": 0.01,
                "name": "芝芝莓莓",
                "residueTotal": 997,
                "residueTotalWechat": 1000,
                "saleTotal": 1000,
                "saleTotalWechat": 1000,
                "saleType": 2,
                "sort": 2,
                "unitName": "份",
                "dishIngredientInfoVo": null,
                "dishPropertyTypeInfos": [
                  {
                    "dishBrandId": 222748246185872400,
                    "id": 218048691808766980,
                    "name": "冷热",
                    "properties": [
                      {
                        "id": 218063158126840830,
                        "isChecked": null,
                        "name": "热",
                        "reprice": 0,
                        "sort": 0
                      }
                    ],
                    "type": 1
                  }
                ],
                "imageUrls": null,
                "price": 0
              },
              {
                "boxQty": 1,
                "brandDishId": 313361766228304900,
                "clearStatus": 1,
                "dishQty": 1,
                "id": 313361766576432100,
                "isDefault": 2,
                "isMulti": 1,
                "isReplace": 2,
                "leastCellNum": 1,
                "marketPrice": 0.01,
                "name": "踩踩003",
                "residueTotal": 52,
                "residueTotalWechat": 1000,
                "saleTotal": 1000,
                "saleTotalWechat": 1000,
                "saleType": 2,
                "sort": 0,
                "unitName": "份",
                "dishIngredientInfoVo": null,
                "dishPropertyTypeInfos": [],
                "imageUrls": null,
                "price": 0
              },
              {
                "boxQty": 1,
                "brandDishId": 313720933401080800,
                "clearStatus": 1,
                "dishQty": 1,
                "id": 313720933661127700,
                "isDefault": 2,
                "isMulti": 1,
                "isReplace": 2,
                "leastCellNum": 1,
                "marketPrice": 20,
                "name": "商品0316001",
                "residueTotal": 1000,
                "residueTotalWechat": 1000,
                "saleTotal": 1000,
                "saleTotalWechat": 1000,
                "saleType": 2,
                "sort": 0,
                "unitName": "份",
                "dishIngredientInfoVo": null,
                "dishPropertyTypeInfos": [],
                "imageUrls": null,
                "price": 0
              }
            ],
            "id": 355728750390454300,
            "name": "默认分组",
            "orderMax": 6,
            "orderMin": 0,
            "sort": 0
          }
        ],
        "dishIngredientInfoVo": null,
        "dishPropertyTypeInfos": [],
        "largeImgList": null,
        "smallImgUrls": null,
        "enabledFlag": 1,
        "statusFlag": 1,
        "guaranteeDate": null,
        "guaranteeDateType": null,
        "dishCode": "SKU1647"
      }
    ]
  },
  "code": 0,
  "message": "成功[OK]",
  "messageUuid": "88d87f8da5e640bfa45893f6c8698bd8",
  "apiMessage": "成功[OK]"
}

请求参数

Query 参数
appKey
string 
必需
开发者申请服务客如云分配的appKey
默认值:
{{appKey}}
shopIdenty
string 
必需
客如云门店id (门店维度接口传递门店ID)
默认值:
{{shopIdenty}}
brandId
string 
必需
客如云品牌id(品牌授权的接口传递品牌ID)
默认值:
{{brandId}}
version
string 
必需
版本,默认2.0(1.0版本仍可用)
默认值:
2.0
timestamp
string 
必需
时间戳,单位:秒,时间戳校验签名,开放平台校验签名时用此参数和服务器当前时间戳对比不能大于300秒,我方服务器使用阿里云授时中心
默认值:
{{timestamp}}
sign
string 
必需
签名,64位长度的字符串,获取规则详见签名规则
默认值:
{{sign}}
Body 参数application/json
dishTypeId
integer 
必需
菜品分类Id(可通过菜品分类信息查询接口获取)
示例

返回响应

🟢200成功
application/json
Body
result
object 
必需
dishList
array [object {35}] 
必需
code
integer 
必需
message
string 
必需
messageUuid
string 
必需
apiMessage
string 
必需

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

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

扫码加入交流群
上一页
菜品父级信息查询
下一页
菜品分页查询
Built with