淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
rq	OpenInvoiceRuleRq	必须			入参对象
└ all_employe Boolean 必须 true 是否适用所有员工 └ corp_id String 必须 corpid1 第三方企业id entities Entity [] 可选 [] all_employe为true时非必传，否则必传 └ id String 可选 123 实体id，all_employe为false时，entities里元素的id必传 └ name String 可选张三实体名，all_employe为false时，entities里元素的name必传 └ type Number 可选 1 1：员工，all_employe为false时，entities里元素的type必传 └ third_part_id String 必须 i123 第三方发票id └ version Number 可选 2 商旅开放平台传2

名称	类型	示例值	描述
result	OpenInvoiceRuleRs	module	返回值
└ add_num Number 1 新增数 └ remove_num Number 1 删除数
result_code	Number	0	结果码
result_msg	String	成功	结果描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlitripBtripInvoiceSettingRuleRequest req = new AlitripBtripInvoiceSettingRuleRequest();
AlitripBtripInvoiceSettingRuleRequest.OpenInvoiceRuleRq obj1 = new AlitripBtripInvoiceSettingRuleRequest.OpenInvoiceRuleRq();
obj1.setAllEmploye(true);
obj1.setCorpId("corpid1");
List<AlitripBtripInvoiceSettingRuleRequest.Entity> list3 = new ArrayList<AlitripBtripInvoiceSettingRuleRequest.Entity>();
AlitripBtripInvoiceSettingRuleRequest.Entity obj4 = new AlitripBtripInvoiceSettingRuleRequest.Entity();
list3.add(obj4);
obj4.setId("123");
obj4.setName("张三");
obj4.setType(1L);
obj1.setEntities(list3);
obj1.setThirdPartId("i123");
obj1.setVersion(2L);
req.setRq(obj1);
AlitripBtripInvoiceSettingRuleResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlitripBtripInvoiceSettingRuleRequest req = new AlitripBtripInvoiceSettingRuleRequest();
AlitripBtripInvoiceSettingRuleRequest.OpenInvoiceRuleRqDomain obj1 = new AlitripBtripInvoiceSettingRuleRequest.OpenInvoiceRuleRqDomain();
obj1.AllEmploye = true;
obj1.CorpId = "corpid1";
List<AlitripBtripInvoiceSettingRuleRequest.EntityDomain> list3 = new List<AlitripBtripInvoiceSettingRuleRequest.EntityDomain>();
AlitripBtripInvoiceSettingRuleRequest.EntityDomain obj4 = new AlitripBtripInvoiceSettingRuleRequest.EntityDomain();
list3.Add(obj4);
obj4.Id = "123";
obj4.Name = "张三";
obj4.Type = 1L;
obj1.Entities= list3;
obj1.ThirdPartId = "i123";
obj1.Version = 2L;
req.Rq_ = obj1;
AlitripBtripInvoiceSettingRuleResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlitripBtripInvoiceSettingRuleRequest;
$rq = new OpenInvoiceRuleRq;
$rq->all_employe="true";
$rq->corp_id="corpid1";
$entities = new Entity;
$entities->id="123";
$entities->name="张三";
$entities->type="1";
$rq->entities = $entities;
$rq->third_part_id="i123";
$rq->version="2";
$req->setRq(json_encode($rq));
$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=alitrip.btrip.invoice.setting.rule' \
-d 'partner_id=apidoc' \
-d 'session=3524a9f2-809f-484a-b002-d8471904e1ca' \
-d 'sign=34A148D8A78BDA8E8D0AEB5CE7D7386E' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-12-04+01%3A16%3A24' \
-d 'v=2.0' \
-d 'rq=null'

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

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

req.rq=""
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,"alitrip.btrip.invoice.setting.rule");
add_param(pRequest,"rq","数据结构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('alitrip.btrip.invoice.setting.rule', {
	'rq':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alitrip_btrip_invoice_setting_rule_response>
    <result>
        <add_num>1</add_num>
        <remove_num>1</remove_num>
    </result>
    <result_code>0</result_code>
    <result_msg>成功</result_msg>
</alitrip_btrip_invoice_setting_rule_response>

{
    "alitrip_btrip_invoice_setting_rule_response":{
        "result":{
            "add_num":1,
            "remove_num":1
        },
        "result_code":0,
        "result_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测试工具错误码查询工具 SDK下载

开放平台

商旅API

alitrip.btrip.invoice.setting.rule (发票规则设置)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ