文档中心 > API类目 > 天猫服务平台

tmall.service.settlement.file.upload (文件上传（获取文件上传url）)

文件上传，传入文件信息后，返回文件上传url 和文件key，通过此url上传文件内容到oss，后续使用文件key将文件在其他接口中使用。

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	描述
file_name	String	必须	B202.pdf	文件名称（含扩展名 .pdf .jpg）
related_biz_id	String	必须	123	关联业务单号
content_md5	String	必须	4QrcOUm6Wau+VuBX8g+IPg==	文件内容MD5摘要，算法参见 https://help.aliyun.com/zh/oss/developer-reference/include-signatures-in-the-authorization-header?#section-i74-k35-5w4
file_cate	String	必须	invoice	文件分类：invoice->发票

响应参数

名称	类型	示例值	描述
display_msg	String	OK	结果消息
is_success	Boolean	true	是否成功
sys_error_code	String	SUCCESS	系统错误
file_key	String	aaa/bbb/ccc.pdf	文件key，上传文件的标识
url	String	https://xxx	文件上传url，有效时间30分钟
headers	Json	{}	上传请求时需携带的请求头，必须完整，否则签名会验证失败
sys_error_msg	String	成功	错误消息

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallServiceSettlementFileUploadRequest req = new TmallServiceSettlementFileUploadRequest();
req.setFileName("B202.pdf");
req.setRelatedBizId("123");
req.setContentMd5("4QrcOUm6Wau+VuBX8g+IPg==");
req.setFileCate("invoice");
TmallServiceSettlementFileUploadResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallServiceSettlementFileUploadRequest req = new TmallServiceSettlementFileUploadRequest();
req.FileName = "B202.pdf";
req.RelatedBizId = "123";
req.ContentMd5 = "4QrcOUm6Wau+VuBX8g+IPg==";
req.FileCate = "invoice";
TmallServiceSettlementFileUploadResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallServiceSettlementFileUploadRequest;
$req->setFileName("B202.pdf");
$req->setRelatedBizId("123");
$req->setContentMd5("4QrcOUm6Wau+VuBX8g+IPg==");
$req->setFileCate("invoice");
$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.service.settlement.file.upload' \
-d 'partner_id=apidoc' \
-d 'session=49577a19-7ae5-46b9-a97c-82414564fdf4' \
-d 'sign=D6BA027CEEEC5FFCCE973D968172488C' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+17%3A40%3A44' \
-d 'v=2.0' \
-d 'content_md5=4QrcOUm6Wau%2BVuBX8g%2BIPg%3D%3D' \
-d 'file_cate=invoice' \
-d 'file_name=B202.pdf' \
-d 'related_biz_id=123'

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

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

req.file_name="B202.pdf"
req.related_biz_id="123"
req.content_md5="4QrcOUm6Wau+VuBX8g+IPg=="
req.file_cate="invoice"
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.service.settlement.file.upload");
add_param(pRequest,"file_name","B202.pdf");
add_param(pRequest,"related_biz_id","123");
add_param(pRequest,"content_md5","4QrcOUm6Wau+VuBX8g+IPg==");
add_param(pRequest,"file_cate","invoice");
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.service.settlement.file.upload', {
	'file_name':'B202.pdf',
	'related_biz_id':'123',
	'content_md5':'4QrcOUm6Wau+VuBX8g+IPg==',
	'file_cate':'invoice'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<tmall_service_settlement_file_upload_response>
    <display_msg>OK</display_msg>
    <is_success>true</is_success>
    <sys_error_code>SUCCESS</sys_error_code>
    <file_key>aaa/bbb/ccc.pdf</file_key>
    <url>https://xxx</url>
    <headers>{}</headers>
    <sys_error_msg>成功</sys_error_msg>
</tmall_service_settlement_file_upload_response>

{
    "tmall_service_settlement_file_upload_response":{
        "display_msg":"OK",
        "is_success":true,
        "sys_error_code":"SUCCESS",
        "file_key":"aaa\/bbb\/ccc.pdf",
        "url":"https:\/\/xxx",
        "headers":"{}",
        "sys_error_msg":"成功"
    }
}

异常示例

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工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

天猫服务平台

tmall.service.settlement.file.upload (文件上传（获取文件上传url）)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ