小程序开放平台

文档中心
平台概述

[声明式门店管理]查询可用的地点

更新时间:2025-02-28 14:13:05

支持第三方调用

支持沙箱环境调用

查询可用的地点

请求地址

POST https://miniapp.xiaohongshu.com/api/rmp/place/query

公共请求参数

名称
类型
是否必须
描述
app_idstring小程序appid
access_tokenstring小程序调用凭证

业务请求参数

名称
类型
是否必须
描述
place_namestring地点名称
provincestring省份
citystring城市
districtstring区县
latitudefloat64纬度
longitudefloat64经度
addressstring地点详情
amap_idstring高德ID
radiusint64以提供的坐标为圆心的半径范围,单位米(默认为0,表示当前地点)

请求示例

{
    "place_name":"string",
    "province":"string",
    "city":"string",
    "district":"string",
    "latitude":0.0,
    "longitude":0.0,
    "address":"string",
    "amap_id":"string",
    "radius":0
}

响应参数

名称
类型
是否必须
描述
data
struct
place_list
list_struct地点列表
place_id
string地点id
place_name
string地点名称
province
string省份
city
string城市
district
string区县
latitude
float64纬度
longitude
float64经度
address
string地点详情
top_image_url
string首图链接
amap_id
string高德id
successbool是否成功
msgstring说明,正确响应时为 success,错误响应时为错误描述
codeint32错误码,正确响应时为 0,错误响应时非0

响应示例

{
    "data":{
        "place_list":[
            {
                "place_id":"string",
                "place_name":"string",
                "province":"string",
                "city":"string",
                "district":"string",
                "latitude":0.0,
                "longitude":0.0,
                "address":"string",
                "top_image_url":"string",
                "amap_id":"string"
            }
        ]
    },
    "success":true,
    "msg":"string",
    "code":0
}

业务错误码

参见错误码