淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param	DolphinSendPrizeParam	可选			入参
└ budget_type String 可选 COUNT 预算类型 └ amount Number 可选 1 下发数量 └ pass_through_info String 可选 0 透传参数 └ biz_from String 可选 ZFB 来源 └ benefit_type String 可选 MOVE_AND_SHOW 权益类型 └ benefit_conf_property String 可选 {} 权益配置参数 └ biz_unique_id String 可选 0 业务唯一流水 └ source String 可选 0 来源 └ user_id String 可选 0 用户ID └ modulus Number 可选 1 下发系数 └ biz_time Date 可选 2020-05-15 10:00:00 下发时间 └ ext_info String 可选 {} 扩展信息

名称	类型	示例值	描述
result	MpResult	{}	返回结果
└ success Boolean true 是否成功 └ error_code String 0 错误码 model DolphinSendPrizeResultDto {} 下发结果 send_prize_list Sendprizelist [] [] 下发权益列表 └ ext_info String {} 扩展信息 └ amount Number 1 下发数量 └ out_benefit_template_id String 1231321 外部权益模板 └ benefit_type String MOVE_AND_SHOW 权益类型 └ out_benefit_instance_id String 1231321 外部权益实例 └ error_msg_detail String 系统失败错误描述 └ biz_ext_map String {} 业务扩展信息 └ error_msg String 系统失败错误描述 └ error_level Number 0 错误级别

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaDamaiEcImktPrizeSendRequest req = new AlibabaDamaiEcImktPrizeSendRequest();
AlibabaDamaiEcImktPrizeSendRequest.DolphinSendPrizeParam obj1 = new AlibabaDamaiEcImktPrizeSendRequest.DolphinSendPrizeParam();
obj1.setBudgetType("COUNT");
obj1.setAmount(1L);
obj1.setPassThroughInfo("0");
obj1.setBizFrom("ZFB");
obj1.setBenefitType("MOVE_AND_SHOW");
obj1.setBenefitConfProperty("{}");
obj1.setBizUniqueId("0");
obj1.setSource("0");
obj1.setUserId("0");
obj1.setModulus(1L);
obj1.setBizTime(StringUtils.parseDateTime("2020-05-15 10:00:00"));
obj1.setExtInfo("{}");
req.setParam(obj1);
AlibabaDamaiEcImktPrizeSendResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaDamaiEcImktPrizeSendRequest req = new AlibabaDamaiEcImktPrizeSendRequest();
AlibabaDamaiEcImktPrizeSendRequest.DolphinSendPrizeParamDomain obj1 = new AlibabaDamaiEcImktPrizeSendRequest.DolphinSendPrizeParamDomain();
obj1.BudgetType = "COUNT";
obj1.Amount = 1L;
obj1.PassThroughInfo = "0";
obj1.BizFrom = "ZFB";
obj1.BenefitType = "MOVE_AND_SHOW";
obj1.BenefitConfProperty = "{}";
obj1.BizUniqueId = "0";
obj1.Source = "0";
obj1.UserId = "0";
obj1.Modulus = 1L;
obj1.BizTime = DateTime.Parse(2020-05-15 10:00:00");
obj1.ExtInfo = "{}";
req.Param_ = obj1;
AlibabaDamaiEcImktPrizeSendResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaDamaiEcImktPrizeSendRequest;
$param = new DolphinSendPrizeParam;
$param->budget_type="COUNT";
$param->amount="1";
$param->pass_through_info="0";
$param->biz_from="ZFB";
$param->benefit_type="MOVE_AND_SHOW";
$param->benefit_conf_property="{}";
$param->biz_unique_id="0";
$param->source="0";
$param->user_id="0";
$param->modulus="1";
$param->biz_time="2020-05-15 10:00:00";
$param->ext_info="{}";
$req->setParam(json_encode($param));
$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.damai.ec.imkt.prize.send' \
-d 'partner_id=apidoc' \
-d 'sign=D472750D844AF0F2E38A069EF607BE0E' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+16%3A29%3A51' \
-d 'v=2.0' \
-d 'param=null'

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

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

req.param=""
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.damai.ec.imkt.prize.send");
add_param(pRequest,"param","数据结构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',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.damai.ec.imkt.prize.send', {
	'param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_damai_ec_imkt_prize_send_response>
    <result>
        <success>true</success>
        <error_code>0</error_code>
        <model>
            <send_prize_list>
                <sendprizelist>
                    <ext_info>{}</ext_info>
                    <amount>1</amount>
                    <out_benefit_template_id>1231321</out_benefit_template_id>
                    <benefit_type>MOVE_AND_SHOW</benefit_type>
                    <out_benefit_instance_id>1231321</out_benefit_instance_id>
                </sendprizelist>
            </send_prize_list>
        </model>
        <error_msg_detail>系统失败</error_msg_detail>
        <biz_ext_map>{}</biz_ext_map>
        <error_msg>系统失败</error_msg>
        <error_level>0</error_level>
    </result>
</alibaba_damai_ec_imkt_prize_send_response>

{
    "alibaba_damai_ec_imkt_prize_send_response":{
        "result":{
            "success":true,
            "error_code":"0",
            "model":{
                "send_prize_list":{
                    "sendprizelist":[
                        {
                            "ext_info":"{}",
                            "amount":1,
                            "out_benefit_template_id":"1231321",
                            "benefit_type":"MOVE_AND_SHOW",
                            "out_benefit_instance_id":"1231321"
                        }
                    ]
                }
            },
            "error_msg_detail":"系统失败",
            "biz_ext_map":"{}",
            "error_msg":"系统失败",
            "error_level":0
        }
    }
}

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

alibaba.damai.ec.imkt.prize.send (大麦海豚券下发接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ