淘宝开放平台 - 文档中心

请求地址：

环境	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 每页条数 └ itemCode String 可选 SKU123 商品SKU编码 └ 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 总条数 items Item [] 商品列表 └ productCode String ER123 ERP的商品spu编码 └ itemCode String E123 ERP的商品sku编码 └ originCode String F123 原厂编码 └ itemName String 旺旺商品名称 └ barCode String T1234 条形码 └ skuProperty String XXL) 商品属性(如红色 └ color String Y 颜色编码 └ size String C 尺码编码 └ grossWeight String 1 毛重(千克) └ netWeight String 1 净重(千克) └ stockUnit String 个商品计量单位 └ categoryId String 123 商品类别Id └ categoryName String 旺旺商品类别名称 └ standardPrice String 12 标准价 └ referencePrice String 12 参考价 └ retailPrice String 12 零售价 └ tagPrice String 12 吊牌价 └ costPrice String 12 成本价 └ discount String 1 折扣(如9折为0.9000) priceAdjustment PriceAdjustment 价格信息 └ type String 0 调价类型(0=调价格、1=调折扣、2=调价格调折扣) └ standardPrice String 12 调价后的价格 └ discount String 1 折扣(如9折为0.9000) └ startDate String 2017-01-12 调价开始日期(YYYY-MM-DD) └ endDate String 2017-01-12 调价结束日期(YYYY-MM-DD) └ seasonCode String J12 季节编码 └ seasonName String 春季季节名称 └ brandCode String P123 品牌代码 └ brandName 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);
PosItemsGetRequest req = new PosItemsGetRequest();
req.setCustomerId("stub-cust-code");
req.setVersion("2.0");
req.setPage(1L);
req.setPageSize(12L);
req.setItemCode("SKU123");
req.setStartTime("2017-02-12 00:00:00");
req.setEndTime("2017-02-12 00:00:00");
PosItemsGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

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

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new QimenPosItemsGetRequest;
$request = new Request;
$request->page="1";
$request->page_size="12";
$request->item_code="SKU123";
$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.items.get&sign=2DC90D674FAE4E179A9D1D061EB335F4&sign_method=md5&timestamp=2025-05-21+17%3A44%3A06&v=2.0&version=1' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
--data \
'<request>
  <itemCode>SKU123</itemCode>
  <pageSize>12</pageSize>
  <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.QimenPosItemsGetRequest(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.items.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.items.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>
    <items>
        <item>
            <productCode>ER123</productCode>
            <itemCode>E123</itemCode>
            <originCode>F123</originCode>
            <itemName>旺旺</itemName>
            <barCode>T1234</barCode>
            <skuProperty>XXL)</skuProperty>
            <color>Y</color>
            <size>C</size>
            <grossWeight>1</grossWeight>
            <netWeight>1</netWeight>
            <stockUnit>个</stockUnit>
            <categoryId>123</categoryId>
            <categoryName>旺旺</categoryName>
            <standardPrice>12</standardPrice>
            <referencePrice>12</referencePrice>
            <retailPrice>12</retailPrice>
            <tagPrice>12</tagPrice>
            <costPrice>12</costPrice>
            <discount>1</discount>
            <priceAdjustment>
                <type>0</type>
                <standardPrice>12</standardPrice>
                <discount>1</discount>
                <startDate>2017-01-12</startDate>
                <endDate>2017-01-12</endDate>
            </priceAdjustment>
            <seasonCode>J12</seasonCode>
            <seasonName>春季</seasonName>
            <brandCode>P123</brandCode>
            <brandName>阿玛尼</brandName>
            <isValid>Y</isValid>
            <createTime>2017-02-10 00:00:00</createTime>
            <latestUpdateTime>2017-02-10 00:00:00</latestUpdateTime>
        </item>
    </items>
</response>

{
    "response":{
        "flag":"success",
        "code":"0",
        "message":"invalid appkey",
        "total":12,
        "items":{
            "item":[
                {
                    "productCode":"ER123",
                    "itemCode":"E123",
                    "originCode":"F123",
                    "itemName":"旺旺",
                    "barCode":"T1234",
                    "skuProperty":"XXL)",
                    "color":"Y",
                    "size":"C",
                    "grossWeight":"1",
                    "netWeight":"1",
                    "stockUnit":"个",
                    "categoryId":"123",
                    "categoryName":"旺旺",
                    "standardPrice":"12",
                    "referencePrice":"12",
                    "retailPrice":"12",
                    "tagPrice":"12",
                    "costPrice":"12",
                    "discount":"1",
                    "priceAdjustment":{
                        "type":"0",
                        "standardPrice":"12",
                        "discount":"1",
                        "startDate":"2017-01-12",
                        "endDate":"2017-01-12"
                    },
                    "seasonCode":"J12",
                    "seasonName":"春季",
                    "brandCode":"P123",
                    "brandName":"阿玛尼",
                    "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.items.get (商品获取接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ