条件查询用户券
开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
GET
https://openapi.alipay.com/v3/alipay/marketing/activity/ordervoucher/user/batchqueryvoucher
错误码
公共错误码
业务错误码
| 状态码 | 错误码 | 错误描述 | 解决方案 |
|---|---|---|---|
| 400 | SYSTEM_ERROR | 服务器异常 | 可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试 |
| 400 | INVALID_PARAMETER | 参数有误参数非法 | 请根据接口返回的参数非法的具体错误信息，修改参数后进行重试。 |
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://openapi.alipay.com/v3/alipay/marketing/activity/ordervoucher/user/batchqueryvoucher?auth_token&user_id&activity_id&belong_merchant_id&sender_merchant_id&voucher_status&page_num=&merchant_access_mode&page_size'响应示例响应示例
{
"user_voucher_infos": [
{
"user_voucher_base_info": {
"voucher_id": "string",
"voucher_name": "string",
"voucher_status": "string",
"create_time": "string",
"valid_begin_time": "string",
"valid_end_time": "string"
},
"activity_base_info": {
"activity_id": "string",
"belong_merchant_info": {
"merchant_id": "string"
},
"activity_product_type": "string"
},
"voucher_send_mode_info": {
"voucher_send_mode": "string"
},
"voucher_deduct_info": {
"voucher_type": "string",
"fix_voucher_info": {
"amount": "string",
"floor_amount": "string"
},
"discount_voucher_info": {
"discount": "string",
"ceiling_amount": "string",
"floor_amount": "string"
},
"special_voucher_info": {
"special_amount": "string",
"floor_amount": "string"
},
"exchange_voucher_info": {
"amount": "string",
"floor_amount": "string",
"biz_type": "string"
}
},
"voucher_display_pattern_info": {
"brand_name": "string",
"brand_logo_url": "string"
},
"voucher_available_scope_info": {
"voucher_available_goods_info": {
"goods_name": "string",
"origin_amount": "string"
}
},
"voucher_customer_guide_info": {
"voucher_use_guide_info": {
"use_guide_mode": [
"string"
],
"mini_app_use_guide_info": {
"mini_app_url": "string",
"mini_app_service_codes": [
"string"
]
}
}
}
}
],
"page_num": 0,
"page_size": 0,
"total_size": 0
}请求参数
Query 参数
auth_token
string
必需
user_id
string
支付宝用户id
activity_id
string
活动id
belong_merchant_id
string
可选
注意事项
belong_merchant_id和sender_merchant_id必填一个，且只能二选一。
sender_merchant_id
string
可选
注意事项
belong_merchant_id和sender_merchant_id必填一个，且只能二选一。
voucher_status
string
可选
枚举值
可用: SENDED
已核销: USED
已过期: EXPIRED
page_num
string
必需
注意事项
必须为大于0的整数
merchant_access_mode
string
必需
枚举值
商户自接入模式: SELF_MODE
服务商代接入模式: AGENCY_MODE
注意事项
选择服务商代接入模式需配合 app_auth_token 代调用使用
page_size
string
必需
注意事项
1.必须为大于0的整数 2.每页最大值为20