调试工具保证金授权店铺类型说明
youzan.ump.coupon.consume.fetchlogs.get.3.0.1
计费
2025-02-07 02:29:14

API名称:获取优惠券/优惠码领取记录
API描述
API描述
获取优惠券/优惠码领取记录

公共参数
参数名称参数类型必须参数说明示例值
access_tokenString
鉴权凭证,用于请求API详见如何获取access_token
9b510e232c9e3716b4c1e264fe04cdc6
请求地址
请求参数

全部展开全部收起

参数名称
参数类型
必须
参数说明
示例值
page_size
java.lang.Integer
分页大小(不可超过50)
50
coupon_group_id
java.lang.Long
活动id
632211
page_no
java.lang.Integer
当前页码
1
end_taked
java.util.Date
按照领取时间筛选(结束时间)格式:yyyy年-MM月-dd日 HH时:mm分:ss秒
2017-09-09 17:12:41
start_taked
java.util.Date
按照领取时间筛选(开始时间)格式:yyyy年-MM月-dd日 HH时:mm分:ss秒
2017-09-09 17:12:41
order_type
java.lang.Integer
排序类型:1: 根据券ID排序 2:根据领取时间排序。默认按照领取时间排序,若查询超时或报错可使用根据券ID排序,提高查询性能。
1
返回参数

全部展开全部收起

参数名称
参数类型
参数说明
示例值
code
int
网关返回码,表示本次请求是否成功。200 :成功
200
data
object
接口返回数据
fetchlogs
java.util.List
日志列表
send_kdt_id
java.lang.Long
发券店铺id
63077
sub_order_no
java.util.List<java.lang.String>
使用的E订单号.
["E20220525142602016706177","E20220525142602016706178","E20220525142602016706181"]
title
java.lang.String
优惠券/优惠码活动的名称
100元代金券
is_used
java.lang.Integer
是否已使用0未使用1已使用
1
promocard_id
java.lang.Long
优惠券ID
1222
taked_at
java.util.Date
领取时间,格式:yyyy年-MM月-dd日 HH时:mm分:ss秒
2017-09-09 17:12:41
promocode_id
java.lang.Long
优惠码ID
122222
receive_source
java.lang.String
领取来源,常用领取来源有:定向发券、刮刮卡、签到、疯狂猜猜猜、摇一摇、投票调查、大转盘、生肖翻翻看、进店有礼、会员卡、有赞云接口、满减送、积分商城兑换、普通领取、微页面、会员储值发卡、裂变优惠券、瓜分券、分享领券、有赞精选、砍价、兴趣人群、小程序领取、三方券、有赞客优惠券领券页、商详页领取、商详页推荐券领取、社区团购领取、通用券、付费优惠券、储值礼包定时发券、爱逛等
定向发券
used_in_order_no
java.lang.String
使用的订单号(可能为E单号,可能为V单号:V单一般指下单时发生拆单,拆出的订单之间的关联关系就是V单,或者多个订单合并支付,合并支付的总单号。)
V20220525142602016706188
used_at
java.util.Date
使用时间, 格式:yyyy年-MM月-dd日 HH时:mm分:ss秒
2017-09-09 17:12:41
yz_open_id
java.lang.String
有赞用户id,用户在有赞的唯一id。推荐使用
LnhGm4rh576452722916618240
fans_id
java.lang.Long
领取人fans_id
122
fans_type
java.lang.Integer
领取人粉丝类型
1
mobile
java.lang.String
手机号(若有)
1512221122
open_used_id
java.lang.String
三方用户ID
12332
created_at
java.util.Date
优惠券和通用优惠码的领取时间;若优惠码是用户自行导入的,则为优惠码导入时间, 格式:yyyy年-MM月-dd日 HH时:mm分:ss秒
2017-09-09 17:12:41
total_results
java.lang.Integer
返回日志数量
100
message
java.lang.String
网关返回码描述
successful
success
boolean
表示本次请求是否成功。 true:成功 false:失败
true
请求示例
<?php
require_once './vendor/autoload.php';

$accessToken = 'YOUR_TOKEN';
$client = new \Youzan\Open\Client($accessToken);

$method = 'youzan.ump.coupon.consume.fetchlogs.get';
$apiVersion = '3.0.1';

//设置参数
$params =[
	"end_taked"=>"2025-09-09 17=>12=>41",
	"start_taked"=>"2024-09-09 17=>12=>41",
	"page_no"=>1,
	"order_type"=>"1",
	"coupon_group_id"=>"33867069",
	"page_size"=>50
];

$response = $client->post($method, $apiVersion, $params);
var_dump($response);
?>
响应示例
{
  "trace_id": "bifrost-gateway-0ad734ed-2071423493-c43ebf5a",
  "code": 200,
  "data": {
    "fetchlogs": [
      {
        "used_in_order_no": "",
        "receive_source": "彩虹桥网关",
        "send_kdt_id": 491391,
        "mobile": "17603435626",
        "promocard_id": 4062019603,
        "created_at": 1614048743000,
        "yz_open_id": "tSSH9lzx714879996966998016",
        "fans_type": 0,
        "title": "11111xx",
        "taked_at": 1614048743000,
        "fans_id": 0,
        "is_used": 0
      },
      {
        "used_in_order_no": "",
        "receive_source": "彩虹桥网关",
        "send_kdt_id": 491391,
        "mobile": "17603435626",
        "promocard_id": 4062019602,
        "created_at": 1614047997000,
        "yz_open_id": "tSSH9lzx714879996966998016",
        "fans_type": 0,
        "title": "11111xx",
        "taked_at": 1614047997000,
        "fans_id": 0,
        "is_used": 0
      },
      {
        "used_in_order_no": "",
        "receive_source": "普通领取",
        "send_kdt_id": 491391,
        "mobile": "15958042967",
        "promocard_id": 4062017800,
        "created_at": 1614006062000,
        "yz_open_id": "tJnHtEyZ663821654807281664",
        "fans_type": 0,
        "title": "11111xx",
        "taked_at": 1614006062000,
        "fans_id": 0,
        "is_used": 0
      }
    ],
    "total_results": 3
  },
  "success": true,
  "message": "successful"
}
异常示例
{
  "trace_id": "bifrost-gateway-0ad734ed-2071423732-c43ebf02",
  "code": 161201014,
  "data": {
    "fetchlogs": []
  },
  "success": false,
  "message": "活动不存在"
}
返回码
返回码描述解决方案
200请求成功
请求成功
161201014活动不存在
检查活动信息是否正确
如何获得此API权限
拥有此API的能力包拥有此API的能力包分类可获得此API能力包的应用类目
优惠券管理营销管理有赞教育客户关系CRM门店POSiPaaS数据集成分销获客游戏互动老客复购客服管理设计定制内容工具内容营销客户管理功能定制模板定制触达通道活动工具推广投放打折促单裂变拉新行业解决方案系统打通(连接器)场景解决方案有赞微商城有赞零售
优惠码管理营销管理有赞教育客户关系CRM门店POSiPaaS数据集成分销获客老客复购客服管理设计定制内容工具内容营销客户管理功能定制模板定制触达通道活动工具推广投放打折促单裂变拉新行业解决方案系统打通(连接器)场景解决方案有赞微商城有赞零售

此篇文档是否对你有帮助?
文档反馈