淘宝开放平台

请求地址：

环境	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 必须 12 每页条数 └ customerCode String 可选 GUK123 顾客编码 └ startTime String 可选 2017-02-12 00:00:00 最后修改的起始时间(YYYY-MM-DD hh:mm:ss) └ endTime String 可选 2017-02-12 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 总条数 customers Customer [] customerInfo CustomerInfo └ customerCode String GU123 顾客编码 └ customerName String 老王顾客名称 └ storeCode String M123 所属门店编码 └ storeName String 常二路门店所属门店名称 └ orgCode String M123 所属组织编码 └ regTime String 2017-02-12 00:00:00 会员注册时间(YYYY-MM-DD hh:mm:ss) └ regSource String MD 会员注册来源(MD = 门店、GW = 官网、OTHER= 其他) └ isVIP String Y 是否为VIP(Y/N) contactInfo ContactInfo └ name String 老王姓名 └ gender String M 性别(M=男性、F=女性) └ birthDate String 2017-02-10 出生年月(YYYY-MM-DD) └ career String 码农职业 └ zipCode String 043300 邮编 └ tel String 056789 固定电话 └ mobile String 123456 移动电话 └ fax String 0567 传真 └ email String 0867667 电子邮箱 └ province String 浙江省份 └ city String 杭州城市 └ area String 余杭区域 └ town String 西溪村镇 └ detailAddress String 文一路详细地址 VIPInfo VIPInfo └ VIPCode String VIP123 VIP会员编码 └ firstPurchaseTime String 2017-02-12 00:00:00 第一次消费时间(YYYY-MM-DD hh:mm:ss) └ lastPurchaseTime String 2017-02-12 00:00:00 最后一次消费时间(YYYY-MM-DD hh:mm:ss) └ amount String 12 总消费金额 └ lastYearConsumption String 12 近一年消费金额 └ orderNum Number 12 购买单数 └ goodsNum Number 13 购买件数 └ avgOrderPrice String 12 平均笔单价 └ avgGoodsPrice String 12 平均件单价 └ point String 12 总积分 └ pointBalance String 12 积分余额 └ balance String 12 账户余额 VIPCardInfo VIPCardInfo └ VIPCardNo String VIP123 VIP的卡号编码 └ status Number 0 VIP卡的状态(0=未启用、1=正常、2=停用、4=挂失、5=休眠) └ storeCode String M123 所属门店编码 └ orgCode String X123 所属组织编码 └ operator String Y123 申请的营业员 └ serialCode String VIP23 VIP所属系列代码 └ serialName String VIPN123 VIP所属系列名称 └ groupCode String VIP123 VIP类别代码(VIP等级之类的信息) └ groupName String S123 VIP类别代码(如钻石会员等) └ expireDate String 2017-02-10 00:00:00 会员等级到期时间(YYYY-MM-DD hh:mm:ss) └ discount String 1 默认折扣(如9折为0.9000、默认为1.0000) └ isValid String Y 是否有效(Y/N;默认为Y) └ createTime String 2017-02-10 00:00:00 创建时间(YYYY-MM-DD hh:mm:ss) └ latestUpdateTime String 2017-02-10 00:00:00 最新更新时间(YYYY-MM-DD hh:mm:ss)

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

QimenClient client = new DefaultQimenClient(url, appkey, secret);
PosCustomerGetRequest req = new PosCustomerGetRequest();
req.setCustomerId("stub-cust-code");
req.setVersion("2.0");
req.setPage(1L);
req.setPageSize(12L);
req.setCustomerCode("GUK123");
req.setStartTime("2017-02-12 00:00:00");
req.setEndTime("2017-02-12 00:00:00");
PosCustomerGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

IQimenClient client = new DefaultQimenClient(url, appkey, secret);
PosCustomerGetRequest req = new PosCustomerGetRequest();
req.CustomerId = "stub-cust-code";
req.Version = "2.0";
req.Page = 1L;
req.PageSize = 12L;
req.CustomerCode = "GUK123";
req.StartTime = "2017-02-12 00:00:00";
req.EndTime = "2017-02-12 00:00:00";
PosCustomerGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new QimenPosCustomerGetRequest;
$request = new Request;
$request->page="1";
$request->page_size="12";
$request->customer_code="GUK123";
$request->start_time="2017-02-12 00:00:00";
$request->end_time="2017-02-12 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.customer.get&sign=812DE7A52325D0FBC1460C1DAED4C0C7&sign_method=md5&timestamp=2025-06-23+19%3A51%3A02&v=2.0&version=1' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
--data \
'<request>
  <pageSize>12</pageSize>
  <customerCode>GUK123</customerCode>
  <startTime>2017-02-12 00:00:00</startTime>
  <page>1</page>
  <endTime>2017-02-12 00:00:00</endTime>
</request>'

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

req=top.api.QimenPosCustomerGetRequest(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.customer.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.customer.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>
    <customers>
        <customer>
            <customerInfo>
                <customerCode>GU123</customerCode>
                <customerName>老王</customerName>
                <storeCode>M123</storeCode>
                <storeName>常二路门店</storeName>
                <orgCode>M123</orgCode>
                <regTime>2017-02-12 00:00:00</regTime>
                <regSource>MD</regSource>
                <isVIP>Y</isVIP>
                <contactInfo>
                    <name>老王</name>
                    <gender>M</gender>
                    <birthDate>2017-02-10</birthDate>
                    <career>码农</career>
                    <zipCode>043300</zipCode>
                    <tel>056789</tel>
                    <mobile>123456</mobile>
                    <fax>0567</fax>
                    <email>0867667</email>
                    <province>浙江</province>
                    <city>杭州</city>
                    <area>余杭</area>
                    <town>西溪</town>
                    <detailAddress>文一路</detailAddress>
                </contactInfo>
            </customerInfo>
            <VIPInfo>
                <VIPCode>VIP123</VIPCode>
                <firstPurchaseTime>2017-02-12 00:00:00</firstPurchaseTime>
                <lastPurchaseTime>2017-02-12 00:00:00</lastPurchaseTime>
                <amount>12</amount>
                <lastYearConsumption>12</lastYearConsumption>
                <orderNum>12</orderNum>
                <goodsNum>13</goodsNum>
                <avgOrderPrice>12</avgOrderPrice>
                <avgGoodsPrice>12</avgGoodsPrice>
                <point>12</point>
                <pointBalance>12</pointBalance>
                <balance>12</balance>
                <VIPCardInfo>
                    <VIPCardNo>VIP123</VIPCardNo>
                    <status>0</status>
                </VIPCardInfo>
                <storeCode>M123</storeCode>
                <orgCode>X123</orgCode>
                <operator>Y123</operator>
                <serialCode>VIP23</serialCode>
                <serialName>VIPN123</serialName>
                <groupCode>VIP123</groupCode>
                <groupName>S123</groupName>
                <expireDate>2017-02-10 00:00:00</expireDate>
                <discount>1</discount>
                <isValid>Y</isValid>
            </VIPInfo>
            <createTime>2017-02-10 00:00:00</createTime>
            <latestUpdateTime>2017-02-10 00:00:00</latestUpdateTime>
        </customer>
    </customers>
</response>

{
    "response":{
        "flag":"success",
        "code":"0",
        "message":"invalid appkey",
        "total":12,
        "customers":{
            "customer":[
                {
                    "customerInfo":{
                        "customerCode":"GU123",
                        "customerName":"老王",
                        "storeCode":"M123",
                        "storeName":"常二路门店",
                        "orgCode":"M123",
                        "regTime":"2017-02-12 00:00:00",
                        "regSource":"MD",
                        "isVIP":"Y",
                        "contactInfo":{
                            "name":"老王",
                            "gender":"M",
                            "birthDate":"2017-02-10",
                            "career":"码农",
                            "zipCode":"043300",
                            "tel":"056789",
                            "mobile":"123456",
                            "fax":"0567",
                            "email":"0867667",
                            "province":"浙江",
                            "city":"杭州",
                            "area":"余杭",
                            "town":"西溪",
                            "detailAddress":"文一路"
                        }
                    },
                    "VIPInfo":{
                        "VIPCode":"VIP123",
                        "firstPurchaseTime":"2017-02-12 00:00:00",
                        "lastPurchaseTime":"2017-02-12 00:00:00",
                        "amount":"12",
                        "lastYearConsumption":"12",
                        "orderNum":12,
                        "goodsNum":13,
                        "avgOrderPrice":"12",
                        "avgGoodsPrice":"12",
                        "point":"12",
                        "pointBalance":"12",
                        "balance":"12",
                        "VIPCardInfo":{
                            "VIPCardNo":"VIP123",
                            "status":0
                        },
                        "storeCode":"M123",
                        "orgCode":"X123",
                        "operator":"Y123",
                        "serialCode":"VIP23",
                        "serialName":"VIPN123",
                        "groupCode":"VIP123",
                        "groupName":"S123",
                        "expireDate":"2017-02-10 00:00:00",
                        "discount":"1",
                        "isValid":"Y"
                    },
                    "createTime":"2017-02-10 00:00:00",
                    "latestUpdateTime":"2017-02-10 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.customer.get (顾客信息获取接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ