淘宝开放平台 - 文档中心

请求地址：

环境	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 每页条数 └ storeCode String 可选 M123 门店编码 └ clerkCode String 可选 M123 POS中的店员编码 └ 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 总条数 clerks Clerk [] 店员信息 └ storeCode String M123 门店编码 └ clerkCode String M123 POS中的店员编码 └ sourceClerkCode String E123 ERP中的店员编码 └ clerkName String Y123 店员名称 └ clerkType String DZ 店员类型(DZ=店长、SYY=收银员、SHY=售货员、OTHER=其他) contactInfo ContactInfo 店员信息 └ name String 老王姓名 └ birthDate String 2017-02-12 出生年月(YYYY-MM-DD) └ gender String M 性别(M=男性、F=女性) └ career String 码农职业 └ zipCode String 043356 邮编 └ tel String 087654 固定电话 └ mobile String 123456 移动电话 └ fax String 12345 传真 └ email String 098765 电子邮箱 └ province String 浙江省份 └ city String 杭州城市 └ area String 余杭区域 └ town String 西溪村镇 └ detailAddress String 文一路详细地址 └ 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);
PosClerkGetRequest req = new PosClerkGetRequest();
req.setCustomerId("stub-cust-code");
req.setVersion("2.0");
req.setPage(1L);
req.setPageSize(12L);
req.setStoreCode("M123");
req.setClerkCode("M123");
req.setStartTime("2017-02-12 00:00:00");
req.setEndTime("2017-02-12 00:00:00");
PosClerkGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

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

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new QimenPosClerkGetRequest;
$request = new Request;
$request->page="1";
$request->page_size="12";
$request->store_code="M123";
$request->clerk_code="M123";
$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.clerk.get&sign=9091D2376CC86F162BC82C61C6892A26&sign_method=md5&timestamp=2025-05-21+18%3A10%3A50&v=2.0&version=1' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
--data \
'<request>
  <clerkCode>M123</clerkCode>
  <pageSize>12</pageSize>
  <startTime>2017-02-12 00:00:00</startTime>
  <page>1</page>
  <endTime>2017-02-12 00:00:00</endTime>
  <storeCode>M123</storeCode>
</request>'

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

req=top.api.QimenPosClerkGetRequest(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.clerk.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.clerk.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>
    <clerks>
        <clerk>
            <storeCode>M123</storeCode>
            <clerkCode>M123</clerkCode>
            <sourceClerkCode>E123</sourceClerkCode>
            <clerkName>Y123</clerkName>
            <clerkType>DZ</clerkType>
            <contactInfo>
                <name>老王</name>
                <birthDate>2017-02-12</birthDate>
                <gender>M</gender>
                <career>码农</career>
                <zipCode>043356</zipCode>
                <tel>087654</tel>
                <mobile>123456</mobile>
                <fax>12345</fax>
                <email>098765</email>
                <province>浙江</province>
                <city>杭州</city>
                <area>余杭</area>
                <town>西溪</town>
                <detailAddress>文一路</detailAddress>
            </contactInfo>
            <isValid>Y</isValid>
            <createTime>2017-02-10 00:00:00</createTime>
            <latestUpdateTime>2017-02-10 00:00:00</latestUpdateTime>
        </clerk>
    </clerks>
</response>

{
    "response":{
        "flag":"success",
        "code":"0",
        "message":"invalid appkey",
        "total":12,
        "clerks":{
            "clerk":[
                {
                    "storeCode":"M123",
                    "clerkCode":"M123",
                    "sourceClerkCode":"E123",
                    "clerkName":"Y123",
                    "clerkType":"DZ",
                    "contactInfo":{
                        "name":"老王",
                        "birthDate":"2017-02-12",
                        "gender":"M",
                        "career":"码农",
                        "zipCode":"043356",
                        "tel":"087654",
                        "mobile":"123456",
                        "fax":"12345",
                        "email":"098765",
                        "province":"浙江",
                        "city":"杭州",
                        "area":"余杭",
                        "town":"西溪",
                        "detailAddress":"文一路"
                    },
                    "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.clerk.get (店员信息获取接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ