淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param0	BenefitInstanceDealRequest	可选			入参
└ deal_time Date 可选 2019-08-08 00:00:00 履约时间 └ region String 可选 type:1;val:{"cityCode":"460200","provinceCode":"460000","regionCode":"460204","storeCode":"N01293"} 履约地点 └ deal_action String 必须 type:1;val:{"consumeAmount":1,"restAmount":0,"settlePriceUnit":11000,"totalAmount":1} json格式，详询开发 └ instance_id Number 必须 123 权益资产实例 id └ mix_uid String 可选 AAFbb-f0AAgOrLpFIt9ATDrn 淘系混淆 uid └ out_order_id String 可选 123 外部订单 id

名称	类型	示例值	描述
result	ResultSupport	not null	结果支持对象
└ error_message String 未授权错误信息 model BenefitInstanceDealResponse not null 结果对象 └ out_order_id String longteng_012 入参的外部订单号 └ record_id Number 123 核销明细 id └ error_code String 123 错误码 └ success Boolean true 结果是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaBenefitInstanceWriteoffRequest req = new AlibabaBenefitInstanceWriteoffRequest();
AlibabaBenefitInstanceWriteoffRequest.BenefitInstanceDealRequest obj1 = new AlibabaBenefitInstanceWriteoffRequest.BenefitInstanceDealRequest();
obj1.setDealTime(StringUtils.parseDateTime("2019-08-08 00:00:00"));
obj1.setRegion("type:1;val:{\"cityCode\":\"460200\",\"provinceCode\":\"460000\",\"regionCode\":\"460204\",\"storeCode\":\"N01293\"}");
obj1.setDealAction("type:1;val:{\"consumeAmount\":1,\"restAmount\":0,\"settlePriceUnit\":11000,\"totalAmount\":1}");
obj1.setInstanceId(123L);
obj1.setMixUid("AAFbb-f0AAgOrLpFIt9ATDrn");
obj1.setOutOrderId("123");
req.setParam0(obj1);
AlibabaBenefitInstanceWriteoffResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaBenefitInstanceWriteoffRequest req = new AlibabaBenefitInstanceWriteoffRequest();
AlibabaBenefitInstanceWriteoffRequest.BenefitInstanceDealRequestDomain obj1 = new AlibabaBenefitInstanceWriteoffRequest.BenefitInstanceDealRequestDomain();
obj1.DealTime = DateTime.Parse(2019-08-08 00:00:00");
obj1.Region = "type:1;val:{\"cityCode\":\"460200\",\"provinceCode\":\"460000\",\"regionCode\":\"460204\",\"storeCode\":\"N01293\"}";
obj1.DealAction = "type:1;val:{\"consumeAmount\":1,\"restAmount\":0,\"settlePriceUnit\":11000,\"totalAmount\":1}";
obj1.InstanceId = 123L;
obj1.MixUid = "AAFbb-f0AAgOrLpFIt9ATDrn";
obj1.OutOrderId = "123";
req.Param0_ = obj1;
AlibabaBenefitInstanceWriteoffResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaBenefitInstanceWriteoffRequest;
$param0 = new BenefitInstanceDealRequest;
$param0->deal_time="2019-08-08 00:00:00";
$param0->region="type:1;val:{\"cityCode\":\"460200\",\"provinceCode\":\"460000\",\"regionCode\":\"460204\",\"storeCode\":\"N01293\"}";
$param0->deal_action="type:1;val:{\"consumeAmount\":1,\"restAmount\":0,\"settlePriceUnit\":11000,\"totalAmount\":1}";
$param0->instance_id="123";
$param0->mix_uid="AAFbb-f0AAgOrLpFIt9ATDrn";
$param0->out_order_id="123";
$req->setParam0(json_encode($param0));
$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.benefit.instance.writeoff' \
-d 'partner_id=apidoc' \
-d 'session=a630a084-7c0a-4477-b3fe-1ab2965d8c75' \
-d 'sign=EADD95D19ECFC73D0D14C1A53451F80E' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-24+16%3A04%3A19' \
-d 'v=2.0' \
-d 'param0=null'

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

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

req.param0=""
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.benefit.instance.writeoff");
add_param(pRequest,"param0","数据结构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.benefit.instance.writeoff', {
	'param0':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_benefit_instance_writeoff_response>
    <result>
        <error_message>未授权</error_message>
        <model>
            <out_order_id>longteng_012</out_order_id>
            <record_id>123</record_id>
        </model>
        <error_code>123</error_code>
        <success>true</success>
    </result>
</alibaba_benefit_instance_writeoff_response>

{
    "alibaba_benefit_instance_writeoff_response":{
        "result":{
            "error_message":"未授权",
            "model":{
                "out_order_id":"longteng_012",
                "record_id":123
            },
            "error_code":"123",
            "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

alibaba.benefit.instance.writeoff (核销权益资产)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ