淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
node_container_dto	NodeContainerDTO	必须			xx
└ ownership_institution String 必须 DRF DRF 大润发 SXC-生鲜仓 └ node_code String 必须 DRF1001 code processing_list ContainerStockDTO [] 必须 xx 操作批次数组 sub_list ContainerStockSubDTO [] 必须 xx 子批次数组 └ action_type String 必须 DECREASE INCREASE -增加。DECREASE-减烧 └ number Number 必须 123 数量 └ specification_key String 必须 XL 物资规格 └ sub_batch_id String 必须 12 子批次号 └ batch_id String 必须 20230131XXX 批次号批次号不要重复，主要用于幂等和记录日志 └ operator_id String 可选操作人id 操作人id 选填 └ operator_name String 可选操作人name 操作人name 选填 └ node_type String 必须 WAREHOUSE WAREHOUSE("仓"), CFC("CFC"), DP("配送站"), TMS("运输/司机"), UNKNOWN("其他/未知"); └ timestamp Number 必须 1670312304966 时间戳

名称	类型	示例值	描述
result	Boolean	true	true 成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaTcCompassMaterialStockChangeRequest req = new AlibabaTcCompassMaterialStockChangeRequest();
AlibabaTcCompassMaterialStockChangeRequest.NodeContainerDTO obj1 = new AlibabaTcCompassMaterialStockChangeRequest.NodeContainerDTO();
obj1.setOwnershipInstitution("DRF");
obj1.setNodeCode("DRF1001");
List<AlibabaTcCompassMaterialStockChangeRequest.ContainerStockDTO> list3 = new ArrayList<AlibabaTcCompassMaterialStockChangeRequest.ContainerStockDTO>();
AlibabaTcCompassMaterialStockChangeRequest.ContainerStockDTO obj4 = new AlibabaTcCompassMaterialStockChangeRequest.ContainerStockDTO();
list3.add(obj4);
List<AlibabaTcCompassMaterialStockChangeRequest.ContainerStockSubDTO> list7 = new ArrayList<AlibabaTcCompassMaterialStockChangeRequest.ContainerStockSubDTO>();
AlibabaTcCompassMaterialStockChangeRequest.ContainerStockSubDTO obj8 = new AlibabaTcCompassMaterialStockChangeRequest.ContainerStockSubDTO();
list7.add(obj8);
obj8.setActionType("DECREASE");
obj8.setNumber(123L);
obj8.setSpecificationKey("XL");
obj8.setSubBatchId("12");
list5.setSubList(list7);
obj4.setBatchId("20230131XXX");
obj4.setOperatorId("操作人id");
obj4.setOperatorName("操作人name");
obj1.setProcessingList(list3);
obj1.setNodeType("WAREHOUSE");
obj1.setTimestamp(1670312304966L);
req.setNodeContainerDto(obj1);
AlibabaTcCompassMaterialStockChangeResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaTcCompassMaterialStockChangeRequest req = new AlibabaTcCompassMaterialStockChangeRequest();
AlibabaTcCompassMaterialStockChangeRequest.NodeContainerDTODomain obj1 = new AlibabaTcCompassMaterialStockChangeRequest.NodeContainerDTODomain();
obj1.OwnershipInstitution = "DRF";
obj1.NodeCode = "DRF1001";
List<AlibabaTcCompassMaterialStockChangeRequest.ContainerStockDTODomain> list3 = new List<AlibabaTcCompassMaterialStockChangeRequest.ContainerStockDTODomain>();
AlibabaTcCompassMaterialStockChangeRequest.ContainerStockDTODomain obj4 = new AlibabaTcCompassMaterialStockChangeRequest.ContainerStockDTODomain();
list3.Add(obj4);
List<AlibabaTcCompassMaterialStockChangeRequest.ContainerStockSubDTODomain> list6 = new List<AlibabaTcCompassMaterialStockChangeRequest.ContainerStockSubDTODomain>();
AlibabaTcCompassMaterialStockChangeRequest.ContainerStockSubDTODomain obj7 = new AlibabaTcCompassMaterialStockChangeRequest.ContainerStockSubDTODomain();
list6.Add(obj7);
obj7.ActionType = "DECREASE";
obj7.Number = 123L;
obj7.SpecificationKey = "XL";
obj7.SubBatchId = "12";
obj4.SubList= list6;
obj4.BatchId = "20230131XXX";
obj4.OperatorId = "操作人id";
obj4.OperatorName = "操作人name";
obj1.ProcessingList= list3;
obj1.NodeType = "WAREHOUSE";
obj1.Timestamp = 1670312304966L;
req.NodeContainerDto_ = obj1;
AlibabaTcCompassMaterialStockChangeResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaTcCompassMaterialStockChangeRequest;
$node_container_dto = new NodeContainerDTO;
$node_container_dto->ownership_institution="DRF";
$node_container_dto->node_code="DRF1001";
$processing_list = new ContainerStockDTO;
$sub_list = new ContainerStockSubDTO;
$sub_list->action_type="DECREASE";
$sub_list->number="123";
$sub_list->specification_key="XL";
$sub_list->sub_batch_id="12";
$processing_list->sub_list = $sub_list;
$processing_list->batch_id="20230131XXX";
$processing_list->operator_id="操作人id";
$processing_list->operator_name="操作人name";
$node_container_dto->processing_list = $processing_list;
$node_container_dto->node_type="WAREHOUSE";
$node_container_dto->timestamp="1670312304966";
$req->setNodeContainerDto(json_encode($node_container_dto));
$resp = $c->execute($req);

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=alibaba.tc.compass.material.stock.change' \
-d 'partner_id=apidoc' \
-d 'sign=C61A55A2B052524DAB6AC28B82773682' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-21+16%3A49%3A13' \
-d 'v=2.0' \
-d 'node_container_dto=null'

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

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

req.node_container_dto="数据结构示例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,"alibaba.tc.compass.material.stock.change");
add_param(pRequest,"node_container_dto","数据结构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('alibaba.tc.compass.material.stock.change', {
	'node_container_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_tc_compass_material_stock_change_response>
    <result>true</result>
</alibaba_tc_compass_material_stock_change_response>

{
    "alibaba_tc_compass_material_stock_change_response":{
        "result":true
    }
}

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

alibaba.tc.compass.material.stock.change (物资系统库存变更)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ