客如云 API

获取门店列表

测试环境

https://gldopenapi.keruyun.com

POST

/open/v1/shop/shoplist

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://gldopenapi.keruyun.com/open/v1/shop/shoplist?appKey=&shopIdenty=&brandId=&version=&timestamp=&sign='

响应示例

{
  "result": [
    {
      "commercialID": 810094162,
      "commercialName": "体验区测试品牌01store品牌1门店1",
      "commercialLogo": null,
      "commercialContact": "哈哈",
      "commercialPhone": "15928515739",
      "status": 0,
      "busiCode": "10999",
      "busiName": "朝阳区",
      "areaId": "110105",
      "areaCode": "010",
      "areaName": "朝阳区",
      "cityCode": "110100",
      "cityName": "北京市",
      "openTimes": [
        {
          "timeType": 0,
          "type": 3,
          "items": [
            {
              "type": 1,
              "startTime": "08:00",
              "endTime": "13:00"
            },
            {
              "type": 2,
              "startTime": "12:00",
              "endTime": "08:00"
            }
          ]
        },
        {
          "timeType": 1,
          "type": 0,
          "items": [
            {
              "type": 0,
              "startTime": "00:00",
              "endTime": "23:00"
            }
          ]
        }
      ],
      "pname": "北京市",
      "dname": "朝阳区",
      "pcode": "110000",
      "dcode": "110105"
    },
    {
      "commercialID": 810097768,
      "commercialName": "体验区测试品牌01体验区测试品牌01store品牌1门店2",
      "commercialLogo": null,
      "commercialContact": "哈哈",
      "commercialPhone": "15928515739",
      "status": 0,
      "busiCode": "13946",
      "busiName": "晋源区",
      "areaId": "140110",
      "areaCode": "0351",
      "areaName": "晋源区",
      "cityCode": "140100",
      "cityName": "太原市",
      "openTimes": [
        {
          "timeType": 0,
          "type": 0,
          "items": [
            {
              "type": 0,
              "startTime": "00:00",
              "endTime": "00:00"
            }
          ]
        },
        {
          "timeType": 1,
          "type": 0,
          "items": [
            {
              "type": 0,
              "startTime": "00:00",
              "endTime": "00:00"
            }
          ]
        }
      ],
      "pname": "山西省",
      "dname": "晋源区",
      "pcode": "140000",
      "dcode": "140110"
    }
  ],
  "code": 0,
  "message": "成功[OK]",
  "messageUuid": "bb8c1316cd4949369f41fd1f0607adda",
  "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位长度的字符串，获取规则详见签名规则

默认值:

返回响应

🟢200成功

application/json

Body

result

array[object (OpenShopInfoVO) {18}]

必需

返回响应数据，json对象或数组，可为空

commercialID

integer

门店ID

必需

commercialName

string

门店名称

可选

commercialLogo

null

门店ID

可选

commercialContact

string

联系人名称

可选

commercialPhone

string

联系人电话

可选

status

integer

必需

商户状态 0-可用; -1-不可用; 1-预装

busiCode

string

商圈编码

可选

busiName

string

商圈名称

可选

areaId

string

区域ID

可选

areaCode

string

区域Code

可选

areaName

string

区域名称

可选

cityCode

string

城市编码

可选

cityName

string

城市名称

可选

openTimes

array [object {3}]

营业时间、送餐时间

必需

pname

string

省名称

必需

dname

string

区名称

可选

pcode

string

省编码

必需

dcode

string

区编码

可选

code

integer

必需

返回编码，详见错误码

message

string

返回信息

必需

messageUuid

string

消息uuid

必需

apiMessage

null

必需

获取服务下可用门店

获取门店信息