淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
tp_request	CaseUploadRequest	必须			request
└ identity String 必须 TEMPLATE AMC身份标识 cases DebtCaseUploadDto [] 可选 [] 上传单据列表 └ id String 可选 CASE_001 债务单据标识 └ asset_id String 可选 ASSET_001 资产包ID └ debtor_name String 可选张三债务人姓名 └ id_card_number String 可选 333333333333333333 身份证号 └ phone_number String 可选 13800138000 联系电话 └ original_institution_name String 可选招商银行最初债权机构名称 └ original_unified_credit_code String 可选 123456789012345678 最初债权机构统一社会信用代码 └ current_institution_name String 可选招商银行当前债权/管理机构名称 └ current_unified_credit_code String 可选 123456789012345678 当前机构统一社会信用代码 └ debt_amount String 可选 10000 债务本金，元 └ interest_amount String 可选 2000 利息金额，元 └ late_fee String 可选 0 滞纳金金额，元 └ debt_start_date String 可选 2023-01-15 债务起始日 └ debt_due_date String 可选 2024-01-15 债务还款日 └ annual_interest_rate String 可选 0.08 年化利率 └ interest_calculation_method String 可选 EQUAL_PRINCIPAL_AND_INTEREST 还款计息方式 └ overdue_days Number 可选 30 逾期天数 └ has_relief_plan Boolean 可选 true 是否有纾困方案 relief_plan_details ReliefPlanDetailUploadDto [] 可选 [] 纾困方案详情 └ plan_type Number 可选 3 方案类型 └ outstanding_amount String 可选 8000 待还款金额，元 └ outstanding_principle_amount String 可选 8000 待还本金金额，元 └ handling_fee String 可选 0 手续费，元 └ delay_days Number 可选 0 延期期限，仅延期方案有 └ new_repay_date String 可选 2025-12-31 新还款日，仅延期方案有 └ principal_reduction String 可选 2000 本金减免，元 └ interest_reduction String 可选 2000 利息减免，元 └ late_fee_reduction String 可选 0 滞纳金减免，元 └ down_payment_ratio String 可选 0.1 首付比例 └ installment_count Number 可选 12 分期期数 └ first_repayment_grace_days Number 可选 8 首次还款宽限期 └ monthly_repayment_grace_days Number 可选 3 每月还款宽限期 └ handling_fee_reduction String 可选 2000 手续费减免，元 └ other_reduction String 可选 0 其余减免，元 └ relief_plan_expiry_date String 可选 2026-03-31 方案有效期 └ negotiable Boolean 可选 false 是否支持协商 └ total_amount String 可选 14000 债务总计金额，元 └ handling_fee String 可选 2000 手续费金额，元

名称	类型	示例值	描述
case_upload_top_result	CaseUploadTopResult		caseUploadTopResult
└ success Boolean true 是否成功 └ result_code String SUCCESS 结果码 └ result_msg String 成功结果说明 └ succeed_case_ids String [] Top,Pub 成功的单据ID └ failed_case_error_map String {} 失败的单据ID及原因

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AuctionZcReliefCaseUploadRequest req = new AuctionZcReliefCaseUploadRequest();
AuctionZcReliefCaseUploadRequest.CaseUploadRequest obj1 = new AuctionZcReliefCaseUploadRequest.CaseUploadRequest();
obj1.setIdentity("TEMPLATE");
List<AuctionZcReliefCaseUploadRequest.DebtCaseUploadDto> list3 = new ArrayList<AuctionZcReliefCaseUploadRequest.DebtCaseUploadDto>();
AuctionZcReliefCaseUploadRequest.DebtCaseUploadDto obj4 = new AuctionZcReliefCaseUploadRequest.DebtCaseUploadDto();
list3.add(obj4);
obj4.setId("CASE_001");
obj4.setAssetId("ASSET_001");
obj4.setDebtorName("张三");
obj4.setIdCardNumber("333333333333333333");
obj4.setPhoneNumber("13800138000");
obj4.setOriginalInstitutionName("招商银行");
obj4.setOriginalUnifiedCreditCode("123456789012345678");
obj4.setCurrentInstitutionName("招商银行");
obj4.setCurrentUnifiedCreditCode("123456789012345678");
obj4.setDebtAmount("10000");
obj4.setInterestAmount("2000");
obj4.setLateFee("0");
obj4.setDebtStartDate("2023-01-15");
obj4.setDebtDueDate("2024-01-15");
obj4.setAnnualInterestRate("0.08");
obj4.setInterestCalculationMethod("EQUAL_PRINCIPAL_AND_INTEREST");
obj4.setOverdueDays(30L);
obj4.setHasReliefPlan(true);
List<AuctionZcReliefCaseUploadRequest.ReliefPlanDetailUploadDto> list7 = new ArrayList<AuctionZcReliefCaseUploadRequest.ReliefPlanDetailUploadDto>();
AuctionZcReliefCaseUploadRequest.ReliefPlanDetailUploadDto obj8 = new AuctionZcReliefCaseUploadRequest.ReliefPlanDetailUploadDto();
list7.add(obj8);
obj8.setPlanType(3L);
obj8.setOutstandingAmount("8000");
obj8.setOutstandingPrincipleAmount("8000");
obj8.setHandlingFee("0");
obj8.setDelayDays(0L);
obj8.setNewRepayDate("2025-12-31");
obj8.setPrincipalReduction("2000");
obj8.setInterestReduction("2000");
obj8.setLateFeeReduction("0");
obj8.setDownPaymentRatio("0.1");
obj8.setInstallmentCount(12L);
obj8.setFirstRepaymentGraceDays(8L);
obj8.setMonthlyRepaymentGraceDays(3L);
obj8.setHandlingFeeReduction("2000");
obj8.setOtherReduction("0");
list5.setReliefPlanDetails(list7);
obj4.setReliefPlanExpiryDate("2026-03-31");
obj4.setNegotiable(false);
obj4.setTotalAmount("14000");
obj4.setHandlingFee("2000");
obj1.setCases(list3);
req.setTpRequest(obj1);
AuctionZcReliefCaseUploadResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AuctionZcReliefCaseUploadRequest req = new AuctionZcReliefCaseUploadRequest();
AuctionZcReliefCaseUploadRequest.CaseUploadRequestDomain obj1 = new AuctionZcReliefCaseUploadRequest.CaseUploadRequestDomain();
obj1.Identity = "TEMPLATE";
List<AuctionZcReliefCaseUploadRequest.DebtCaseUploadDtoDomain> list3 = new List<AuctionZcReliefCaseUploadRequest.DebtCaseUploadDtoDomain>();
AuctionZcReliefCaseUploadRequest.DebtCaseUploadDtoDomain obj4 = new AuctionZcReliefCaseUploadRequest.DebtCaseUploadDtoDomain();
list3.Add(obj4);
obj4.Id = "CASE_001";
obj4.AssetId = "ASSET_001";
obj4.DebtorName = "张三";
obj4.IdCardNumber = "333333333333333333";
obj4.PhoneNumber = "13800138000";
obj4.OriginalInstitutionName = "招商银行";
obj4.OriginalUnifiedCreditCode = "123456789012345678";
obj4.CurrentInstitutionName = "招商银行";
obj4.CurrentUnifiedCreditCode = "123456789012345678";
obj4.DebtAmount = "10000";
obj4.InterestAmount = "2000";
obj4.LateFee = "0";
obj4.DebtStartDate = "2023-01-15";
obj4.DebtDueDate = "2024-01-15";
obj4.AnnualInterestRate = "0.08";
obj4.InterestCalculationMethod = "EQUAL_PRINCIPAL_AND_INTEREST";
obj4.OverdueDays = 30L;
obj4.HasReliefPlan = true;
List<AuctionZcReliefCaseUploadRequest.ReliefPlanDetailUploadDtoDomain> list6 = new List<AuctionZcReliefCaseUploadRequest.ReliefPlanDetailUploadDtoDomain>();
AuctionZcReliefCaseUploadRequest.ReliefPlanDetailUploadDtoDomain obj7 = new AuctionZcReliefCaseUploadRequest.ReliefPlanDetailUploadDtoDomain();
list6.Add(obj7);
obj7.PlanType = 3L;
obj7.OutstandingAmount = "8000";
obj7.OutstandingPrincipleAmount = "8000";
obj7.HandlingFee = "0";
obj7.DelayDays = 0L;
obj7.NewRepayDate = "2025-12-31";
obj7.PrincipalReduction = "2000";
obj7.InterestReduction = "2000";
obj7.LateFeeReduction = "0";
obj7.DownPaymentRatio = "0.1";
obj7.InstallmentCount = 12L;
obj7.FirstRepaymentGraceDays = 8L;
obj7.MonthlyRepaymentGraceDays = 3L;
obj7.HandlingFeeReduction = "2000";
obj7.OtherReduction = "0";
obj4.ReliefPlanDetails= list6;
obj4.ReliefPlanExpiryDate = "2026-03-31";
obj4.Negotiable = false;
obj4.TotalAmount = "14000";
obj4.HandlingFee = "2000";
obj1.Cases= list3;
req.TpRequest_ = obj1;
AuctionZcReliefCaseUploadResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AuctionZcReliefCaseUploadRequest;
$tp_request = new CaseUploadRequest;
$tp_request->identity="TEMPLATE";
$cases = new DebtCaseUploadDto;
$cases->id="CASE_001";
$cases->asset_id="ASSET_001";
$cases->debtor_name="张三";
$cases->id_card_number="333333333333333333";
$cases->phone_number="13800138000";
$cases->original_institution_name="招商银行";
$cases->original_unified_credit_code="123456789012345678";
$cases->current_institution_name="招商银行";
$cases->current_unified_credit_code="123456789012345678";
$cases->debt_amount="10000";
$cases->interest_amount="2000";
$cases->late_fee="0";
$cases->debt_start_date="2023-01-15";
$cases->debt_due_date="2024-01-15";
$cases->annual_interest_rate="0.08";
$cases->interest_calculation_method="EQUAL_PRINCIPAL_AND_INTEREST";
$cases->overdue_days="30";
$cases->has_relief_plan="true";
$relief_plan_details = new ReliefPlanDetailUploadDto;
$relief_plan_details->plan_type="3";
$relief_plan_details->outstanding_amount="8000";
$relief_plan_details->outstanding_principle_amount="8000";
$relief_plan_details->handling_fee="0";
$relief_plan_details->delay_days="0";
$relief_plan_details->new_repay_date="2025-12-31";
$relief_plan_details->principal_reduction="2000";
$relief_plan_details->interest_reduction="2000";
$relief_plan_details->late_fee_reduction="0";
$relief_plan_details->down_payment_ratio="0.1";
$relief_plan_details->installment_count="12";
$relief_plan_details->first_repayment_grace_days="8";
$relief_plan_details->monthly_repayment_grace_days="3";
$relief_plan_details->handling_fee_reduction="2000";
$relief_plan_details->other_reduction="0";
$cases->relief_plan_details = $relief_plan_details;
$cases->relief_plan_expiry_date="2026-03-31";
$cases->negotiable="false";
$cases->total_amount="14000";
$cases->handling_fee="2000";
$tp_request->cases = $cases;
$req->setTpRequest(json_encode($tp_request));
$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=taobao.auction.zc.relief.case.upload' \
-d 'partner_id=apidoc' \
-d 'sign=E91A3F93416C316FC70A283F71399DE7' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-03-23+01%3A07%3A45' \
-d 'v=2.0' \
-d 'tp_request=null'

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

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

req.tp_request=""
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.auction.zc.relief.case.upload");
add_param(pRequest,"tp_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',
	'url': 'http://gw.api.taobao.com/router/rest'
});

client.execute('taobao.auction.zc.relief.case.upload', {
	'tp_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<auction_zc_relief_case_upload_response>
    <case_upload_top_result>
        <success>true</success>
        <result_code>SUCCESS</result_code>
        <result_msg>成功</result_msg>
        <succeed_case_ids>
            <string>Top</string>
            <string>Pub</string>
        </succeed_case_ids>
        <failed_case_error_map>{}</failed_case_error_map>
    </case_upload_top_result>
</auction_zc_relief_case_upload_response>

{
    "auction_zc_relief_case_upload_response":{
        "case_upload_top_result":{
            "success":true,
            "result_code":"SUCCESS",
            "result_msg":"成功",
            "succeed_case_ids":{
                "string":[
                    "Top",
                    "Pub"
                ]
            },
            "failed_case_error_map":"{}"
        }
    }
}

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.auction.zc.relief.case.upload (借据明细上传)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ