淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
batch_no	String	必须	batch92837492	扫描的批次号
status	Number	可选	0	扫描状态，0=开始ocr，1=ocr结束，2=开始查验，3=查验结束
invoice_count	Number	可选	15	该批次对应的发票数量，扫描结束和查验结束status=1，3时必填
success	Boolean	必须	true	驱动是否成功，true=成功，false=失败
error_code	String	可选	003	错误码，success=false时填入
error_message	String	可选	扫描仪被占用	错误信息，success=false时必填

名称	类型	示例值	描述
is_success	Boolean	true	是否回传成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaEinvoiceIncomeScanReturnRequest req = new AlibabaEinvoiceIncomeScanReturnRequest();
req.setBatchNo("batch92837492");
req.setStatus(0L);
req.setInvoiceCount(15L);
req.setSuccess(true);
req.setErrorCode("003");
req.setErrorMessage("扫描仪被占用");
AlibabaEinvoiceIncomeScanReturnResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaEinvoiceIncomeScanReturnRequest req = new AlibabaEinvoiceIncomeScanReturnRequest();
req.BatchNo = "batch92837492";
req.Status = 0L;
req.InvoiceCount = 15L;
req.Success = true;
req.ErrorCode = "003";
req.ErrorMessage = "扫描仪被占用";
AlibabaEinvoiceIncomeScanReturnResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaEinvoiceIncomeScanReturnRequest;
$req->setBatchNo("batch92837492");
$req->setStatus("0");
$req->setInvoiceCount("15");
$req->setSuccess("true");
$req->setErrorCode("003");
$req->setErrorMessage("扫描仪被占用");
$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=alibaba.einvoice.income.scan.return' \
-d 'partner_id=apidoc' \
-d 'sign=D9831D824D51E6153330C0A8B9C0961C' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-10+15%3A32%3A06' \
-d 'v=2.0' \
-d 'batch_no=batch92837492' \
-d 'error_code=003' \
-d 'error_message=%E6%89%AB%E6%8F%8F%E4%BB%AA%E8%A2%AB%E5%8D%A0%E7%94%A8' \
-d 'invoice_count=15' \
-d 'status=0' \
-d 'success=true'

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

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

req.batch_no="batch92837492"
req.status=0
req.invoice_count=15
req.success=true
req.error_code="003"
req.error_message="扫描仪被占用"
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,"alibaba.einvoice.income.scan.return");
add_param(pRequest,"batch_no","batch92837492");
add_param(pRequest,"status","0");
add_param(pRequest,"invoice_count","15");
add_param(pRequest,"success","true");
add_param(pRequest,"error_code","003");
add_param(pRequest,"error_message","扫描仪被占用");
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',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.einvoice.income.scan.return', {
	'batch_no':'batch92837492',
	'status':'0',
	'invoice_count':'15',
	'success':'true',
	'error_code':'003',
	'error_message':'扫描仪被占用'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_einvoice_income_scan_return_response>
    <is_success>true</is_success>
</alibaba_einvoice_income_scan_return_response>

{
    "alibaba_einvoice_income_scan_return_response":{
        "is_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下载

开放平台

电子发票

alibaba.einvoice.income.scan.return (进项扫描状态回传)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ