支付宝

查询用户券详情

开发环境

http://dev-cn.your-api-server.com

GET

/v3/alipay/marketing/activity/ordervoucher/user/voucher

alipay.marketing.activity.user

通过此接口可以查询用户券信息，包括用户券的基础信息、状态。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://dev-cn.your-api-server.com/v3/alipay/marketing/activity/ordervoucher/user/voucher'

响应示例

200 - 示例 1

{
    "activity_base_info": {
        "belong_merchant_info": {
            "business_type": "string",
            "merchant_id": "string",
            "merchant_id_type": "string"
        },
        "activity_id": "string",
        "activity_name": "string",
        "activity_operation_status": "string",
        "activity_product_type": "string",
        "activity_status": "string",
        "code_mode": "string",
        "out_activity_id": "string"
    },
    "user_voucher_base_info": {
        "associate_trade_no": "string",
        "create_time": "string",
        "valid_begin_time": "string",
        "valid_end_time": "string",
        "voucher_id": "string",
        "voucher_max_use_times": 0,
        "voucher_name": "string",
        "voucher_status": "string",
        "voucher_used_times": 0
    },
    "voucher_deduct_info": {
        "customer_define_voucher_info": {
            "deduct_info": {
                "customer_define_deduct_rule": {
                    "customer_define_deduct_rule_desc": "string"
                }
            }
        },
        "discount_voucher_info": {
            "voucher_deduct_threshold_info": {
                "voucher_express_info": {
                    "pay_express": "string"
                },
                "voucher_goods_quantity_specification_info": {
                    "directional_type": "string",
                    "specification_quantity": 0,
                    "specification_unit": "string"
                },
                "customer_define_voucher_threshold_desc": "string"
            },
            "ceiling_amount": "string",
            "discount": "string",
            "floor_amount": "string"
        },
        "exchange_voucher_info": {
            "exchange_goods_info": {
                "exchange_goods_name": "string"
            },
            "voucher_deduct_threshold_info": {
                "voucher_express_info": {
                    "pay_express": "string"
                },
                "voucher_goods_quantity_specification_info": {
                    "directional_type": "string",
                    "specification_quantity": 0,
                    "specification_unit": "string"
                },
                "customer_define_voucher_threshold_desc": "string"
            },
            "amount": "string",
            "biz_type": "string",
            "floor_amount": "string"
        },
        "fix_voucher_info": {
            "voucher_deduct_threshold_info": {
                "voucher_express_info": {
                    "pay_express": "string"
                },
                "voucher_goods_quantity_specification_info": {
                    "directional_type": "string",
                    "specification_quantity": 0,
                    "specification_unit": "string"
                },
                "customer_define_voucher_threshold_desc": "string"
            },
            "amount": "string",
            "floor_amount": "string"
        },
        "special_voucher_info": {
            "voucher_deduct_threshold_info": {
                "voucher_express_info": {
                    "pay_express": "string"
                },
                "voucher_goods_quantity_specification_info": {
                    "directional_type": "string",
                    "specification_quantity": 0,
                    "specification_unit": "string"
                },
                "customer_define_voucher_threshold_desc": "string"
            },
            "floor_amount": "string",
            "special_amount": "string"
        },
        "voucher_type": "string"
    },
    "voucher_display_info": {
        "brand_logo": "string",
        "brand_name": "string",
        "voucher_description": "string",
        "voucher_image": "string",
        "voucher_detail_images": [
            "string"
        ]
    },
    "voucher_display_pattern_info": {
        "brand_logo": "string",
        "brand_logo_url": "string",
        "brand_name": "string",
        "customer_service_mobile": "string",
        "customer_service_url": "string",
        "voucher_description": "string",
        "voucher_image": "string",
        "voucher_image_url": "string",
        "voucher_name": "string",
        "voucher_detail_image_urls": [
            "string"
        ],
        "voucher_detail_images": [
            "string"
        ]
    },
    "voucher_send_mode_info": {
        "voucher_package_mode_info": {
            "voucher_package_id": "string"
        },
        "voucher_sale_mode_info": {
            "settle_info": {
                "settle_mode": "string",
                "settle_target_type": "string"
            },
            "fund_custody_mode": "string",
            "overdue_refundable": true,
            "overdue_refundable_need_confirm": true,
            "payee_pid": "string",
            "refundable": true,
            "refundable_need_confirm": true,
            "sale_amount": "string"
        },
        "voucher_send_rule_info": {
            "max_quantity_by_day": 0,
            "natural_person_limit": true,
            "phone_number_limit": true,
            "phone_number_need_input_limit": true,
            "publish_end_time": "string",
            "publish_start_time": "string",
            "quantity": 0,
            "quantity_limit_per_user": 0,
            "quantity_limit_per_user_period_type": "string",
            "real_name_limit": true
        },
        "voucher_send_mode": "string"
    },
    "voucher_send_rule": {
        "max_quantity_by_day": 0,
        "natural_person_limit": true,
        "phone_number_limit": true,
        "real_name_limit": true,
        "voucher_quantity": 0,
        "voucher_quantity_limit_per_user": 0,
        "voucher_quantity_limit_per_user_period_type": "string"
    },
    "voucher_use_rule": {
        "discount_voucher": {
            "ceiling_amount": "string",
            "discount": "string",
            "floor_amount": "string",
            "goods_name": "string",
            "origin_amount": "string"
        },
        "exchange_voucher": {
            "amount": "string",
            "floor_amount": "string",
            "overdue_refundable": true,
            "refundable": true,
            "sale_amount": "string"
        },
        "fix_voucher": {
            "amount": "string",
            "floor_amount": "string",
            "goods_name": "string"
        },
        "special_voucher": {
            "floor_amount": "string",
            "goods_name": "string",
            "origin_amount": "string",
            "special_amount": "string"
        }
    },
    "voucher_use_rule_info": {
        "voucher_use_time_info": {
            "absolute_period_info": {
                "time_restrict_info": {
                    "disable_period_info": [
                        {
                            "date_rule_info": {
                                "date_range_info": {
                                    "begin_date": "string",
                                    "end_date": "string"
                                },
                                "time_range_info": {
                                    "end_time_info": {
                                        "end_time": "string",
                                        "end_time_type": "string"
                                    },
                                    "begin_time": "string"
                                }
                            },
                            "holiday_rule_info": {
                                "time_range_info": {
                                    "end_time_info": {
                                        "end_time": "string",
                                        "end_time_type": "string"
                                    },
                                    "begin_time": "string"
                                }
                            },
                            "week_rule_info": {
                                "time_range_info": {
                                    "end_time_info": {
                                        "end_time": "string",
                                        "end_time_type": "string"
                                    },
                                    "begin_time": "string"
                                },
                                "week_day": "string"
                            },
                            "rule_type": "string"
                        }
                    ],
                    "usable_period_info": [
                        {
                            "date_rule_info": {
                                "date_range_info": {
                                    "begin_date": "string",
                                    "end_date": "string"
                                },
                                "time_range_info": {
                                    "end_time_info": {
                                        "end_time": "string",
                                        "end_time_type": "string"
                                    },
                                    "begin_time": "string"
                                }
                            },
                            "holiday_rule_info": {
                                "time_range_info": {
                                    "end_time_info": {
                                        "end_time": "string",
                                        "end_time_type": "string"
                                    },
                                    "begin_time": "string"
                                }
                            },
                            "week_rule_info": {
                                "time_range_info": {
                                    "end_time_info": {
                                        "end_time": "string",
                                        "end_time_type": "string"
                                    },
                                    "begin_time": "string"
                                },
                                "week_day": "string"
                            },
                            "rule_type": "string"
                        }
                    ]
                },
                "valid_begin_time": "string",
                "valid_end_time": "string"
            },
            "relative_period_info": {
                "time_restrict_info": {
                    "disable_period_info": [
                        {
                            "date_rule_info": {
                                "date_range_info": {
                                    "begin_date": "string",
                                    "end_date": "string"
                                },
                                "time_range_info": {
                                    "end_time_info": {
                                        "end_time": "string",
                                        "end_time_type": "string"
                                    },
                                    "begin_time": "string"
                                }
                            },
                            "holiday_rule_info": {
                                "time_range_info": {
                                    "end_time_info": {
                                        "end_time": "string",
                                        "end_time_type": "string"
                                    },
                                    "begin_time": "string"
                                }
                            },
                            "week_rule_info": {
                                "time_range_info": {
                                    "end_time_info": {
                                        "end_time": "string",
                                        "end_time_type": "string"
                                    },
                                    "begin_time": "string"
                                },
                                "week_day": "string"
                            },
                            "rule_type": "string"
                        }
                    ],
                    "usable_period_info": [
                        {
                            "date_rule_info": {
                                "date_range_info": {
                                    "begin_date": "string",
                                    "end_date": "string"
                                },
                                "time_range_info": {
                                    "end_time_info": {
                                        "end_time": "string",
                                        "end_time_type": "string"
                                    },
                                    "begin_time": "string"
                                }
                            },
                            "holiday_rule_info": {
                                "time_range_info": {
                                    "end_time_info": {
                                        "end_time": "string",
                                        "end_time_type": "string"
                                    },
                                    "begin_time": "string"
                                }
                            },
                            "week_rule_info": {
                                "time_range_info": {
                                    "end_time_info": {
                                        "end_time": "string",
                                        "end_time_type": "string"
                                    },
                                    "begin_time": "string"
                                },
                                "week_day": "string"
                            },
                            "rule_type": "string"
                        }
                    ]
                },
                "valid_days_after_receive": 0,
                "wait_days_after_receive": 0
            },
            "period_type": "string"
        },
        "quantity_limit_per_user": 0,
        "quantity_limit_per_user_period_type": "string",
        "voucher_max_use_times": 0,
        "voucher_use_ext_info": "string"
    },
    "activity_id": "2016042700826004508401111111",
    "associate_trade_no": "2021042322001426261436764012",
    "belong_merchant_id": "2088202967380463",
    "voucher_name": "满10减1",
    "voucher_status": "SENDED",
    "voucher_type": "FIX_VOUCHER",
    "available_begin_time": {},
    "available_end_time": {},
    "create_time": {}
}

请求参数

Query 参数

merchant_id

string

可选

商户 PID，默认为当前接口调用商户。

user_id

string

可选

支付宝user_id账号

open_id

string

可选

领券的支付宝用户openId

activity_id

string

活动id

可选

voucher_id

string

可选

用户券 id。支付宝为用户优惠券唯一分配的 id。

voucher_code

string

可选

用户领取的商家券券码。

merchant_access_mode

string

商户接入模式。

可选

返回响应

🟢200common response

application/json

Body

activity_base_info

object (ActivityBaseInfo)

可选

belong_merchant_info

object (BelongMerchantInfo)

可选

activity_id

string

活动id

可选

activity_name

string

活动名称。

可选

activity_operation_status

string

活动操作状态。

可选

activity_product_type

string

券活动产品类型

可选

activity_status

string

可选

活动状态。 ACTIVE:活动已激活，表示活动已经生效，等到活动开始(publish_start_time)之后用户就可以参与活动。 PAUSE:活动已暂停，表示商户临时暂停该活动，该状态下用户不能参与活动。

code_mode

string

可选

码模式。 MERCHANT_UPLOAD：商户上传自定义code，发券时系统随机选取上传的券code发放 MERCHANT_API：发奖时指定券码发奖，此模式无须提前上传券码。

out_activity_id

string

外部活动ID

可选

user_voucher_base_info

object (UserVoucherBaseInfo)

可选

associate_trade_no

string

可选

若商家券操作过关联商户订单信息，则该字段返回商家券已关联的商户订单号。

create_time

string

领券时间

可选

valid_begin_time

string

可选

券可使用的开始时间。格式为：yyyy-MM-dd HH:mm:ss

valid_end_time

string

可选

券可使用的结束时间。格式为yyyy-MM-dd HH:mm:ss

voucher_id

string

可选

用户券 id。支付宝为用户优惠券唯一分配的 id。

voucher_max_use_times

integer

券最大核销次数

可选

voucher_name

string

可选

对消费者展示的券(商品)名称。

voucher_status

string

可选

券状态。SENDED:可用 USED:已核销(即完全使用), EXPIRED:已过期(只能查询6个月内数据)

voucher_used_times

integer

券已核销次数

可选

voucher_deduct_info

object (VoucherDeductInfo)

可选

customer_define_voucher_info

object (CustomerDefineVoucherInfo)

可选

discount_voucher_info

object (DiscountVoucherInfo)

可选

exchange_voucher_info

object (ExchangeVoucherInfo)

可选

fix_voucher_info

object (FixVoucherInfo)

可选

special_voucher_info

object (SpecialVoucherInfo)

可选

voucher_type

string

券类型。

可选

voucher_display_info

object (CommonVoucherDisplayInfo)

可选

brand_logo

string

可选

商家品牌 logo 链接

brand_name

string

商户品牌名称。

可选

voucher_description

string

可选

用于说明详细的活动规则，会展示在支付宝卡包券详情页。

voucher_image

string

券封面图链接。

可选

voucher_detail_images

array[string]

券详情图片链接。

可选

voucher_display_pattern_info

object (VoucherDisplayPatternInfo)

可选

brand_logo

string

可选

商家logo 需要通过 alipay.marketing.material.image.upload接口上传图片，指定file_key为PROMO_BRAND_LOGO，返回的resource_id即为该参数的值。

brand_logo_url

string

可选

商家品牌logo链接

brand_name

string

商户品牌名称。

可选

customer_service_mobile

string

客服电话。

可选

customer_service_url

string

客服链接。

可选

voucher_description

string

券详细使用说明。

可选

voucher_image

string

可选

券详情页封面图，会展示在用户支付宝卡包券详情页。需要通过 alipay.marketing.material.image.upload接口上传图片，指定file_key为PROMO_VOUCHER_IMAGE，接口返回的resource_id即为该参数的值。

voucher_image_url

string

券封面链接

可选

voucher_name

string

券名称。

可选

voucher_detail_image_urls

array[string]

券详情链接

可选

voucher_detail_images

array[string]

可选

券详细图列表，会展示在用户支付宝卡包券详情页需要通过 alipay.marketing.material.image.upload接口上传图片，指定file_key为PROMO_VOUCHER_DETAIL_IMAGE ,接口返回的resource_id即为该参数的值上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过2MB。

voucher_send_mode_info

object (VoucherSendModeInfo)

可选

voucher_package_mode_info

object (VoucherPackageModeInfo)

可选

voucher_sale_mode_info

object (VoucherSaleModeInfo)

可选

voucher_send_rule_info

object (VoucherSendRuleInfo)

可选

voucher_send_mode

string

券发放模式。

可选

voucher_send_rule

object (CommonVoucherSendRule)

可选

max_quantity_by_day

integer

可选

设置此字段，允许指定单天最大发券数量。

natural_person_limit

boolean

可选

限制相同身份证号领取次数(voucher_quantity_limit_per_user)。默认false不限制。枚举值 true：是 false：否

phone_number_limit

boolean

可选

限制相同手机号领取次数(voucher_quantity_limit_per_user)。默认false不限制枚举值 true：是 false：否

real_name_limit

boolean

可选

限制支付宝实名用户才能领取支付券，默认为false表示不限制。枚举值 true\false

voucher_quantity

integer

发行券的总数量。

可选

voucher_quantity_limit_per_user

integer

可选

每人领取限制。默认按照支付宝账号进行领取限制; 不填写或填入0表示没有领取限制。

voucher_quantity_limit_per_user_period_type

string

可选

周期限领配置,限制每人在固定周期内领取张数（voucher_quantity_limit_per_user），默认LIFE_CYCLE。

voucher_use_rule

object (CommonVoucherUseRule)

可选

discount_voucher

object (ActivityDiscountVoucher)

可选

exchange_voucher

object (ActivityExchangeVoucher)

可选

fix_voucher

object (ActivityFixVoucher)

可选

special_voucher

object (ActivitySpecialVoucher)

可选

voucher_use_rule_info

object (VoucherUseRuleInfo)

可选

voucher_use_time_info

object (VoucherUseTimeInfo)

可选

quantity_limit_per_user

integer

核销次数限制。

可选

quantity_limit_per_user_period_type

string

可选

周期限领配置,限制每人在固定周期内领取张数(voucher_quantity_limit_per_user),默认LIFE_CYCLE

voucher_max_use_times

integer

券最大核销次数。

可选

voucher_use_ext_info

string

自定义扩展信息

可选

activity_id

string

活动 id

可选

示例值:

2016042700826004508401111111

associate_trade_no

string

可选

若商家券操作过关联商户订单信息，则该字段返回商家券已关联的商户订单号。

示例值:

2021042322001426261436764012

belong_merchant_id

string

券归属 pid

可选

示例值:

2088202967380463

voucher_name

string

可选

对消费者展示的券(商品)名称。

示例值:

满10减1

voucher_status

string

券状态。

可选

示例值:

SENDED

voucher_type

string

券类型。

可选

示例值:

FIX_VOUCHER

available_begin_time

string

可选

券可用开始时间。格式为：yyyy-MM-dd HH:mm:ss

示例值:

{}

available_end_time

string

可选

券可用结束时间。格式为：yyyy-MM-dd HH:mm:ss

示例值:

{}

create_time

string

领券时间

可选

示例值:

{}

🔴500请求失败

修改于 2023-11-22 06:02:00

条件查询用户券

券领取通知