淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
request	Request	可选
└ page Number 必须 1 当前页(从1开始) └ pageSize Number 必须 10 每页条数(不超过100) └ storeCode String 可选 C1234 门店(仓储)编码 └ startTime String 可选 2017-01-10 00:00:00 最后修改的起始时间(YYYY-MM-DD hh:mm:ss) └ endTime String 可选 2017-01-10 00:00:00 最后修改的结束时间(YYYY-MM-DD hh:mm:ss) └ extendProps Map 可选扩展属性

名称	类型	示例值	描述
response	Response
└ flag String success 响应结果:success\|failure └ code String 0 响应码 └ message String invalid appkey 响应信息 └ total Number 12 所有的总条数 stores Store [] 门店信息 └ storeCode String WQ123 门店(仓储)编码 └ storeName String M123 门店(仓储)名称 └ storeType String MD 类型(MD=门店、CK=仓库、OTHER=其他) └ region String 华南区区域(如华南区) └ orgCode String ZH123 上级组织编码 └ businessType String ZB 业务类型(ZB=总部、ZY=直营、JM=加盟) └ customerType String ZB 客户类型(ZB=总部、FB=分部、DL=代理商、ZY=直营店、JM=加盟店) └ retailType String PT 销售模式(PT=普通、DX=代销、ZX=直销) └ purchaseDiscount String 23 进货折扣 └ retailDiscount String 12 零售折扣 settlementInfo SettlementInfo 结算信息 └ settlementType Number 0 结算类型(0=不结算、1=发货结算、2=零售结算) └ currency String RMB 结算币制(RMB=人民币、USD=美元) detail Detail 门店详情 └ name String 老王姓名(门店联系人) └ zipCode String 043355 邮编(门店) └ tel String 0987654 固定电话(门店) └ mobile String 12345677 移动电话(门店) └ fax String 987654 传真(门店) └ countryCode String 余杭区国家二字码(门店地址) └ province String 浙江省份(门店地址) └ city String 杭州城市(门店地址) └ area String 西溪区域(门店地址) └ town String 986号村镇(门店地址) └ detailAddress String 浙江余杭详细地址(门店地址) └ isValid String Y 是否有效(Y/N\|默认为Y) └ createTime String 2017-01-12 00:00:00 创建时间(YYYY-MM-DD hh:mm:ss) └ latestUpdateTime String 2017-01-12 00:00:00 最新更新时间(YYYY-MM-DD hh:mm:ss)

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

QimenClient client = new DefaultQimenClient(url, appkey, secret);
PosStoreGetRequest req = new PosStoreGetRequest();
req.setCustomerId("stub-cust-code");
req.setVersion("2.0");
req.setPage(1L);
req.setPageSize(10L);
req.setStoreCode("C1234");
req.setStartTime("2017-01-10 00:00:00");
req.setEndTime("2017-01-10 00:00:00");
PosStoreGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

IQimenClient client = new DefaultQimenClient(url, appkey, secret);
PosStoreGetRequest req = new PosStoreGetRequest();
req.CustomerId = "stub-cust-code";
req.Version = "2.0";
req.Page = 1L;
req.PageSize = 10L;
req.StoreCode = "C1234";
req.StartTime = "2017-01-10 00:00:00";
req.EndTime = "2017-01-10 00:00:00";
PosStoreGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new QimenPosStoreGetRequest;
$request = new Request;
$request->page="1";
$request->page_size="10";
$request->store_code="C1234";
$request->start_time="2017-01-10 00:00:00";
$request->end_time="2017-01-10 00:00:00";
$request->extend_props="";
$req->setRequest(json_encode($request));
$resp = $c->execute($req);

curl -X POST 'http://qimenapi.tbsandbox.com/router/qimen/service?app_key=testerp_appkey&customerId=stub-cust-code&format=xml&method=taobao.qimen.pos.store.get&sign=6B94E9D8FB59999F69EDCC2EEED79836&sign_method=md5&timestamp=2025-05-21+17%3A42%3A58&v=2.0&version=1' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
--data \
'<request>
  <pageSize>10</pageSize>
  <startTime>2017-01-10 00:00:00</startTime>
  <page>1</page>
  <endTime>2017-01-10 00:00:00</endTime>
  <storeCode>C1234</storeCode>
</request>'

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

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

req.request="数据结构示例JSON格式"
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,"taobao.qimen.pos.store.get");
add_param(pRequest,"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('taobao.qimen.pos.store.get', {
	'request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<response>
    <flag>success</flag>
    <code>0</code>
    <message>invalid appkey</message>
    <total>12</total>
    <stores>
        <store>
            <storeCode>WQ123</storeCode>
            <storeName>M123</storeName>
            <storeType>MD</storeType>
            <region>华南区</region>
            <orgCode>ZH123</orgCode>
            <businessType>ZB</businessType>
            <customerType>ZB</customerType>
            <retailType>PT</retailType>
            <purchaseDiscount>23</purchaseDiscount>
            <retailDiscount>12</retailDiscount>
            <settlementInfo>
                <settlementType>0</settlementType>
                <currency>RMB</currency>
            </settlementInfo>
            <detail>
                <name>老王</name>
                <zipCode>043355</zipCode>
                <tel>0987654</tel>
                <mobile>12345677</mobile>
                <fax>987654</fax>
                <countryCode>余杭区</countryCode>
                <province>浙江</province>
                <city>杭州</city>
                <area>西溪</area>
                <town>986号</town>
                <detailAddress>浙江余杭</detailAddress>
            </detail>
            <isValid>Y</isValid>
            <createTime>2017-01-12 00:00:00</createTime>
            <latestUpdateTime>2017-01-12 00:00:00</latestUpdateTime>
        </store>
    </stores>
</response>

{
    "response":{
        "flag":"success",
        "code":"0",
        "message":"invalid appkey",
        "total":12,
        "stores":{
            "store":[
                {
                    "storeCode":"WQ123",
                    "storeName":"M123",
                    "storeType":"MD",
                    "region":"华南区",
                    "orgCode":"ZH123",
                    "businessType":"ZB",
                    "customerType":"ZB",
                    "retailType":"PT",
                    "purchaseDiscount":"23",
                    "retailDiscount":"12",
                    "settlementInfo":{
                        "settlementType":0,
                        "currency":"RMB"
                    },
                    "detail":{
                        "name":"老王",
                        "zipCode":"043355",
                        "tel":"0987654",
                        "mobile":"12345677",
                        "fax":"987654",
                        "countryCode":"余杭区",
                        "province":"浙江",
                        "city":"杭州",
                        "area":"西溪",
                        "town":"986号",
                        "detailAddress":"浙江余杭"
                    },
                    "isValid":"Y",
                    "createTime":"2017-01-12 00:00:00",
                    "latestUpdateTime":"2017-01-12 00:00:00"
                }
            ]
        }
    }
}

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下载

开放平台

奇门POS接口

taobao.qimen.pos.store.get (门店信息获取接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ