淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
old_order_id	Number	可选	1234567890		旧机单id

名称	类型	示例值	描述
data	OfnPreRedPacketDTO	{}	前置补贴红包
action_list OfnPreRedPacketActionDto [] [] 操作列表 └ id Number 1 主键 └ gmt_create Date 2020-01-01 00:00:00 创建时间 └ gmt_modified Date 2020-01-01 00:00:00 修改时间 └ action_type Number 1 操作类型。1=天猫发预付红包；2=天猫发尾款红包；3=天猫扣回红包；4=回收商扣回红包 after_fund_record_list OfnPreRedPacketFundRecordDto [] [] 资金池的记录 └ fund_id Number 1 资产编号 └ change_amount Number 77 变化金额 └ status Number 1 状态。初始化=1，重试中=2，失败=3，成功=4 └ activity_id Number 1 活动id └ credit_pay Boolean true 是否信用单 └ credit_pay_limit Number 500000 信用额度，单位分 └ end_already_send_amount Number 199 尾款部分-已经发放的金额，单位分 └ end_plan_send_amount Number 199 尾款部分-计划发放的金额，单位分 └ end_wait_send_amount Number 0 尾款部分-等待发放的金额，单位分 └ gmt_create Date 2020-01-01 00:00:00 创建时间 └ gmt_modified Date 2020-01-01 00:00:00 修改时间 └ id Number 1 主键 └ new_item_coupon_price Number 22 新机优惠价 └ new_item_id Number 1111 新机id └ new_order_id Number 4444444444 新机订单id └ old_item_actual_price Number 3333 旧机质检价 └ old_item_apprize_price Number 3300 旧机评估价 └ old_item_spu_id Number 1111 旧机id └ old_order_id Number 6666666666 旧机单id └ plan_send_amount Number 9999 计划发放的金额，单位分 └ pre_already_send_amount Number 7777 预发部分-已经发放的金额，单位分 └ pre_plan_send_amount Number 5555 预发部分-计划发放的金额，单位分 └ pre_wait_send_amount Number 2222 预发部分-等待发放的金额，单位分 └ status Number 2 状态。初始化=1，重试中=2，失败=3，成功=4 └ tmall_already_deduct_amount Number 0 由回收商已经扣回的金额，单位分 └ tmall_wait_deduct_amount Number 0 等待回收商扣回的金额，单位分 └ tp_already_deduct_amount Number 0 由天猫已经扣回的金额，单位分 └ tp_wait_deduct_amount Number 0 等待天猫扣回的金额，单位分 └ version Number 1 乐观锁 └ mode Number 1 1=前置补贴，2=后置补贴

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
RecycleOfnpreredpacketGetRequest req = new RecycleOfnpreredpacketGetRequest();
req.setOldOrderId(1234567890L);
RecycleOfnpreredpacketGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
RecycleOfnpreredpacketGetRequest req = new RecycleOfnpreredpacketGetRequest();
req.OldOrderId = 1234567890L;
RecycleOfnpreredpacketGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new RecycleOfnpreredpacketGetRequest;
$req->setOldOrderId("1234567890");
$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.recycle.ofnpreredpacket.get' \
-d 'partner_id=apidoc' \
-d 'sign=26276F8AB2E5A9E33335316A4E599373' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-04+16%3A41%3A12' \
-d 'v=2.0' \
-d 'old_order_id=1234567890'

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

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

req.old_order_id=1234567890
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.recycle.ofnpreredpacket.get");
add_param(pRequest,"old_order_id","1234567890");
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('taobao.recycle.ofnpreredpacket.get', {
	'old_order_id':'1234567890'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<recycle_ofnpreredpacket_get_response>
    <data>
        <action_list>
            <ofn_pre_red_packet_action_dto>
                <id>1</id>
                <gmt_create>2020-01-01 00:00:00</gmt_create>
                <gmt_modified>2020-01-01 00:00:00</gmt_modified>
                <action_type>1</action_type>
                <after_fund_record_list>
                    <ofn_pre_red_packet_fund_record_dto>
                        <fund_id>1</fund_id>
                        <change_amount>77</change_amount>
                    </ofn_pre_red_packet_fund_record_dto>
                </after_fund_record_list>
                <status>1</status>
            </ofn_pre_red_packet_action_dto>
        </action_list>
        <activity_id>1</activity_id>
        <credit_pay>true</credit_pay>
        <credit_pay_limit>500000</credit_pay_limit>
        <end_already_send_amount>199</end_already_send_amount>
        <end_plan_send_amount>199</end_plan_send_amount>
        <end_wait_send_amount>0</end_wait_send_amount>
        <gmt_create>2020-01-01 00:00:00</gmt_create>
        <gmt_modified>2020-01-01 00:00:00</gmt_modified>
        <id>1</id>
        <new_item_coupon_price>22</new_item_coupon_price>
        <new_item_id>1111</new_item_id>
        <new_order_id>4444444444</new_order_id>
        <old_item_actual_price>3333</old_item_actual_price>
        <old_item_apprize_price>3300</old_item_apprize_price>
        <old_item_spu_id>1111</old_item_spu_id>
        <old_order_id>6666666666</old_order_id>
        <plan_send_amount>9999</plan_send_amount>
        <pre_already_send_amount>7777</pre_already_send_amount>
        <pre_plan_send_amount>5555</pre_plan_send_amount>
        <pre_wait_send_amount>2222</pre_wait_send_amount>
        <status>2</status>
        <tmall_already_deduct_amount>0</tmall_already_deduct_amount>
        <tmall_wait_deduct_amount>0</tmall_wait_deduct_amount>
        <tp_already_deduct_amount>0</tp_already_deduct_amount>
        <tp_wait_deduct_amount>0</tp_wait_deduct_amount>
        <version>1</version>
        <mode>1</mode>
    </data>
</recycle_ofnpreredpacket_get_response>

{
    "recycle_ofnpreredpacket_get_response":{
        "data":{
            "action_list":{
                "ofn_pre_red_packet_action_dto":[
                    {
                        "id":1,
                        "gmt_create":"2020-01-01 00:00:00",
                        "gmt_modified":"2020-01-01 00:00:00",
                        "action_type":1,
                        "after_fund_record_list":{
                            "ofn_pre_red_packet_fund_record_dto":[
                                {
                                    "fund_id":1,
                                    "change_amount":77
                                }
                            ]
                        },
                        "status":1
                    }
                ]
            },
            "activity_id":1,
            "credit_pay":true,
            "credit_pay_limit":500000,
            "end_already_send_amount":199,
            "end_plan_send_amount":199,
            "end_wait_send_amount":0,
            "gmt_create":"2020-01-01 00:00:00",
            "gmt_modified":"2020-01-01 00:00:00",
            "id":1,
            "new_item_coupon_price":22,
            "new_item_id":1111,
            "new_order_id":4444444444,
            "old_item_actual_price":3333,
            "old_item_apprize_price":3300,
            "old_item_spu_id":1111,
            "old_order_id":6666666666,
            "plan_send_amount":9999,
            "pre_already_send_amount":7777,
            "pre_plan_send_amount":5555,
            "pre_wait_send_amount":2222,
            "status":2,
            "tmall_already_deduct_amount":0,
            "tmall_wait_deduct_amount":0,
            "tp_already_deduct_amount":0,
            "tp_wait_deduct_amount":0,
            "version":1,
            "mode":1
        }
    }
}

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.recycle.ofnpreredpacket.get (服务商查询前置补贴红包的最新数据)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ