淘宝开放平台 - 文档中心

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
param_open_api_search_request	OpenApiSearchRequest	可选			入参
└ app String 可选 alipay 渠道版本 alipay,koubei,eleme,gaode,taobao └ city_id String 可选 330100 所选城市 └ client_os String 可选 ios 客户端 └ client_version String 可选 10.4 客户端版本 └ context String 可选 0 客户端上下文 └ current_city String 可选 330100 所选城市 └ current_district String 可选 330103 所选区 └ current_province String 可选 330000 省 └ forward Boolean 可选 false 固定值 └ latitude String 可选 30.81 纬度 └ lbs_busi_area_id String 可选 330101 所在商圈 └ lbs_city_id String 可选 330100 所在城市 └ lbs_district_id String 可选 330103 所在区 └ location_accuracy String 可选 30 经纬度精度 └ longitude String 可选 120.88 经度 └ original_size Number 可选 10 个数 └ os_version String 可选 10.8 OS 版本 └ params_map String 可选 {} 扩展参数 └ place_id String 可选 100 埋点ID └ query String 可选 kfc 关键词 └ request_id String 可选 199999 请求ID └ scene_id String 可选 MAIN_SEARCH 场景吗 └ search_id String 可选 10019911 搜索ID └ selected_menus String 可选 {} 菜单项 └ session_id String 可选 093333 sessionid └ size Number 可选 10 个数 └ sort String 可选 1 排序 └ src_spm String 可选 0 来源埋点 └ start Number 可选 0 分页 └ token_id String 可选 039933 搜索TOKEN └ trace String 可选 10299292 traceID └ uid String 可选 0922022 用户ID

名称	类型	示例值	描述
result	OpenApiSearchResult	{}	返回结果
└ bucket_id String 1 固定值 └ context String {} 固定值 └ count Number 10 个数 └ ext_attrs String {} 扩展值 items OpenApiHit [] [] 店铺信息 └ biz_id String 1001101 店铺ID └ desc String kFC 描述 └ entity_id String 1001101 店铺ID └ entity_type String SHOP 店铺类型 └ priority Number 1 优先级 └ recm_attrs String {} 店铺信息字段 └ rule_id String SHOP 固定值 └ weight String 0.8 排序权重 └ query String KFC 关键词 └ request_id String 020022 请求ID └ result_code Number 0 结果ID └ result_msg String 0 结果 └ search_group String 0 固定值 └ search_id String 0292222 搜索ID └ search_params String 0 固定值 └ session_id String 3333 sessionID └ total Number 10 店铺个数

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaKoubeishopsPropertyGetRequest req = new AlibabaKoubeishopsPropertyGetRequest();
AlibabaKoubeishopsPropertyGetRequest.OpenApiSearchRequest obj1 = new AlibabaKoubeishopsPropertyGetRequest.OpenApiSearchRequest();
obj1.setApp("alipay");
obj1.setCityId("330100");
obj1.setClientOs("ios");
obj1.setClientVersion("10.4");
obj1.setContext("0");
obj1.setCurrentCity("330100");
obj1.setCurrentDistrict("330103");
obj1.setCurrentProvince("330000");
obj1.setForward(false);
obj1.setLatitude("30.81");
obj1.setLbsBusiAreaId("330101");
obj1.setLbsCityId("330100");
obj1.setLbsDistrictId("330103");
obj1.setLocationAccuracy("30");
obj1.setLongitude("120.88");
obj1.setOriginalSize(10L);
obj1.setOsVersion("10.8");
obj1.setParamsMap("{}");
obj1.setPlaceId("100");
obj1.setQuery("kfc");
obj1.setRequestId("199999");
obj1.setSceneId("MAIN_SEARCH");
obj1.setSearchId("10019911");
obj1.setSelectedMenus("{}");
obj1.setSessionId("093333");
obj1.setSize(10L);
obj1.setSort("1");
obj1.setSrcSpm("0");
obj1.setStart(0L);
obj1.setTokenId("039933");
obj1.setTrace("10299292");
obj1.setUid("0922022");
req.setParamOpenApiSearchRequest(obj1);
AlibabaKoubeishopsPropertyGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaKoubeishopsPropertyGetRequest req = new AlibabaKoubeishopsPropertyGetRequest();
AlibabaKoubeishopsPropertyGetRequest.OpenApiSearchRequestDomain obj1 = new AlibabaKoubeishopsPropertyGetRequest.OpenApiSearchRequestDomain();
obj1.App = "alipay";
obj1.CityId = "330100";
obj1.ClientOs = "ios";
obj1.ClientVersion = "10.4";
obj1.Context = "0";
obj1.CurrentCity = "330100";
obj1.CurrentDistrict = "330103";
obj1.CurrentProvince = "330000";
obj1.Forward = false;
obj1.Latitude = "30.81";
obj1.LbsBusiAreaId = "330101";
obj1.LbsCityId = "330100";
obj1.LbsDistrictId = "330103";
obj1.LocationAccuracy = "30";
obj1.Longitude = "120.88";
obj1.OriginalSize = 10L;
obj1.OsVersion = "10.8";
obj1.ParamsMap = "{}";
obj1.PlaceId = "100";
obj1.Query = "kfc";
obj1.RequestId = "199999";
obj1.SceneId = "MAIN_SEARCH";
obj1.SearchId = "10019911";
obj1.SelectedMenus = "{}";
obj1.SessionId = "093333";
obj1.Size = 10L;
obj1.Sort = "1";
obj1.SrcSpm = "0";
obj1.Start = 0L;
obj1.TokenId = "039933";
obj1.Trace = "10299292";
obj1.Uid = "0922022";
req.ParamOpenApiSearchRequest_ = obj1;
AlibabaKoubeishopsPropertyGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaKoubeishopsPropertyGetRequest;
$param_open_api_search_request = new OpenApiSearchRequest;
$param_open_api_search_request->app="alipay";
$param_open_api_search_request->city_id="330100";
$param_open_api_search_request->client_os="ios";
$param_open_api_search_request->client_version="10.4";
$param_open_api_search_request->context="0";
$param_open_api_search_request->current_city="330100";
$param_open_api_search_request->current_district="330103";
$param_open_api_search_request->current_province="330000";
$param_open_api_search_request->forward="false";
$param_open_api_search_request->latitude="30.81";
$param_open_api_search_request->lbs_busi_area_id="330101";
$param_open_api_search_request->lbs_city_id="330100";
$param_open_api_search_request->lbs_district_id="330103";
$param_open_api_search_request->location_accuracy="30";
$param_open_api_search_request->longitude="120.88";
$param_open_api_search_request->original_size="10";
$param_open_api_search_request->os_version="10.8";
$param_open_api_search_request->params_map="{}";
$param_open_api_search_request->place_id="100";
$param_open_api_search_request->query="kfc";
$param_open_api_search_request->request_id="199999";
$param_open_api_search_request->scene_id="MAIN_SEARCH";
$param_open_api_search_request->search_id="10019911";
$param_open_api_search_request->selected_menus="{}";
$param_open_api_search_request->session_id="093333";
$param_open_api_search_request->size="10";
$param_open_api_search_request->sort="1";
$param_open_api_search_request->src_spm="0";
$param_open_api_search_request->start="0";
$param_open_api_search_request->token_id="039933";
$param_open_api_search_request->trace="10299292";
$param_open_api_search_request->uid="0922022";
$req->setParamOpenApiSearchRequest(json_encode($param_open_api_search_request));
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.koubeishops.property.get' \
-d 'partner_id=apidoc' \
-d 'sign=E158F0EB65E23841202B40E0E44A5CAF' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-30+15%3A39%3A25' \
-d 'v=2.0' \
-d 'param_open_api_search_request=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.AlibabaKoubeishopsPropertyGetRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.param_open_api_search_request=""
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"alibaba.koubeishops.property.get");
add_param(pRequest,"param_open_api_search_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.koubeishops.property.get', {
	'param_open_api_search_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_koubeishops_property_get_response>
    <result>
        <bucket_id>1</bucket_id>
        <context>{}</context>
        <count>10</count>
        <ext_attrs>{}</ext_attrs>
        <items>
            <open_api_hit>
                <biz_id>1001101</biz_id>
                <desc>kFC</desc>
                <entity_id>1001101</entity_id>
                <entity_type>SHOP</entity_type>
                <priority>1</priority>
                <recm_attrs>{}</recm_attrs>
                <rule_id>SHOP</rule_id>
                <weight>0.8</weight>
            </open_api_hit>
        </items>
        <query>KFC</query>
        <request_id>020022</request_id>
        <result_code>0</result_code>
        <result_msg>0</result_msg>
        <search_group>0</search_group>
        <search_id>0292222</search_id>
        <search_params>0</search_params>
        <session_id>3333</session_id>
        <total>10</total>
    </result>
</alibaba_koubeishops_property_get_response>

{
    "alibaba_koubeishops_property_get_response":{
        "result":{
            "bucket_id":"1",
            "context":"{}",
            "count":10,
            "ext_attrs":"{}",
            "items":{
                "open_api_hit":[
                    {
                        "biz_id":"1001101",
                        "desc":"kFC",
                        "entity_id":"1001101",
                        "entity_type":"SHOP",
                        "priority":1,
                        "recm_attrs":"{}",
                        "rule_id":"SHOP",
                        "weight":"0.8"
                    }
                ]
            },
            "query":"KFC",
            "request_id":"020022",
            "result_code":0,
            "result_msg":"0",
            "search_group":"0",
            "search_id":"0292222",
            "search_params":"0",
            "session_id":"3333",
            "total":10
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

开放平台

店铺API

alibaba.koubeishops.property.get (口碑店铺列表推荐)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ