淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
cancel_distribute_request	CancelDistributeRequest	必须			取消商品分销入参
└ request_time Number 必须 1639205668000 业务请求时间。时间戳。毫秒 └ request_id String 必须 xxx 业务请求ID，用于幂等 cancel_distribute_info_list CancelDistributeInfo [] 必须取消详情 └ item_id String 必须 1110111 【必传】要取消的商品itemId └ sku_id String 可选 11011 要取消的商品skuId, 如果没有则不需要传 └ cancel_all Boolean 必须 true 【必传】取消所有铺货,如果设置为false，则需要设置 distributorShopUserIdList └ distributor_shop_user_id_list Number [] 可选要取消铺货的分销商ID列表,如果 cancelAll = true, 则不需要设置此字段,如果 cancelAll = false，则此字段必填

名称	类型	示例值	描述
cancel_distribute_response	TopResponse		返回结构体
└ code String xxxxxx 返回信息码 data CancelDistributeResponse 业务处理结果。 cancel_distribute_detail_list CancelDistributeDetail [] 处理结果。打平到 item + 分销商粒度。处理成功和处理失败都会返回 └ item_id String 100111 传入的商品id └ sku_id String 100111 传入的商品skuId └ distributor_shop_user_id Number 100111 分销商 shopUserId └ distributor_company_name String 测试分销商账号001 分销商昵称 └ success Boolean true 处理结果 └ error_code String ERROR_CODE 错误编码 └ error_message String 错误信息错误信息 └ success Boolean true 成功或者失败 └ error_code String xxxxxx 错误码 └ error_message String 123 错误内容 └ success Boolean true 调用接口是否成功。调用成功之后，需要看data里面的success，才能知道业务处理是否成功 └ message String xxxxxx 返回信息 └ trace_id String 123 操作码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaDchainAoxiangItemDistributionBatchCancelRequest req = new AlibabaDchainAoxiangItemDistributionBatchCancelRequest();
AlibabaDchainAoxiangItemDistributionBatchCancelRequest.CancelDistributeRequest obj1 = new AlibabaDchainAoxiangItemDistributionBatchCancelRequest.CancelDistributeRequest();
obj1.setRequestTime(1639205668000L);
obj1.setRequestId("xxx");
List<AlibabaDchainAoxiangItemDistributionBatchCancelRequest.CancelDistributeInfo> list3 = new ArrayList<AlibabaDchainAoxiangItemDistributionBatchCancelRequest.CancelDistributeInfo>();
AlibabaDchainAoxiangItemDistributionBatchCancelRequest.CancelDistributeInfo obj4 = new AlibabaDchainAoxiangItemDistributionBatchCancelRequest.CancelDistributeInfo();
list3.add(obj4);
obj4.setItemId("1110111");
obj4.setSkuId("11011");
obj4.setCancelAll(true);
obj4.setDistributorShopUserIdList(new Long[] {  };
);
obj1.setCancelDistributeInfoList(list3);
req.setCancelDistributeRequest(obj1);
AlibabaDchainAoxiangItemDistributionBatchCancelResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaDchainAoxiangItemDistributionBatchCancelRequest req = new AlibabaDchainAoxiangItemDistributionBatchCancelRequest();
AlibabaDchainAoxiangItemDistributionBatchCancelRequest.CancelDistributeRequestDomain obj1 = new AlibabaDchainAoxiangItemDistributionBatchCancelRequest.CancelDistributeRequestDomain();
obj1.RequestTime = 1639205668000L;
obj1.RequestId = "xxx";
List<AlibabaDchainAoxiangItemDistributionBatchCancelRequest.CancelDistributeInfoDomain> list3 = new List<AlibabaDchainAoxiangItemDistributionBatchCancelRequest.CancelDistributeInfoDomain>();
AlibabaDchainAoxiangItemDistributionBatchCancelRequest.CancelDistributeInfoDomain obj4 = new AlibabaDchainAoxiangItemDistributionBatchCancelRequest.CancelDistributeInfoDomain();
list3.Add(obj4);
obj4.ItemId = "1110111";
obj4.SkuId = "11011";
obj4.CancelAll = true;
obj4.DistributorShopUserIdList = new long[] {  };
;
obj1.CancelDistributeInfoList= list3;
req.CancelDistributeRequest_ = obj1;
AlibabaDchainAoxiangItemDistributionBatchCancelResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaDchainAoxiangItemDistributionBatchCancelRequest;
$cancel_distribute_request = new CancelDistributeRequest;
$cancel_distribute_request->request_time="1639205668000";
$cancel_distribute_request->request_id="xxx";
$cancel_distribute_info_list = new CancelDistributeInfo;
$cancel_distribute_info_list->item_id="1110111";
$cancel_distribute_info_list->sku_id="11011";
$cancel_distribute_info_list->cancel_all="true";
$cancel_distribute_info_list->distributor_shop_user_id_list="";
$cancel_distribute_request->cancel_distribute_info_list = $cancel_distribute_info_list;
$req->setCancelDistributeRequest(json_encode($cancel_distribute_request));
$resp = $c->execute($req, $sessionKey);

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.dchain.aoxiang.item.distribution.batch.cancel' \
-d 'partner_id=apidoc' \
-d 'session=184149e9-7659-44e2-8f04-c28478045b23' \
-d 'sign=86B6703A8A6A16A52CB9C51AE575BDF1' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-11+05%3A16%3A41' \
-d 'v=2.0' \
-d 'cancel_distribute_request=null'

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

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

req.cancel_distribute_request="数据结构示例JSON格式"
try:
	resp= req.getResponse(sessionkey)
	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.dchain.aoxiang.item.distribution.batch.cancel");
add_param(pRequest,"cancel_distribute_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
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.dchain.aoxiang.item.distribution.batch.cancel', {
	'cancel_distribute_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_dchain_aoxiang_item_distribution_batch_cancel_response>
    <cancel_distribute_response>
        <code>xxxxxx</code>
        <data>
            <cancel_distribute_detail_list>
                <cancel_distribute_detail>
                    <item_id>100111</item_id>
                    <sku_id>100111</sku_id>
                    <distributor_shop_user_id>100111</distributor_shop_user_id>
                    <distributor_company_name>测试分销商账号001</distributor_company_name>
                    <success>true</success>
                    <error_code>ERROR_CODE</error_code>
                    <error_message>错误信息</error_message>
                </cancel_distribute_detail>
            </cancel_distribute_detail_list>
            <success>true</success>
            <error_code>xxxxxx</error_code>
            <error_message>123</error_message>
        </data>
        <success>true</success>
        <message>xxxxxx</message>
        <trace_id>123</trace_id>
    </cancel_distribute_response>
</alibaba_dchain_aoxiang_item_distribution_batch_cancel_response>

{
    "alibaba_dchain_aoxiang_item_distribution_batch_cancel_response":{
        "cancel_distribute_response":{
            "code":"xxxxxx",
            "data":{
                "cancel_distribute_detail_list":{
                    "cancel_distribute_detail":[
                        {
                            "item_id":"100111",
                            "sku_id":"100111",
                            "distributor_shop_user_id":100111,
                            "distributor_company_name":"测试分销商账号001",
                            "success":true,
                            "error_code":"ERROR_CODE",
                            "error_message":"错误信息"
                        }
                    ]
                },
                "success":true,
                "error_code":"xxxxxx",
                "error_message":"123"
            },
            "success":true,
            "message":"xxxxxx",
            "trace_id":"123"
        }
    }
}

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

开放平台

天猫供应链

alibaba.dchain.aoxiang.item.distribution.batch.cancel (取消商品分销)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ