客如云 API

菜品分页查询

测试环境

https://gldopenapi.keruyun.com

POST

/open/v1/cater/dish/dishMe

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

请求示例

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,
   "startId":1,
   "pageNum":1000
}'

响应示例

{
  "result": {
    "hasnext": false,
    "dishTOList": [
      {
        "shopIdenty": 810094162,
        "name": "水煮牛肉",
        "aliasName": "",
        "brandDishId": 357218442118404100,
        "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
}

请求参数

Query 参数

appKey

string

必需

开发者申请服务客如云分配的appKey

默认值:

shopIdenty

string

必需

客如云门店id （门店维度接口传递门店ID）

默认值:

brandId

string

必需

客如云品牌id（品牌授权的接口传递品牌ID）

默认值:

version

string

必需

版本,默认2.0（1.0版本仍可用）

默认值:

2.0

timestamp

string

必需

时间戳,单位:秒,时间戳校验签名,开放平台校验签名时用此参数和服务器当前时间戳对比不能大于300秒，我方服务器使用阿里云授时中心

默认值:

sign

string

必需

签名，64位长度的字符串，获取规则详见签名规则

默认值:

Body 参数application/json

shopIdenty

integer

客如云门店ID

必需

startId

integer

可选

开始记录ID(默认1),下一页需带上返回参数中startId的值，返回参数中startId为null表示无下一页

pageNum

integer

必需

每页最大记录数(默认1000)

示例

返回响应

🟢200成功

application/json

Body

result

object

必需

hasnext

boolean

必需

dishTOList

array [object {24}]

必需

startId

null

必需

code

integer

必需

message

string

必需

messageUuid

string

必需

apiMessage

null

必需

菜品分类查询

菜品精确查询