淘宝开放平台 - 文档中心

请求地址：

环境	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	可选
└ ownerCode String 可选货主编码,货主编码,string(50),, 货主编码,货主编码,string(50),, └ warehouseCode String 可选仓库编码,仓库编码,string(50),, 仓库编码,仓库编码,string(50),, └ adjustOrderCode String 可选调整单编码,调整单编码,string(50),, 调整单编码,调整单编码,string(50),, └ adjustTime String 可选订单创建时间,订单创建时间,string(50),, 订单创建时间,订单创建时间,string(50),, └ adjustType String 可选库存调整类型,库存调整类型,string(50),, 库存调整类型,库存调整类型,string(50),, relatedOrders RelatedOrders 可选关联订单 └ orderType String 可选关联的订单类型,关联的订单类型,string(50),, 关联的订单类型,关联的订单类型,string(50),, └ orderCode String 可选关联的订单编号,关联的订单编号,string(50),, 关联的订单编号,关联的订单编号,string(50),, └ remark String 可选备注,备注,string(50),, 备注,备注,string(50),, items Items 可选商品列表 item Item 可选商品 └ itemCode String 可选商品编码,,string(50),, 商品编码,,string(50),, └ itemId String 可选仓储系统商品ID,,string(50),, 仓储系统商品ID,,string(50),, └ inventoryType String 可选库存类型,,string(50),, 库存类型,,string(50),, └ planQty String 可选调整数量,,string(50),, 调整数量,,string(50),, └ batchCode String 可选批次编码,,string(50),, 批次编码,,string(50),, └ productDate String 可选商品生产日期,,string(50),, 商品生产日期,,string(50),, └ expireDate String 可选商品过期日期,,string(50),, 商品过期日期,,string(50),, └ produceCode String 可选生产批号,,string(50),, 生产批号,,string(50),, └ snCode String 可选商品序列号,,string(50),, 商品序列号,,string(50),, └ remark String 可选备注,,string(50),, 备注,,string(50),,

名称	类型	示例值	描述
response	Response
└ flag String 响应结果,success\|failure,string (10),必填响应结果,success\|failure,string (10),必填 └ code String 响应码,,string (50), 响应码,,string (50), └ message String 响应信息,,string (100), 响应信息,,string (100),

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

QimenClient client = new DefaultQimenClient(url, appkey, secret);
InventorySynchronizeRequest req = new InventorySynchronizeRequest();
req.setCustomerId("stub-cust-code");
req.setVersion("2.0");
req.setOwnerCode("货主编码,货主编码,string(50),,");
req.setWarehouseCode("仓库编码,仓库编码,string(50),,");
req.setAdjustOrderCode("调整单编码,调整单编码,string(50),,");
req.setAdjustTime("订单创建时间,订单创建时间,string(50),,");
req.setAdjustType("库存调整类型,库存调整类型,string(50),,");
RelatedOrders obj1 = new RelatedOrders();
obj1.setOrderType("关联的订单类型,关联的订单类型,string(50),,");
obj1.setOrderCode("关联的订单编号,关联的订单编号,string(50),,");
req.setRelatedOrders(obj1);
req.setRemark("备注,备注,string(50),,");
Items obj2 = new Items();
Item obj3 = new Item();
obj3.setItemCode("商品编码,,string(50),,");
obj3.setItemId("仓储系统商品ID,,string(50),,");
obj3.setInventoryType("库存类型,,string(50),,");
obj3.setPlanQty("调整数量,,string(50),,");
obj3.setBatchCode("批次编码,,string(50),,");
obj3.setProductDate("商品生产日期,,string(50),,");
obj3.setExpireDate("商品过期日期,,string(50),,");
obj3.setProduceCode("生产批号,,string(50),,");
obj3.setSnCode("商品序列号,,string(50),,");
obj3.setRemark("备注,,string(50),,");
obj2.setItem(obj3);
req.setItems(obj2);
InventorySynchronizeResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

IQimenClient client = new DefaultQimenClient(url, appkey, secret);
InventorySynchronizeRequest req = new InventorySynchronizeRequest();
req.CustomerId = "stub-cust-code";
req.Version = "2.0";
req.OwnerCode = "货主编码,货主编码,string(50),,";
req.WarehouseCode = "仓库编码,仓库编码,string(50),,";
req.AdjustOrderCode = "调整单编码,调整单编码,string(50),,";
req.AdjustTime = "订单创建时间,订单创建时间,string(50),,";
req.AdjustType = "库存调整类型,库存调整类型,string(50),,";
InventorySynchronizeRequest.RelatedOrdersDomain obj1 = new InventorySynchronizeRequest.RelatedOrdersDomain();
req.RelatedOrders_= obj1;
obj1.OrderType = "关联的订单类型,关联的订单类型,string(50),,";
obj1.OrderCode = "关联的订单编号,关联的订单编号,string(50),,";
req.RelatedOrders_ = obj1;
req.Remark = "备注,备注,string(50),,";
InventorySynchronizeRequest.ItemsDomain obj2 = new InventorySynchronizeRequest.ItemsDomain();
req.Items_= obj2;
List<InventorySynchronizeRequest.ItemDomain> list4 = new List<InventorySynchronizeRequest.ItemDomain>();
InventorySynchronizeRequest.ItemDomain obj5 = new InventorySynchronizeRequest.ItemDomain();
list4.Add(obj5);
obj2.Item_ = list4;
obj5.ItemCode = "商品编码,,string(50),,";
obj5.ItemId = "仓储系统商品ID,,string(50),,";
obj5.InventoryType = "库存类型,,string(50),,";
obj5.PlanQty = "调整数量,,string(50),,";
obj5.BatchCode = "批次编码,,string(50),,";
obj5.ProductDate = "商品生产日期,,string(50),,";
obj5.ExpireDate = "商品过期日期,,string(50),,";
obj5.ProduceCode = "生产批号,,string(50),,";
obj5.SnCode = "商品序列号,,string(50),,";
obj5.Remark = "备注,,string(50),,";
obj2.Item= list6;
req.Items_ = obj2;
InventorySynchronizeResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new QimenInventorySynchronizeRequest;
$request = new Request;
$request->owner_code="货主编码,货主编码,string(50),,";
$request->warehouse_code="仓库编码,仓库编码,string(50),,";
$request->adjust_order_code="调整单编码,调整单编码,string(50),,";
$request->adjust_time="订单创建时间,订单创建时间,string(50),,";
$request->adjust_type="库存调整类型,库存调整类型,string(50),,";
$relatedOrders = new RelatedOrders;
$relatedOrders->order_type="关联的订单类型,关联的订单类型,string(50),,";
$relatedOrders->order_code="关联的订单编号,关联的订单编号,string(50),,";
$request->relatedOrders = $relatedOrders;
$request->remark="备注,备注,string(50),,";
$items = new Items;
$item = new Item;
$item->item_code="商品编码,,string(50),,";
$item->item_id="仓储系统商品ID,,string(50),,";
$item->inventory_type="库存类型,,string(50),,";
$item->plan_qty="调整数量,,string(50),,";
$item->batch_code="批次编码,,string(50),,";
$item->product_date="商品生产日期,,string(50),,";
$item->expire_date="商品过期日期,,string(50),,";
$item->produce_code="生产批号,,string(50),,";
$item->sn_code="商品序列号,,string(50),,";
$item->remark="备注,,string(50),,";
$items->item = $item;
$request->items = $items;
$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.inventory.synchronize&sign=3109078CC1194674688EC45E0691A356&sign_method=md5&timestamp=2025-04-28+18%3A19%3A36&v=2.0&version=1' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
--data \
'<request>
  <adjustTime>订单创建时间,订单创建时间,string(50),,</adjustTime>
  <adjustOrderCode>调整单编码,调整单编码,string(50),,</adjustOrderCode>
  <ownerCode>货主编码,货主编码,string(50),,</ownerCode>
  <adjustType>库存调整类型,库存调整类型,string(50),,</adjustType>
  <relatedOrders>
    <orderType>关联的订单类型,关联的订单类型,string(50),,</orderType>
    <orderCode>关联的订单编号,关联的订单编号,string(50),,</orderCode>
  </relatedOrders>
  <remark>备注,备注,string(50),,</remark>
  <items>
    <item>
      <itemId>仓储系统商品ID,,string(50),,</itemId>
      <produceCode>生产批号,,string(50),,</produceCode>
      <inventoryType>库存类型,,string(50),,</inventoryType>
      <planQty>调整数量,,string(50),,</planQty>
      <snCode>商品序列号,,string(50),,</snCode>
      <itemCode>商品编码,,string(50),,</itemCode>
      <batchCode>批次编码,,string(50),,</batchCode>
      <expireDate>商品过期日期,,string(50),,</expireDate>
      <remark>备注,,string(50),,</remark>
      <productDate>商品生产日期,,string(50),,</productDate>
    </item>
  </items>
  <warehouseCode>仓库编码,仓库编码,string(50),,</warehouseCode>
</request>'

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

req=top.api.QimenInventorySynchronizeRequest(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.inventory.synchronize");
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.inventory.synchronize', {
	'request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<response>
    <flag>响应结果,success|failure,string (10),必填</flag>
    <code>响应码,,string (50),</code>
    <message>响应信息,,string (100),</message>
</response>

{
    "response":{
        "flag":"响应结果,success|failure,string (10),必填",
        "code":"响应码,,string (50),",
        "message":"响应信息,,string (100),"
    }
}

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

开放平台

奇门仓储API

taobao.qimen.inventory.synchronize (库存状态同步接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ