失效用户商品券组

更新时间:2025.11.27

品牌方可以通过本接口将用户商品券组内的所有商品券同步失效

前置条件:已经给用户发券成功,且商品券的 usage_mode 为 PROGRESSIVE_BUNDLE

频率限制:500/s

接口说明

支持商户:【品牌商户】

请求方式:【POST】/brand/marketing/product-coupon/users/{openid}/coupon-bundles/{user_coupon_bundle_id}/deactivate

请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

     【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看

请求参数

Header  HTTP头参数

 Authorization  必填 string

请参考签名认证生成认证信息


 Accept  必填 string

请设置为application/json


 Content-Type  必填 string

请设置为application/json


 Wechatpay-Serial  必填 string

【微信支付公钥ID】  请传入brand_id对应的微信支付公钥ID,接口将会校验两者的关联关系,参考微信支付公钥产品简介及使用说明获取微信支付公钥ID和相关的介绍。以下两种场景将使用到微信支付公钥: 1、接收到接口的返回内容,需要使用微信支付公钥进行验签; 2、调用含有敏感信息参数(如姓名、身份证号码)的接口时,需要使用微信支付公钥加密敏感信息后再传输参数,加密指引请参考微信支付公钥加密敏感信息指引


path  路径参数

 user_coupon_bundle_id  必填   string(40)

【用户券组ID】 用户券组的唯一标识,【向用户发放商品券批次组】时由微信支付生成,本接口会同步失效用户商品券组内所有用户商品券


 openid  必填   string

【用户OpenID】 OpenID信息,用户在AppID下的唯一标识,获取方式参考OpenID


body  包体参数

 product_coupon_id  必填   string

【商品券ID】 商品券的唯一标识,创建商品券时由微信支付生成


 stock_bundle_id  必填   string

【批次组ID】 商品券批次组的唯一标识,【创建商品券(多次优惠)】或【添加商品券批次组】时由微信支付生成,请确保该批次组属于 product_coupon_id 对应的商品券


 appid  必填   string

【公众账号ID】 公众账号ID也称AppID,是(微信开放平台、微信公众平台)为开发者提供的一个唯一标识,用于识别开发者的应用程序(APP、小程序、公众号)。 开发者需要先在微信开放平台或微信公众平台中申请ID,然后在品牌经营平台中绑定,详见品牌经营平台指引


 out_request_no  必填   string(40)

【失效请求单号】 品牌失效用户商品券的请求流水号,品牌侧需保持唯一性,可使用 数字、大小写字母、下划线_、短横线- 组成,长度在6-40个字符之间


 deactivate_reason  必填   string(150)

【失效原因】 记录用户商品券的失效原因,长度不超过150个UTF-8字符

请求示例

curl
Java
Go

POST

1curl -X POST \
2  https://api.mch.weixin.qq.com/brand/marketing/product-coupon/users/oh-394z-6CGkNoJrsDLTTUKiAnp4/coupon-bundles/123446565767/deactivate \
3  -H "Authorization: WECHATPAY-BRAND-SHA256-RSA2048 brand_id=\"XXXX\",..." \
4  -H "Accept: application/json" \
5  -H "Wechatpay-Serial: PUB_KEY_ID_XXXX"  \
6  -H "Content-Type: application/json" \
7  -d '{
8    "product_coupon_id" : "1002323",
9    "stock_bundle_id" : "100232301",
10    "appid" : "wx233544546545989",
11    "out_request_no" : "1002600620019090123144054436",
12    "deactivate_reason" : "商品已下线,使用户商品券失效"
13  }'
14

应答参数

200 OK

 user_coupon_bundle_id  必填   string(40)

【用户券组ID】 用户券组的唯一标识,【向用户发放商品券批次组】时由微信支付生成


 user_product_coupon_list  必填   array[object]

【用户商品券列表】 用户商品券列表

属性

应答示例

200 OK

1{
2  "user_coupon_bundle_id" : "123446565767",
3  "user_product_coupon_list" : [
4    {
5      "coupon_code" : "123446565767",
6      "coupon_state" : "USED",
7      "valid_begin_time" : "2025-01-01T00:00+08:00",
8      "valid_end_time" : "2025-01-30T23:59:59+08:00",
9      "receive_time" : "2025-01-01T09:10:00+08:00",
10      "send_request_no" : "MCHSEND202003101234",
11      "send_channel" : "BRAND_MANAGE",
12      "confirm_request_no" : "MCHCONFIRM202003101234",
13      "confirm_time" : "2025-01-20T13:29:35+08:00",
14      "deactivate_request_no" : "1002600620019090123143254436",
15      "deactivate_time" : "2025-01-20T13:29:35+08:00",
16      "deactivate_reason" : "商品已下线",
17      "progressive_bundle_usage_detail" : {
18        "use_request_no" : "MCHUSE202003101234",
19        "use_time" : "2025-07-20T13:29:35+08:00",
20        "associated_order_info" : {
21          "transaction_id" : "4200000000123456789123456789",
22          "out_trade_no" : "trade_no_20250724123456",
23          "mchid" : "1234567890",
24          "sub_mchid" : "1234567890"
25        },
26        "return_request_no" : "MCHRETURN202003101234",
27        "return_time" : "2025-07-20T14:29:35+08:00"
28      },
29      "user_product_coupon_bundle_info" : {
30        "user_coupon_bundle_id" : "7014123823561283749832",
31        "user_coupon_bundle_index" : 0,
32        "total_count" : 10,
33        "used_count" : 3
34      },
35      "product_coupon" : {
36        "product_coupon_id" : "1002323",
37        "scope" : "ALL",
38        "type" : "NORMAL",
39        "usage_mode" : "SINGLE",
40        "single_usage_info" : {
41          "normal_coupon" : {
42            "threshold" : 10000,
43            "discount_amount" : 100
44          },
45          "discount_coupon" : {
46            "threshold" : 10000,
47            "percent_off" : 30
48          }
49        },
50        "progressive_bundle_usage_info" : {
51          "count" : 10,
52          "interval_days" : 1
53        },
54        "display_info" : {
55          "name" : "全场满100可减10元",
56          "image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx",
57          "background_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx",
58          "detail_image_url_list" : [
59            "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"
60          ],
61          "original_price" : 10000,
62          "combo_package_list" : [
63            {
64              "name" : "咖啡2选1",
65              "pick_count" : 3,
66              "choice_list" : [
67                {
68                  "name" : "美式",
69                  "price" : 10000,
70                  "count" : 2,
71                  "image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx",
72                  "mini_program_appid" : "wx4fd12345678",
73                  "mini_program_path" : "/pages/index/index"
74                }
75              ]
76            }
77          ]
78        },
79        "out_product_no" : "Product_1234567890",
80        "state" : "AUDITING",
81        "deactivate_request_no" : "1002600620019090123143254436",
82        "deactivate_time" : "2025-06-20T13:29:35+08:00",
83        "deactivate_reason" : "商品已下架"
84      },
85      "stock" : {
86        "product_coupon_id" : "200000001",
87        "stock_id" : "123456789",
88        "remark" : "满减券",
89        "coupon_code_mode" : "UPLOAD",
90        "coupon_code_count_info" : {
91          "total_count" : 10000,
92          "available_count" : 999
93        },
94        "stock_send_rule" : {
95          "max_count" : 10000000,
96          "max_count_per_day" : 10000,
97          "max_count_per_user" : 1
98        },
99        "progressive_bundle_usage_rule" : {
100          "coupon_available_period" : {
101            "available_begin_time" : "2025-01-01T00:00:00+08:00",
102            "available_end_time" : "2025-10-01T00:00:00+08:00",
103            "available_days" : 10,
104            "wait_days_after_receive" : 1,
105            "weekly_available_period" : {
106              "day_list" : [
107                "MONDAY"
108              ],
109              "day_period_list" : [
110                {
111                  "begin_time" : 60,
112                  "end_time" : 86399
113                }
114              ]
115            },
116            "irregular_available_period_list" : [
117              {
118                "begin_time" : "2025-01-01T00:00:00+08:00",
119                "end_time" : "2025-10-01T00:00:00+08:00"
120              }
121            ]
122          },
123          "normal_coupon" : {
124            "threshold" : 10000,
125            "discount_amount" : 100
126          },
127          "discount_coupon" : {
128            "threshold" : 10000,
129            "percent_off" : 30
130          },
131          "exchange_coupon" : {
132            "threshold" : 10000,
133            "exchange_price" : 100
134          }
135        },
136        "stock_bundle_info" : {
137          "stock_bundle_id" : "123456789",
138          "stock_bundle_index" : 0
139        },
140        "usage_rule_display_info" : {
141          "coupon_usage_method_list" : [
142            "MINI_PROGRAM"
143          ],
144          "mini_program_appid" : "wx1234567890",
145          "mini_program_path" : "/pages/index/product",
146          "app_path" : "https://www.example.com/jump-to-app",
147          "usage_description" : "全场可用",
148          "coupon_available_store_info" : {
149            "description" : "可在上海市区的所有门店使用,详细列表参考小程序内信息为准",
150            "mini_program_appid" : "wx1234567890",
151            "mini_program_path" : "/pages/index/store-list"
152          }
153        },
154        "coupon_display_info" : {
155          "code_display_mode" : "QRCODE",
156          "background_color" : "Color010",
157          "entrance_mini_program" : {
158            "appid" : "wx1234567890",
159            "path" : "/pages/index/product",
160            "entrance_wording" : "欢迎选购",
161            "guidance_wording" : "获取更多优惠"
162          },
163          "entrance_official_account" : {
164            "appid" : "wx1234567890"
165          },
166          "entrance_finder" : {
167            "finder_id" : "gh_12345678",
168            "finder_video_id" : "UDFsdf24df34dD456Hdf34",
169            "finder_video_cover_image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"
170          }
171        },
172        "notify_config" : {
173          "notify_appid" : "wx4fd12345678"
174        },
175        "store_scope" : "SPECIFIC",
176        "sent_count_info" : {
177          "total_count" : 100,
178          "today_count" : 10
179        },
180        "state" : "SENDING",
181        "deactivate_request_no" : "1002600620019090123143254436",
182        "deactivate_time" : "2025-01-01T00:00+08:00",
183        "deactivate_reason" : "批次信息有误,重新创建"
184      },
185      "attach" : "example_attach",
186      "channel_custom_info" : "example_channel_custom_info",
187      "coupon_tag_info" : {
188        "coupon_tag_list" : [
189          "MEMBER"
190        ],
191        "member_tag_info" : {
192          "member_card_id" : "MemberCardId_1234567890"
193        }
194      }
195    }
196  ]
197}
198

 

错误码

以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

 

元宝AI
反馈
目录
置顶