淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
page	Number	必须	1		当前页
pageSize	Number	必须	20		每页条数
customerCode	String	可选	CS275957	最大长度：50	顾客编码
startTime	String	可选	YYYY-MM-DD hh:mm:ss	最大长度：50	最后修改的起始时间
endTime	String	可选	YYYY-MM-DD hh:mm:ss	最大长度：50	最后修改的结束时间
customerid	String	必须	A12345	最大长度：50	指定路由参数

名称	类型	示例值	描述
flag	String	success\|failure	响应结果
code	String	errorcode	响应码
message	String	msg	响应信息
customer	Struct []
customerInfo Struct └ customerCode String CS275957 顾客编码 └ customerName String 张三顾客名称 └ storeCode String hz0001 所属门店编码 └ orgCode String 000001 所属组织编码 └ isVIP String Y=是 N=不是是否为VIP contactInfo Struct └ name String 张三姓名 └ gender String M=男性 F=女性性别 └ birthDate String YYYY-MM-DD 出生年月 └ career String IT工程师职业 └ zipCode String 132000 邮编 └ tel String 0571-85022088 固定电话 └ mobile String 13542088088 移动电话 └ fax String 0571-85022088 传真(门店) └ email String zhangsan@taobao.com 电子邮箱 └ province String 浙江省省份 └ city String 杭州市城市 └ area String 西湖区区域 └ town String 光明村村镇 └ detailAddress String 延安路2001号详细地址 VIPInfo Struct └ VIPCode String vip2750275 VIP会员编码 VIPCardInfo Struct └ VIPCardNo String card23652965 VIP的卡号编码 └ status Number 0=未启用 1=正常 2=停用 4=挂失 5=休眠 VIP卡的状态 └ storeCode String hz0001 所属门店编码 └ orgCode String 000001 所属组织编码 └ operator String 小红申请的营业员 └ serialCode String goldvip0002 VIP所属系列代码 └ serialName String goldvip VIP所属系列名称 └ groupCode String VIP等级之类的信息 VIP类别代码 └ groupName String 如钻石会员等 VIP类别代码 └ discount String 如9折为0.9000 默认折扣 └ isValid String Y/N 是否有效 └ createTime String YYYY-MM-DD hh:mm:ss 创建时间 └ latestUpdateTime String YYYY-MM-DD hh:mm:ss 最新更新时间

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

QimenCloudClient client = new DefaultQimenCloudClient(url, appkey, secret);
TaobaoPosCustomerGetRequest req = new TaobaoPosCustomerGetRequest();
req.setPage(1L);
req.setPageSize(20L);
req.setCustomerCode("CS275957");
req.setStartTime("YYYY-MM-DD hh:mm:ss");
req.setEndTime("YYYY-MM-DD hh:mm:ss");
req.setCustomerid("A12345");
TaobaoPosCustomerGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TaobaoPosCustomerGetRequest req = new TaobaoPosCustomerGetRequest();
req.Page = 1L;
req.PageSize = 20L;
req.CustomerCode = "CS275957";
req.StartTime = "YYYY-MM-DD hh:mm:ss";
req.EndTime = "YYYY-MM-DD hh:mm:ss";
req.Customerid = "A12345";
TaobaoPosCustomerGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TaobaoPosCustomerGetRequest;
$req->setPage("1");
$req->setPageSize("20");
$req->setCustomerCode("CS275957");
$req->setStartTime("YYYY-MM-DD hh:mm:ss");
$req->setEndTime("YYYY-MM-DD hh:mm:ss");
$req->setCustomerid("A12345");
$resp = $c->execute($req, $sessionKey);

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=qimen.taobao.pos.customer.get' \
-d 'partner_id=apidoc' \
-d 'session=57d92289-25d5-49e2-a00b-339d70f074d9' \
-d 'sign=E098874663A409340C6323865AE345F0' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-21+17%3A34%3A06' \
-d 'v=2.0' \
-d 'customerCode=CS275957' \
-d 'customerid=A12345' \
-d 'endTime=YYYY-MM-DD+hh%3Amm%3Ass' \
-d 'page=1' \
-d 'pageSize=20' \
-d 'startTime=YYYY-MM-DD+hh%3Amm%3Ass'

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

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

req.page=1
req.pageSize=20
req.customerCode="CS275957"
req.startTime="YYYY-MM-DD hh:mm:ss"
req.endTime="YYYY-MM-DD hh:mm:ss"
req.customerid="A12345"
try:
	resp= req.getResponse(sessionkey)
	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,"qimen.taobao.pos.customer.get");
add_param(pRequest,"page","1");
add_param(pRequest,"pageSize","20");
add_param(pRequest,"customerCode","CS275957");
add_param(pRequest,"startTime","YYYY-MM-DD hh:mm:ss");
add_param(pRequest,"endTime","YYYY-MM-DD hh:mm:ss");
add_param(pRequest,"customerid","A12345");
pResponse = top_execute(pClient,pRequest,sessionKey);
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('qimen.taobao.pos.customer.get', {
	'page':'1',
	'pageSize':'20',
	'customerCode':'CS275957',
	'startTime':'YYYY-MM-DD hh:mm:ss',
	'endTime':'YYYY-MM-DD hh:mm:ss',
	'customerid':'A12345'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<flag>success|failure</flag>
<code>errorcode</code>
<message>msg</message>
<customer>
    <struct>
        <customerInfo>
            <customerCode>CS275957</customerCode>
            <customerName>张三</customerName>
            <storeCode>hz0001</storeCode>
            <orgCode>000001</orgCode>
            <isVIP>Y=是 N=不是</isVIP>
            <contactInfo>
                <name>张三</name>
                <gender>M=男性 F=女性</gender>
                <birthDate>YYYY-MM-DD</birthDate>
                <career>IT工程师</career>
                <zipCode>132000</zipCode>
                <tel>0571-85022088</tel>
                <mobile>13542088088</mobile>
                <fax>0571-85022088</fax>
                <email>zhangsan@taobao.com</email>
                <province>浙江省</province>
                <city>杭州市</city>
                <area>西湖区</area>
                <town>光明村</town>
                <detailAddress>延安路2001号</detailAddress>
            </contactInfo>
        </customerInfo>
        <VIPInfo>
            <VIPCode>vip2750275</VIPCode>
            <VIPCardInfo>
                <VIPCardNo>card23652965</VIPCardNo>
                <status>0=未启用 1=正常 2=停用 4=挂失 5=休眠</status>
            </VIPCardInfo>
            <storeCode>hz0001</storeCode>
            <orgCode>000001</orgCode>
            <operator>小红</operator>
            <serialCode>goldvip0002</serialCode>
            <serialName>goldvip</serialName>
            <groupCode>VIP等级之类的信息</groupCode>
            <groupName>如钻石会员等</groupName>
            <discount>如9折为0.9000</discount>
            <isValid>Y/N</isValid>
        </VIPInfo>
        <createTime>YYYY-MM-DD hh:mm:ss</createTime>
        <latestUpdateTime>YYYY-MM-DD hh:mm:ss</latestUpdateTime>
    </struct>
</customer>

{
    "flag":"success|failure",
    "code":"errorcode",
    "message":"msg",
    "customer":{
        "struct":[
            {
                "customerInfo":{
                    "customerCode":"CS275957",
                    "customerName":"张三",
                    "storeCode":"hz0001",
                    "orgCode":"000001",
                    "isVIP":"Y=是 N=不是",
                    "contactInfo":{
                        "name":"张三",
                        "gender":"M=男性 F=女性",
                        "birthDate":"YYYY-MM-DD",
                        "career":"IT工程师",
                        "zipCode":"132000",
                        "tel":"0571-85022088",
                        "mobile":"13542088088",
                        "fax":"0571-85022088",
                        "email":"zhangsan@taobao.com",
                        "province":"浙江省",
                        "city":"杭州市",
                        "area":"西湖区",
                        "town":"光明村",
                        "detailAddress":"延安路2001号"
                    }
                },
                "VIPInfo":{
                    "VIPCode":"vip2750275",
                    "VIPCardInfo":{
                        "VIPCardNo":"card23652965",
                        "status":0=未启用 1=正常 2=停用 4=挂失 5=休眠
                    },
                    "storeCode":"hz0001",
                    "orgCode":"000001",
                    "operator":"小红",
                    "serialCode":"goldvip0002",
                    "serialName":"goldvip",
                    "groupCode":"VIP等级之类的信息",
                    "groupName":"如钻石会员等",
                    "discount":"如9折为0.9000",
                    "isValid":"Y\/N"
                },
                "createTime":"YYYY-MM-DD hh:mm:ss",
                "latestUpdateTime":"YYYY-MM-DD hh:mm:ss"
            }
        ]
    }
}

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接口

qimen.taobao.pos.customer.get (顾客信息同步接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ