淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param_gseller_activity_request	GsellerActivityRequest	必须			入参对象
└ activity_id Number 必须 123 活动id └ activity_name String 必须活动1 活动名称 └ app_code String 必须 farfetch 应用标识 └ event_enum String 必须 XianhuoAdd 商品类型 └ type String 必须 XianHuo 类型 extra_map ExtraMap 必须 {"UMP_END_TIME":"2020-12-12 23:59:59","UMP_BEGIN_TIME":"2020-12-10 00:00:00"} 活动时间填充 └ ump_end_time Date 必须 2020-11-30 16:00:00 包税活动的开始时间，要和activityId对应 └ ump_begin_time Date 必须 2020-11-30 17:00:00 包税活动的结束时间，要和activityId对应 seller_list TmpSeller [] 可选卖家维度对象 └ activity_id Number 必须 123 活动id └ item_id_list Number [] 必须 1,2,3 包税商品列表

名称	类型	示例值	描述
result	ResultBean		封装StoreBean 返回top接口的实体
└ code String null code └ error_code String 123 错误code └ error_msg String 错误信息错误文案 └ msg String null message obj GsellerActivityResponse 数据对象返回的对象 └ extra_map String {"FAIL_ITEM_MAP":[123,234],"OK_ITEM_LIST":[]} 返回结果成功和失败的列表 └ success Boolean true 结果

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallHkTaxfreeItemSetRequest req = new TmallHkTaxfreeItemSetRequest();
TmallHkTaxfreeItemSetRequest.GsellerActivityRequest obj1 = new TmallHkTaxfreeItemSetRequest.GsellerActivityRequest();
obj1.setActivityId(123L);
obj1.setActivityName("活动1");
obj1.setAppCode("farfetch");
obj1.setEventEnum("XianhuoAdd");
obj1.setType("XianHuo");
TmallHkTaxfreeItemSetRequest.ExtraMap obj2 = new TmallHkTaxfreeItemSetRequest.ExtraMap();
obj2.setUmpEndTime(StringUtils.parseDateTime("2020-11-30 16:00:00"));
obj2.setUmpBeginTime(StringUtils.parseDateTime("2020-11-30 17:00:00"));
obj1.setExtraMap(obj2);
List<TmallHkTaxfreeItemSetRequest.TmpSeller> list4 = new ArrayList<TmallHkTaxfreeItemSetRequest.TmpSeller>();
TmallHkTaxfreeItemSetRequest.TmpSeller obj5 = new TmallHkTaxfreeItemSetRequest.TmpSeller();
list4.add(obj5);
obj5.setActivityId(123L);
obj5.setItemIdList(new Long[] { 1,2,3 };
);
obj1.setSellerList(list4);
req.setParamGsellerActivityRequest(obj1);
TmallHkTaxfreeItemSetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallHkTaxfreeItemSetRequest req = new TmallHkTaxfreeItemSetRequest();
TmallHkTaxfreeItemSetRequest.GsellerActivityRequestDomain obj1 = new TmallHkTaxfreeItemSetRequest.GsellerActivityRequestDomain();
obj1.ActivityId = 123L;
obj1.ActivityName = "活动1";
obj1.AppCode = "farfetch";
obj1.EventEnum = "XianhuoAdd";
obj1.Type = "XianHuo";
TmallHkTaxfreeItemSetRequest.ExtraMapDomain obj2 = new TmallHkTaxfreeItemSetRequest.ExtraMapDomain();
obj2.UmpEndTime = DateTime.Parse(2020-11-30 16:00:00");
obj2.UmpBeginTime = DateTime.Parse(2020-11-30 17:00:00");
obj1.ExtraMap= obj2;
List<TmallHkTaxfreeItemSetRequest.TmpSellerDomain> list4 = new List<TmallHkTaxfreeItemSetRequest.TmpSellerDomain>();
TmallHkTaxfreeItemSetRequest.TmpSellerDomain obj5 = new TmallHkTaxfreeItemSetRequest.TmpSellerDomain();
list4.Add(obj5);
obj5.ActivityId = 123L;
obj5.ItemIdList = new long[] { 1,2,3 };
;
obj1.SellerList= list4;
req.ParamGsellerActivityRequest_ = obj1;
TmallHkTaxfreeItemSetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallHkTaxfreeItemSetRequest;
$param_gseller_activity_request = new GsellerActivityRequest;
$param_gseller_activity_request->activity_id="123";
$param_gseller_activity_request->activity_name="活动1";
$param_gseller_activity_request->app_code="farfetch";
$param_gseller_activity_request->event_enum="XianhuoAdd";
$param_gseller_activity_request->type="XianHuo";
$extra_map = new ExtraMap;
$extra_map->ump_end_time="2020-11-30 16:00:00";
$extra_map->ump_begin_time="2020-11-30 17:00:00";
$param_gseller_activity_request->extra_map = $extra_map;
$seller_list = new TmpSeller;
$seller_list->activity_id="123";
$seller_list->item_id_list="1,2,3";
$param_gseller_activity_request->seller_list = $seller_list;
$req->setParamGsellerActivityRequest(json_encode($param_gseller_activity_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=tmall.hk.taxfree.item.set' \
-d 'partner_id=apidoc' \
-d 'session=f8be3f46-02de-49e9-8caf-ffcbf1970deb' \
-d 'sign=598BB916D821837E2EEE3C2773C18F72' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+22%3A13%3A38' \
-d 'v=2.0' \
-d 'param_gseller_activity_request=null'

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

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

req.param_gseller_activity_request=""
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,"tmall.hk.taxfree.item.set");
add_param(pRequest,"param_gseller_activity_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('tmall.hk.taxfree.item.set', {
	'param_gseller_activity_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tmall_hk_taxfree_item_set_response>
    <result>
        <code>null</code>
        <error_code>123</error_code>
        <error_msg>错误信息</error_msg>
        <msg>null</msg>
        <obj>
            <extra_map>{&quot;FAIL_ITEM_MAP&quot;:[123,234],&quot;OK_ITEM_LIST&quot;:[]}</extra_map>
        </obj>
        <success>true</success>
    </result>
</tmall_hk_taxfree_item_set_response>

{
    "tmall_hk_taxfree_item_set_response":{
        "result":{
            "code":"null",
            "error_code":"123",
            "error_msg":"错误信息",
            "msg":"null",
            "obj":{
                "extra_map":"{\"FAIL_ITEM_MAP\":[123,234],\"OK_ITEM_LIST\":[]}"
            },
            "success":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

tmall.hk.taxfree.item.set (天猫国际设置商品包税)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ