门店架构
获取门店列表
接口描述: 分页获取当前企业下所有的门店信息
接口地址: https://yd.yunding360.com/openapi/stores
请求方式:GET
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| address | 门店地址 | query | false | string | |
| areaId | 所属区域ID | query | false | integer | |
| code | 门店Code | query | false | string | |
| groupId | 所属门店分组ID,查询直属分组的门店 | query | false | string | |
| groupIds | 所属门店分组ID,查询分组下所有的门店,包括子分组下的门店 | query | false | string | |
| name | 门店名称 | query | false | string | |
| page | 页数(从0开始计数,默认为0) | query | true | integer | |
| size | 每页数量(默认20) | query | true | integer | |
| status | 营业状态 | query | false | string | |
| type | 门店类型 | query | false | string |
响应示例:
{
"content": [
{
"address": "",
"area": 0,
"areaId": 0,
"areaIds": [],
"businessHoursEnd": "",
"businessHoursStart": "",
"capability": [],
"code": "",
"contactMobile": "",
"groupId": "",
"groupIds": [],
"id": "",
"latitude": 0,
"longitude": 0,
"name": "",
"status": "",
"storeManagerId": "",
"storeTags": [
{
"id": "",
"name": ""
}
],
"type": "",
"storeCategory": [
{
"id": "",
"name": ""
}
],
"shoppingMallId": "",
"shoppingMall": "",
"regionKey": "",
"regionName": "",
"province": "",
"city": "",
"launchTime": 1740467054327,
"createdTime": 1740467054327,
"storeDeviceOnlineStatus": "",
"remark": ""
}
],
"metadata": {
"page": 0,
"size": 0,
"totalElements": 0,
"totalPages": 0
}
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| content | array | StoreInfo | |
| metadata | 分页信息 | PageMetadata | PageMetadata |
schema属性说明
StoreInfo
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| address | 地址 | string | |
| area | 门店面积 | number(double) | |
| areaId | 所属区域ID | integer(int32) | |
| areaIds | 所属区域ids | array | |
| businessHoursEnd | 结束营业时间 | string | |
| businessHoursStart | 开始营业时间 | string | |
| capability | 门店能力,可用值:HOTSPOT_V2_AUDIO_VIDEO, FACE_FLOW, HOTSPOT_VIDEO, FLOW_VIDEO, STORAGE_CARD, HOTSPOT_V2, FACE, HOTSPOT, FLOW, CLOUD, AUDIO, VIDEO, COMMON | array | |
| code | 门店Code | string | |
| contactMobile | 联系电话 | string | |
| groupId | 所属分组id | string(uuid) | |
| groupIds | 所属分组ids | array | |
| id | Id | string(uuid) | |
| latitude | 纬度 | number(double) | |
| longitude | 经度 | number(double) | |
| name | 门店名称或门店code | string | |
| status | 营业状态,可用值:IN_BUSINESS,CLOSING | string | |
| storeManagerId | 店长id | string(uuid) | |
| storeTags | 门店标签 | array | StoreTag |
| type | 门店类型 | string | |
| storeCategory | 门店类别 | array | StoreTag |
| shoppingMallId | 所属商场/购物中心id | string(uuid) | |
| shoppingMall | 所属商场/购物中心 | string | |
| regionKey | 所在大区key | string | |
| regionName | 所在大区名称 | string | |
| province | 所在省份 | string | |
| city | 所在城市 | string | |
| launchTime | 上线时间 | integer(int64) | |
| createdTime | 创建时间 | integer(int64) | |
| storeDeviceOnlineStatus | 门店设备在线状态,ALL_ONLINE 全部在线,ALL_OFFLINE 全部离线,SOME_OFFLINE 部分离线 | string | |
| remark | 备注 | string |
StoreTag
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| id | Id | string(uuid) | |
| name | 名称 | string |
PageMetadata
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| page | 页数 | integer(int64) | |
| size | 每页数量 | integer(int64) | |
| totalElements | 总数 | integer(int64) | |
| totalPages | 总页数 | integer(int64) |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | PagedStoreInfo |
获取单个门店详细信息
接口描述: 根据门店ID获取对应门店的的详细信息
接口地址: https://yd.yunding360.com/openapi/stores/{uuid}
请求方式:GET
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| uuid | 门店id | path | true | string |
响应示例:
{
"address": "",
"area": 0,
"areaId": 0,
"areaIds": [],
"businessHoursEnd": "",
"businessHoursStart": "",
"capability": [],
"code": "",
"contactMobile": "",
"groupId": "",
"groupIds": [],
"id": "",
"latitude": 0,
"longitude": 0,
"name": "",
"status": "",
"storeManagerId": "",
"storeTags": [
{
"id": "",
"name": ""
}
],
"type": "",
"storeCategory": [
{
"id": "",
"name": ""
}
],
"shoppingMallId": "",
"shoppingMall": "",
"regionKey": "",
"regionName": "",
"province": "",
"city": "",
"launchTime": 1740467054327,
"createdTime": 1740467054327,
"storeDeviceOnlineStatus": "",
"remark": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| address | 地址 | string | |
| area | 门店面积 | number(double) | number(double) |
| areaId | 所属区域ID | integer(int32) | integer(int32) |
| areaIds | 所属区域ids | array | |
| businessHoursEnd | 结束营业时间 | string | |
| businessHoursStart | 开始营业时间 | string | |
| capability | 门店能力,可用值: HOTSPOT_V2_AUDIO_VIDEO, FACE_FLOW, HOTSPOT_VIDEO, FLOW_VIDEO, STORAGE_CARD, HOTSPOT_V2, FACE, HOTSPOT, FLOW, CLOUD, AUDIO, VIDEO, COMMON | array | |
| code | 门店Code | string | |
| contactMobile | 联系电话 | string | |
| groupId | 所属分组id | string(uuid) | string(uuid) |
| groupIds | 所属分组ids | array | |
| id | Id | string(uuid) | string(uuid) |
| latitude | 纬度 | number(double) | number(double) |
| longitude | 经度 | number(double) | number(double) |
| name | 门店名称 | string | |
| status | 营业状态,可用值:IN_BUSINESS,CLOSING | string | |
| storeManagerId | 店长id | string(uuid) | string(uuid) |
| storeTags | 门店标签 | array | StoreTag |
| type | 门店类型 | string | |
| storeCategory | 门店类别 | array | StoreTag |
| shoppingMallId | 所属商场/购物中心id | string(uuid) | |
| shoppingMall | 所属商场/购物中心 | string | |
| regionKey | 所在大区key | string | |
| regionName | 所在大区名称 | string | |
| province | 所在省份 | string | |
| city | 所在城市 | string | |
| launchTime | 上线时间 | integer(int64) | |
| createdTime | 创建时间 | integer(int64) | |
| storeDeviceOnlineStatus | 门店设备在线状态,ALL_ONLINE 全部在线,ALL_OFFLINE 全部离线,SOME_OFFLINE 部分离线 | string | |
| remark | 备注 | string |
schema属性说明
StoreTag
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| id | Id | string(uuid) | |
| name | 标签名称 | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | StoreInfo |
通过区域类型查询区域
接口描述 通过区域类型查询区域,如查询区域类型为品牌的所有区域
接口地址 https://yd.yunding360.com/openapi/store_groups/findAllByAreaType
请求方式 GET
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| areaType | 区域类型枚举,ORDINAR-普通区域,SUBSIDIARY-分子公司,REGION-大区,BRAND-品牌,BUSINESS_DEP-事业部,PROVINCE-省份,CITY-城市,COUNTY-区县 | body | true | string |
响应示例
{
"name": "",
"uuid": ""
}
响应参数
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| name | 名称 | string | |
| uuid | uuid | string(uuid) | string(uuid) |
新增门店
接口描述 通过传入参数,新增门店
接口地址 https://yd.yunding360.com/openapi/addStore
请求方式 POST
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| code | 门店code | body | true | string | |
| address | 地址 | body | true | string | |
| groupId | 所属门店分组id | body | true | string(uuid) | |
| name | 门店名称 | body | true | string | |
| status | 营业状态, IN_BUSINESS(运行,默认) CLOSING(关闭) SUSPEND(暂停) |
body | true | enum | |
| storeManagerId | 店长id | body | false | string(uuid) | |
| area | 门店面积 | body | false | number(double) | |
| businessHoursStart | 开始营业时间(HH:mm:ss) | body | true | string | |
| businessHoursEnd | 结束营业时间(HH:mm:ss) | body | true | string | |
| storeTagIds | 门店标签id集合 | body | false | array(string) | |
| storeCategoryIds | 门店类别id集合 | body | false | array(string) | |
| launchTime | 上线时间(时间戳,毫秒) | body | true | integer(int64) | |
| remark | 备注 | body | false | string |
请求示例:
{
"code": "",
"address": "",
"groupId": "",
"name": "",
"status": "IN_BUSINESS",
"storeManagerId": "",
"area": null,
"businessHoursStart": "07:00:00",
"businessHoursEnd": "23:00:00",
"storeTagIds": [
"6707d180-7b05-11ea-91c7-c38f36efe728"
],
"storeCategoryIds": [
"6707d180-7b05-11ea-91c7-c38f36efe728"
],
"launchTime": 0,
"remark": ""
}
响应示例
{
"id": "fb155e50-fc10-11eb-a279-01e9bd6373c5",
"createdTime": 1628843542722,
"creator": "6707d180-7b05-11ea-91c7-c38f36efe728",
"modifiedTime": 1628843542722,
"modifier": null,
"name": "111",
"nameMap": {
"88e707a0-8f71-11ea-a373-0dbaaa1f5c86": "22"
},
"code": "111111111",
"address": "",
"areaId": null,
"areaIds": null,
"province": null,
"city": null,
"groupId": "88e707a0-8f71-11ea-a373-0dbaaa1f5c86",
"groupIds": [
"88e707a0-8f71-11ea-a373-0dbaaa1f5c86",
"a1a95820-7878-11ea-9d75-39447283014d"
],
"enterpriseId": "dd25cef0-3eeb-11e9-9819-7f0037bd9d5c",
"status": "IN_BUSINESS",
"storeManagerId": null,
"longitude": null,
"latitude": null,
"deviceNumber": 0,
"area": 11,
"businessHoursStart": "07:00:00",
"businessHoursEnd": "23:00:00",
"contactMobile": null,
"capability": [],
"deviceOnlineNum": 0,
"storeTagsNew": [
{
"id": "5dd70c19-08f8-11ee-b8d2-b9bd8e764014",
"name": "标签分类:标签名称1"
},
{
"id": "dac2c8a1-08e7-11ee-b8d2-b9bd8e764014",
"name": "标签分类:标签名称2"
}
],
"logicalDelete": false,
"uuid": "fb155e50-fc10-11eb-a279-01e9bd6373c5"
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| address | 地址 | string | |
| area | 门店面积 | number(double) | |
| areaId | 所属区域ID | integer(int32) | |
| areaIds | 所属区域ids | array | |
| businessHoursEnd | 结束营业时间 | string | |
| businessHoursStart | 开始营业时间 | string | |
| capability | 门店能力,可用值:HOTSPOT_V2_AUDIO_VIDEO, FACE_FLOW, HOTSPOT_VIDEO, FLOW_VIDEO, STORAGE_CARD, HOTSPOT_V2, FACE, HOTSPOT, FLOW, CLOUD, AUDIO, VIDEO, COMMON | array | |
| code | 门店Code | string | |
| contactMobile | 联系电话 | string | |
| groupId | 所属分组id | string(uuid) | |
| groupIds | 所属分组ids | array | |
| id | Id | string(uuid) | |
| latitude | 纬度 | number(double) | |
| longitude | 经度 | number(double) | |
| name | 门店名称 | string | |
| status | 营业状态,可用值:IN_BUSINESS,CLOSING | string | |
| storeManagerId | 店长id | string(uuid) | |
| launchTime | 上线时间 | integer(int64) | |
| createdTime | 创建时间 | integer(int64) | |
| storeTags | 门店标签 | array | StoreTag |
| type | 门店类型 | string |
storeTagsNew
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| id | Id | string(uuid) | |
| name | 标签名称,格式(分类:标签;说明:以“:”号分割,得到分类和标签) | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK |
编辑门店
接口描述 通过传入参数,编辑门店
接口地址 https://yd.yunding360.com/openapi/updateStore/{uuid}
请求方式 PATCH
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| uuid | 门店id | path | true | string | |
| code | 门店code | body | false | string | |
| address | 地址 | body | false | string | |
| groupId | 所属门店分组id | body | false | string(uuid) | |
| name | 门店名称 | body | false | string | |
| status | 营业状态, IN_BUSINESS(运行,默认) CLOSING(关闭) SUSPEND(暂停) |
body | false | enum | |
| storeManagerId | 店长id | body | false | string(uuid) | |
| area | 门店面积 | body | false | number(double) | |
| businessHoursStart | 开始营业时间(HH:mm:ss) | body | false | string | |
| businessHoursEnd | 结束营业时间(HH:mm:ss) | body | false | string | |
| storeTagIds | 门店标签id集合, 传空数组时,去掉门店关联的标签 | body | false | array(string) | |
| storeCategoryIds | 门店类别id集合, 传空数组时,去掉门店关联的类别 | body | false | array(string) | |
| launchTime | 上线时间(时间戳,毫秒) | body | true | integer(int64) | |
| remark | 备注 | body | false | string |
请求示例:
{
"address": "",
"groupId": "",
"name": "",
"status": "IN_BUSINESS",
"storeManagerId": "",
"area": null,
"businessHoursStart": "07:00:00",
"businessHoursEnd": "23:00:00",
"storeTagIds": [],
"storeCategoryIds": [
"6707d180-7b05-11ea-91c7-c38f36efe728"
],
"launchTime": 0,
"remark": ""
}
响应示例
{
"address": "",
"area": 0,
"areaId": 0,
"areaIds": [],
"businessHoursEnd": "",
"businessHoursStart": "",
"capability": [],
"code": "",
"contactMobile": "",
"groupId": "",
"groupIds": [],
"id": "",
"latitude": 0,
"longitude": 0,
"name": "",
"status": "",
"storeManagerId": "",
"storeTags": [
{
"id": "",
"name": ""
}
],
"type": "",
"storeCategory": [
{
"id": "",
"name": ""
}
],
"regionKey": "",
"regionName": "",
"province": "",
"city": "",
"launchTime": 1740467054327,
"createdTime": 1740467054327,
"storeDeviceOnlineStatus": "",
"remark": ""
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| address | 地址 | string | |
| area | 门店面积 | number(double) | |
| areaId | 所属区域ID | integer(int32) | |
| areaIds | 所属区域ids | array | |
| businessHoursEnd | 结束营业时间 | string | |
| businessHoursStart | 开始营业时间 | string | |
| capability | 门店能力,可用值:HOTSPOT_V2_AUDIO_VIDEO, FACE_FLOW, HOTSPOT_VIDEO, FLOW_VIDEO, STORAGE_CARD, HOTSPOT_V2, FACE, HOTSPOT, FLOW, CLOUD, AUDIO, VIDEO, COMMON | array | |
| code | 门店Code | string | |
| contactMobile | 联系电话 | string | |
| groupId | 所属分组id | string(uuid) | |
| groupIds | 所属分组ids | array | |
| id | Id | string(uuid) | |
| latitude | 纬度 | number(double) | |
| longitude | 经度 | number(double) | |
| name | 门店名称 | string | |
| status | 营业状态,可用值:IN_BUSINESS,CLOSING | string | |
| storeManagerId | 店长id | string(uuid) | |
| storeTags | 门店标签 | array | StoreTag |
| type | 门店类型 | string | |
| launchTime | 上线时间 | integer(int64) | |
| createdTime | 创建时间 | integer(int64) |
StoreTag
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| id | Id | string(uuid) | |
| name | 标签名称,格式(分类:标签;说明:以“:”号分割,得到分类和标签) | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK |
查询区域
接口描述: 根据传入的信息查询区域
接口地址: https://yd.yunding360.com/openapi/store_groups/findAllStoreGroup
请求方式:POST
请求示例:
{
"name": "",
"parentId": "",
"areaType": "ORDINAR"
}
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| query | query | body | true | StoreGroupOpenApiQuery | StoreGroupOpenApiQuery |
| page | 页码,默认为0 | param | false | int | |
| size | 页大小,默认10 | param | false | int |
schema属性说明
StoreGroupOpenApiQuery
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| name | 区域名称 | body | false | string | |
| parentId | 父id | body | false | string | |
| areaType | 区域类型 ORDINAR("普通区域") SUBSIDIARY("分子公司") REGION("大区") BRAND("品牌") BUSINESS_DEP("事业部") PROVINCE("省份") CITY("城市") COUNTY("区县") |
body | false | enum |
响应示例:
{
"content": [
{
"id": "eca02920-f019-11eb-b1ae-0d99c3e654f4",
"createdTime": 1627527969978,
"creator": "18e0a840-10db-11ea-9420-915f023a6084",
"modifiedTime": 1627527969978,
"modifier": null,
"name": "自动化测试区域别删除",
"nameMap": {},
"uuid": "eca02920-f019-11eb-b1ae-0d99c3e654f4",
"enterpriseId": "dd25cef0-3eeb-11e9-9819-7f0037bd9d5c",
"code": "9185UG42",
"parentId": "a1a95820-7878-11ea-9d75-39447283014d",
"areaType": "ORDINAR"
}
],
"metadata": {
"size": 1,
"totalElements": 444,
"totalPages": 444,
"page": 0
}
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| id | ID | string(uuid) | string(uuid) |
| createdTime | 创建时间 | integer(int64) | integer(int64) |
| creator | 创建者ID | string(uuid) | string(uuid) |
| modifiedTime | 最后更新时间 | integer(int64) | integer(int64) |
| modifier | 更新者ID | string(uuid) | string(uuid) |
| name | 名称 | string | |
| enterpriseId | 企业id | string | |
| code | 区域code | string | |
| parentId | 父级id | string | |
| areaType | 区域类型 ORDINAR("普通区域") SUBSIDIARY("分子公司") REGION("大区") BRAND("品牌") BUSINESS_DEP("事业部") PROVINCE("省份") CITY("城市") COUNTY("区县") |
string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK |
查询店内分区
接口描述: 根据门店查询其下属店内分区集合
接口地址: https://yd.yunding360.com/openapi/storeArea/findAllStoreArea
请求方式:POST
请求示例:
{
"storeId": "041fc7a0-93eb-11e9-b42b-3f258a12b71f"
}
请求参数:
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| query | query | body | true | storeAreaOpenApiQuery | StoreAreaOpenApiQuery |
| page | 页码,默认为0 | param | false | int | |
| size | 页大小,默认10 | param | false | int |
schema属性说明
StoreAreaOpenApiQuery
| 参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| storeId | 门店id | body | true | string |
响应示例:
{
"content": [
{
"id": "64ae7f81-a32f-11eb-9cd9-e9c37b1703bd",
"createdTime": 1619070951288,
"creator": "66fb8460-d308-11ea-9205-d7f1617fca51",
"modifiedTime": 1619070951288,
"modifier": null,
"name": null,
"nameMap": {},
"parentId": null,
"enterpriseId": "7cecdae0-8bf0-11e9-943f-097c06223cf2",
"enterpriseCode": "yanshi",
"areaCode": "11",
"areaName": "休息区",
"storeAreaTypeId": "e1a4ef74-700d-11ea-b578-35bde23f4bb9",
"businessStatus": "IN_BUSINESS",
"deviceIds": [
"63131770-1a55-11eb-ad1d-591a5ad883ae"
],
"storeId": "041fc7a0-93eb-11e9-b42b-3f258a12b71f",
"siteType": "500"
}
],
"metadata": {
"size": 1,
"totalElements": 4,
"totalPages": 4,
"page": 0
}
}
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| id | ID | string(uuid) | string(uuid) |
| createdTime | 创建时间 | integer(int64) | integer(int64) |
| creator | 创建者ID | string(uuid) | string(uuid) |
| modifiedTime | 最后更新时间 | integer(int64) | integer(int64) |
| modifier | 更新者ID | string(uuid) | string(uuid) |
| enterpriseId | 企业id | string | |
| enterpriseCode | 企业code | string | |
| areaCode | 店内区域code | string | |
| areaName | 店内区域名称 | string | |
| storeAreaTypeId | 店内分区类型ID | string(uuid) | string(uuid) |
| businessStatus | 区域类型 IN_BUSINESS("运行") CLOSING("关闭") SUSPEND("暂停") |
string | |
| deviceIds | 下属设备ids | array | |
| storeId | 门店id | string | |
| siteType | 场所类型 | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK |
添加区域
接口地址:https://yd.yunding360.com/openapi/store_groups/add
请求方式:POST
请求数据类型:application/json
请求示例:
{
"name": "aaa",
"parentId": null,
"areaType": null
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| api-version | API版本号,可用值:v1 | header | true | string |
| Authorization | Oauth2认证令牌 | header | false | string |
| areaType | 区域类型(选填), 可用值: ORDINAR("普通区域"), SUBSIDIARY("分子公司"), REGION("大区"), BRAND("品牌"), BUSINESS_DEP("事业部"), PROVINCE("省份"), CITY("城市"), COUNTY("区县") |
body | false | string |
| name | 区域名称(必填) | body | true | string |
| parentId | 父节点ID (选填),如果为空,会默认添加到根节点下 | body | false | string(uuid) |
响应状态:
| 状态码 | 说明 |
|---|---|
| 200 | OK |
响应示例:
{
"id": "43eb2164-1c9d-11ee-9fdf-8feadf3f8103",
"createdTime": 1688717227004,
"name": "测试新增",
"enterpriseId": "",
"code": "3PJVDWCC",
"parentId": "c917b265-0a62-11ee-b798-edb2da665e40",
"areaType": "ORDINAR"
}
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| id | id | string(uuid) |
| createdTime | 创建时间 | long |
| name | 区域名称 | string |
| code | 区域编号 | string |
| parentId | 上级区域节点id | string(uuid) |
| areaType | 区域类型 | string |
删除区域
接口地址:https://yd.yunding360.com/openapi/store_groups/delete
请求方式:POST
接口描述: 通过区域ID进行删除,删除区域前需要把下级区域和门店全部移除后才能删除
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| api-version | API版本号,可用值:v1 | header | true | string |
| Authorization | Oauth2认证令牌 | header | false | string |
| id | id | query | true | string(uuid) |
响应状态:
| 状态码 | 说明 |
|---|---|
| 200 | OK |
响应参数:
暂无
新增门店标签配置
接口地址:https://yd.yunding360.com/openapi/store_tag/add
请求方式:POST
请求数据类型:application/json
请求示例:
{
"name": "门店类型:直营店"
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| api-version | API版本号,可用值:v1 | header | true | string |
| Authorization | Oauth2认证令牌 | header | true | string |
| name | 标签名称,格式(分类:标签,添加分类示例:“门店类型”;添加标签示例:“门店类型:直营店”;) | body | false | string |
响应状态:
| 状态码 | 说明 |
|---|---|
| 200 | OK |
响应示例:
{
"id": "43eb2164-1c9d-11ee-9fdf-8feadf3f8103",
"createdTime": 1688717227004,
"name": "门店类型:直营店",
"enterpriseId": "43eb2164-1c9d-11ee-9fdf-8feadf3f8103"
}
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| id | id | string(uuid) |
| createdTime | 创建时间 | long |
| name | 标签名称(说明:以“:”号分割,得到分类和标签) | string |
编辑门店标签配置
接口地址:https://yd.yunding360.com/openapi/store_tag/edit
请求方式:POST
请求数据类型:application/json
接口描述
: 编辑门店标签接口,如果修改单个标签名称,则name传参需要传入“分类名:新标签名”,如果修改分类名称,则需要将分类下的所有标签都传入修改,“{"tagInfoList":[{"id":"43eb2164-1c9d-11ee-9fdf-8feadf3f8103","name":"新分类名:标签名1"},{"id":"43eb2164-1c9d-11ee-9fdf-8feadf3f8103","name":"新分类名:标签名2"}]}”
请求示例:
{
"tagInfoList": [
{
"id": "43eb2164-1c9d-11ee-9fdf-8feadf3f8103",
"name": "门店类型:直营店1"
}
]
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| api-version | API版本号,可用值:v1 | header | true | string |
| Authorization | Oauth2认证令牌 | header | true | string |
| tagInfoList | 门店标签 | body | false | array |
| id | id,添加标签时不传,编辑标签时必传 | body | false | string |
| name | 标签名称,格式(分类:标签,添加标签示例:“门店类型:直营店”;添加分类示例:“门店类型”) | body | false | string |
响应状态:
| 状态码 | 说明 |
|---|---|
| 200 | OK |
响应示例:
{
"id": "43eb2164-1c9d-11ee-9fdf-8feadf3f8103",
"createdTime": 1688717227004,
"name": "门店类型:直营店111",
"enterpriseId": "43eb2164-1c9d-11ee-9fdf-8feadf3f8103"
}
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| id | id | string(uuid) |
| createdTime | 创建时间 | long |
| name | 标签名称(说明:以“:”号分割,得到分类和标签) | string |
删除门店标签配置
接口地址:https://yd.yunding360.com/openapi/store_tag/delete
请求方式:POST
接口描述: 通过标签ID进行删除,需要区分是删除的分类还是标签
请求数据类型:application/json
请求示例:
{
"deleteClass": false,
"ids": [
"9c6454c2-470a-11ee-94bc-6f3b3314b753"
]
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| api-version | API版本号,可用值:v1 | header | true | string |
| Authorization | Oauth2认证令牌 | header | true | string |
| ids | 门店标签或分类的id | body | false | array |
| deleteClass | 是否需要删除分类,true:删除分类,false:删除标签;当删除分类时,分类下的标签会全部删除,ids需要传入所有的标签id | body | false | Boolean |
响应状态:
| 状态码 | 说明 |
|---|---|
| 200 | OK |
响应参数:
暂无
查询门店标签配置
接口地址:https://yd.yunding360.com/openapi/store_tag/all
请求方式:POST
接口描述: 获取当前认证账号所在企业的所有标签
请求数据类型:application/json
请求示例:
{
"name": ""
}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| api-version | API版本号,可用值:v1 | header | true | string |
| Authorization | Oauth2认证令牌 | header | true | string |
| name | 标签名称 | body | false | string |
响应状态:
| 状态码 | 说明 |
|---|---|
| 200 | OK |
响应参数:
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| id | id | string(uuid) |
| createdTime | 创建时间 | long |
| name | 标签名称(说明:以“:”号分割,得到分类和标签) | string |
| storeCount | 关联的门店数量 | int |
响应示例:
[
{
"id": "2d3cfa32-470a-11ee-94bc-6f3b3314b753",
"name": "标签分类名称:标签名称",
"enterpriseId": "6e817750-706f-11e9-ad77-0f5fd489adb3",
"storeCount": 0
}
]