# 门店接口

门店接口用于商户和平台之间进行门店信息的交互,包括门店变更通知、门店基础信息查询、配送费模板管理以及电子围栏校验等功能。通过这些接口,商户可以实时获取和更新门店信息,以及进行配送范围的校验。

# 1. 门店变更通知

POST /api/v1/store/change-notification

通知商户平台有关门店基本信息的变更,包括新增、修改、删除等操作。

请求参数

参数名 类型 必填 描述
change_type Integer 变更类型:1-新增,2-修改,3-删除
store_id String 门店ID
store_name String 门店名称
change_time Long 变更时间戳
store_info Object 门店详细信息(变更类型为1或2时必填)

响应参数

字段名 类型 描述
code Integer 状态码
message String 状态信息
data Object 响应数据

响应示例

{
  "code": 200,
  "message": "success",
  "data": {
    "result": true,
    "process_id": "PROCESS_2023112712345678"
  },
  "timestamp": 1701056789123
}

# 2. 查询门店基础信息接口

GET /api/v1/store/basic-info

查询门店的基础信息,包括名称、地址、营业状态等。

请求参数

参数名 类型 必填 描述
store_id String 门店ID

响应参数

字段名 类型 描述
store_id String 门店ID
store_name String 门店名称
store_code String 门店编码
address Object 门店地址信息
contact_phone String 联系电话
business_hours String 营业时间
status Integer 营业状态:1-营业中,0-已关闭

# 3. 查询配送费模板查询接口

GET /api/v1/store/delivery-fee-template

查询门店的配送费模板信息。

请求参数

参数名 类型 必填 描述
store_id String 门店ID
template_id String 模板ID(不传则返回门店所有模板)

响应参数

字段名 类型 描述
store_id String 门店ID
templates Array 配送费模板列表

# 4. 门店主信息新增通知

POST /api/v1/store/owner-info-add

通知平台有新的门店主信息添加。

请求参数

参数名 类型 必填 描述
store_id String 门店ID
owner_info Object 门店主信息
add_time Long 添加时间戳

# 5. 门店配送费模板变更通知

POST /api/v1/store/delivery-fee-template-change

通知平台门店配送费模板发生变更。

请求参数

参数名 类型 必填 描述
store_id String 门店ID
template_id String 模板ID
change_type Integer 变更类型:1-新增,2-修改,3-删除
template_info Object 模板详情(变更类型为1或2时必填)

# 6. 门店配送费模板删除通知

POST /api/v1/store/delivery-fee-template-delete

通知平台门店配送费模板已被删除。

请求参数

参数名 类型 必填 描述
store_id String 门店ID
template_id String 模板ID
delete_time Long 删除时间戳

# 7. 门店配送范围变更通知

POST /api/v1/store/delivery-area-change

通知平台门店配送范围发生变更。

请求参数

参数名 类型 必填 描述
store_id String 门店ID
change_type Integer 变更类型:1-新增,2-修改
delivery_area Object 配送范围信息
change_time Long 变更时间戳

delivery_area对象结构

字段名 类型 描述
area_id String 配送区域ID
radius Double 配送半径(单位:公里)
polygon Array 多边形配送区域坐标点列表

# 8. 门店-电子围栏校验接口

POST /api/v1/store/geofence-verify

校验指定坐标点是否在门店配送范围内。

请求参数

参数名 类型 必填 描述
store_id String 门店ID
longitude Double 经度
latitude Double 纬度

响应参数

字段名 类型 描述
in_area Boolean 是否在配送范围内
distance Double 距离门店的距离(单位:米)
delivery_fee Double 配送费(单位:元)

响应示例

{
  "code": 200,
  "message": "success",
  "data": {
    "in_area": true,
    "distance": 1250.5,
    "delivery_fee": 5.00
  },
  "timestamp": 1701056789123
}

# 9. 门店-批量校验电子围栏接口

POST /api/v1/store/batch-geofence-verify

批量校验多个门店对指定坐标点的配送范围。

请求参数

参数名 类型 必填 描述
store_ids Array 门店ID列表
longitude Double 经度
latitude Double 纬度

响应参数

字段名 类型 描述
store_results Array 各门店校验结果列表

store_results数组中每个对象结构:

字段名 类型 描述
store_id String 门店ID
store_name String 门店名称
in_area Boolean 是否在配送范围内
distance Double 距离门店的距离(单位:米)
delivery_fee Double 配送费(单位:元)

响应示例

{
  "code": 200,
  "message": "success",
  "data": {
    "store_results": [
      {
        "store_id": "ST10001",
        "store_name": "北京朝阳门店",
        "in_area": true,
        "distance": 1250.5,
        "delivery_fee": 5.00
      },
      {
        "store_id": "ST10002",
        "store_name": "北京海淀门店",
        "in_area": false,
        "distance": 3500.8,
        "delivery_fee": null
      }
    ]
  },
  "timestamp": 1701056789123
}