淘宝开放平台

请求地址：

环境	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	GetSceneBasedCouponParam	必须			请求参数
└ lease_code String 必须 ykse 租户编码 └ coupon_code String 必须 D94KGT9N7 优惠券码 └ cinema_link_id String 必须 7777 影城内码 └ channel_code String 必须 POS_7777 渠道编码 └ ticket String 可选 1 影票信息 └ goods String 可选 1 卖品信息

名称	类型	示例值	描述
result	SingleResult		查询结果
└ success Boolean true 成功与否 └ result_code String SUCCESS 结果编码 └ result_msg String 成功结果信息 └ inner_code String innerCode 内部编码 data PartnerCoupon 返回数据 └ coupon_code String D94KGT9N7 券码 └ coupon_name String 10元代金券券名称 └ template_type Number 1 券类型 └ template_type_name String 代金券券类型名称 └ product_type Number 1 适用商品类型 └ product_type_name String 影票券适用商品类型名称 └ base_price Number 1000 基础售价 └ end_time String 2022-01-01 失效日期 └ ticket_value Number 500 适用影票的面值/限额 └ good_value Number 500 适用卖品的面值/限额 └ exchange_policy Number 1 兑换策略((1.一对一 3.兑换券-自定义兑换规则)) └ support_compensate Boolean true 是否支持补差 └ compensate_type Number 1 0.自定义补差 1.按影票原价补差 2.按最低票价补差 defect_compensate_amounts DefectCompensateAmounts [] 自定义补差范围明细 └ defect_count Number 1 缺失数量 └ amount Number 123 补差金额 └ issuer_name String 测试影院券发行影院名称 └ account_id String dhaksas73823 会员id └ require_pin_code Boolean true 是否必须pin码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LarkPosCouponGetcouponbycodeRequest req = new LarkPosCouponGetcouponbycodeRequest();
LarkPosCouponGetcouponbycodeRequest.GetSceneBasedCouponParam obj1 = new LarkPosCouponGetcouponbycodeRequest.GetSceneBasedCouponParam();
obj1.setLeaseCode("ykse");
obj1.setCouponCode("D94KGT9N7");
obj1.setCinemaLinkId("7777");
obj1.setChannelCode("POS_7777");
obj1.setTicket("1");
obj1.setGoods("1");
req.setParam(obj1);
LarkPosCouponGetcouponbycodeResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
LarkPosCouponGetcouponbycodeRequest req = new LarkPosCouponGetcouponbycodeRequest();
LarkPosCouponGetcouponbycodeRequest.GetSceneBasedCouponParamDomain obj1 = new LarkPosCouponGetcouponbycodeRequest.GetSceneBasedCouponParamDomain();
obj1.LeaseCode = "ykse";
obj1.CouponCode = "D94KGT9N7";
obj1.CinemaLinkId = "7777";
obj1.ChannelCode = "POS_7777";
obj1.Ticket = "1";
obj1.Goods = "1";
req.Param_ = obj1;
LarkPosCouponGetcouponbycodeResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new LarkPosCouponGetcouponbycodeRequest;
$param = new GetSceneBasedCouponParam;
$param->lease_code="ykse";
$param->coupon_code="D94KGT9N7";
$param->cinema_link_id="7777";
$param->channel_code="POS_7777";
$param->ticket="1";
$param->goods="1";
$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=taobao.lark.pos.coupon.getcouponbycode' \
-d 'partner_id=apidoc' \
-d 'sign=E33560384ECF03B72A75282760A573B2' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-23+20%3A05%3A08' \
-d 'v=2.0' \
-d 'param=null'

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

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

req.param="数据结构示例JSON格式"
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.lark.pos.coupon.getcouponbycode");
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('taobao.lark.pos.coupon.getcouponbycode', {
	'param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<lark_pos_coupon_getcouponbycode_response>
    <result>
        <success>true</success>
        <result_code>SUCCESS</result_code>
        <result_msg>成功</result_msg>
        <inner_code>innerCode</inner_code>
        <data>
            <coupon_code>D94KGT9N7</coupon_code>
            <coupon_name>10元代金券</coupon_name>
            <template_type>1</template_type>
            <template_type_name>代金券</template_type_name>
            <product_type>1</product_type>
            <product_type_name>影票券</product_type_name>
            <base_price>1000</base_price>
            <end_time>2022-01-01</end_time>
            <ticket_value>500</ticket_value>
            <good_value>500</good_value>
            <exchange_policy>1</exchange_policy>
            <support_compensate>true</support_compensate>
            <compensate_type>1</compensate_type>
            <defect_compensate_amounts>
                <defect_compensate_amounts>
                    <defect_count>1</defect_count>
                    <amount>123</amount>
                </defect_compensate_amounts>
            </defect_compensate_amounts>
            <issuer_name>测试影院</issuer_name>
            <account_id>dhaksas73823</account_id>
            <require_pin_code>true</require_pin_code>
        </data>
    </result>
</lark_pos_coupon_getcouponbycode_response>

{
    "lark_pos_coupon_getcouponbycode_response":{
        "result":{
            "success":true,
            "result_code":"SUCCESS",
            "result_msg":"成功",
            "inner_code":"innerCode",
            "data":{
                "coupon_code":"D94KGT9N7",
                "coupon_name":"10元代金券",
                "template_type":1,
                "template_type_name":"代金券",
                "product_type":1,
                "product_type_name":"影票券",
                "base_price":1000,
                "end_time":"2022-01-01",
                "ticket_value":500,
                "good_value":500,
                "exchange_policy":1,
                "support_compensate":true,
                "compensate_type":1,
                "defect_compensate_amounts":{
                    "defect_compensate_amounts":[
                        {
                            "defect_count":1,
                            "amount":123
                        }
                    ]
                },
                "issuer_name":"测试影院",
                "account_id":"dhaksas73823",
                "require_pin_code":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下载

阿里影业云智API

taobao.lark.pos.coupon.getcouponbycode (根据券码查询券信息-结算场景)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ