淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
channel_code	String	必须	POS_50000	渠道编码
cinema_link_id	String	必须	50000	影院内码
out_id	String	必须	224e6be330634d17805a3655c863edf1	外部id
order_id	String	必须	190717000446X500005193	订单号
amount	Number	必须	1	金额
reason	String	可选	不想要了	原因
workstation_id	String	必须	14949	工作站id
operator_user_id	String	可选	ifatczh	操作人
is_return_back	Boolean	可选	true	是否原路
payment_list	String	可选	[]	支付列表
workstation_name	String	可选	ifatczh	工作站名称

名称	类型	示例值	描述
data	Json	{ "innerCode":null, "success":true, "resultCode":"SUCCESS", "resultMsg":"成功" }	接口结果

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LarkPosOrderRefundcouponRequest req = new LarkPosOrderRefundcouponRequest();
req.setChannelCode("POS_50000");
req.setCinemaLinkId("50000");
req.setOutId("224e6be330634d17805a3655c863edf1");
req.setOrderId("190717000446X500005193");
req.setAmount(1L);
req.setReason("不想要了");
req.setWorkstationId("14949");
req.setOperatorUserId("ifatczh");
req.setIsReturnBack(true);
req.setPaymentList("[]");
req.setWorkstationName("ifatczh");
LarkPosOrderRefundcouponResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
LarkPosOrderRefundcouponRequest req = new LarkPosOrderRefundcouponRequest();
req.ChannelCode = "POS_50000";
req.CinemaLinkId = "50000";
req.OutId = "224e6be330634d17805a3655c863edf1";
req.OrderId = "190717000446X500005193";
req.Amount = 1L;
req.Reason = "不想要了";
req.WorkstationId = "14949";
req.OperatorUserId = "ifatczh";
req.IsReturnBack = true;
req.PaymentList = "[]";
req.WorkstationName = "ifatczh";
LarkPosOrderRefundcouponResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new LarkPosOrderRefundcouponRequest;
$req->setChannelCode("POS_50000");
$req->setCinemaLinkId("50000");
$req->setOutId("224e6be330634d17805a3655c863edf1");
$req->setOrderId("190717000446X500005193");
$req->setAmount("1");
$req->setReason("不想要了");
$req->setWorkstationId("14949");
$req->setOperatorUserId("ifatczh");
$req->setIsReturnBack("true");
$req->setPaymentList("[]");
$req->setWorkstationName("ifatczh");
$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.order.refundcoupon' \
-d 'partner_id=apidoc' \
-d 'sign=A1E44A237A43380C8D16372786316F2C' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-04+15%3A20%3A50' \
-d 'v=2.0' \
-d 'amount=1' \
-d 'channel_code=POS_50000' \
-d 'cinema_link_id=50000' \
-d 'is_return_back=true' \
-d 'operator_user_id=ifatczh' \
-d 'order_id=190717000446X500005193' \
-d 'out_id=224e6be330634d17805a3655c863edf1' \
-d 'payment_list=null' \
-d 'reason=%E4%B8%8D%E6%83%B3%E8%A6%81%E4%BA%86' \
-d 'workstation_id=14949' \
-d 'workstation_name=ifatczh'

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

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

req.channel_code="POS_50000"
req.cinema_link_id="50000"
req.out_id="224e6be330634d17805a3655c863edf1"
req.order_id="190717000446X500005193"
req.amount=1
req.reason="不想要了"
req.workstation_id="14949"
req.operator_user_id="ifatczh"
req.is_return_back=true
req.payment_list="[]"
req.workstation_name="ifatczh"
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.order.refundcoupon");
add_param(pRequest,"channel_code","POS_50000");
add_param(pRequest,"cinema_link_id","50000");
add_param(pRequest,"out_id","224e6be330634d17805a3655c863edf1");
add_param(pRequest,"order_id","190717000446X500005193");
add_param(pRequest,"amount","1");
add_param(pRequest,"reason","不想要了");
add_param(pRequest,"workstation_id","14949");
add_param(pRequest,"operator_user_id","ifatczh");
add_param(pRequest,"is_return_back","true");
add_param(pRequest,"payment_list","");
add_param(pRequest,"workstation_name","ifatczh");
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.order.refundcoupon', {
	'channel_code':'POS_50000',
	'cinema_link_id':'50000',
	'out_id':'224e6be330634d17805a3655c863edf1',
	'order_id':'190717000446X500005193',
	'amount':'1',
	'reason':'不想要了',
	'workstation_id':'14949',
	'operator_user_id':'ifatczh',
	'is_return_back':'true',
	'payment_list':'',
	'workstation_name':'ifatczh'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<lark_pos_order_refundcoupon_response>
    <data>{ &quot;innerCode&quot;:null, &quot;success&quot;:true, &quot;resultCode&quot;:&quot;SUCCESS&quot;, &quot;resultMsg&quot;:&quot;成功&quot; }</data>
</lark_pos_order_refundcoupon_response>

{
    "lark_pos_order_refundcoupon_response":{
        "data":"{ \"innerCode\":null, \"success\":true, \"resultCode\":\"SUCCESS\", \"resultMsg\":\"成功\" }"
    }
}

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.order.refundcoupon (POS券退单)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ