修改商家券基本信息

更新时间：2024.11.18

商户可以通过该接口修改商家券基本信息
前置条件：已创建商家券批次，且修改时间位于有效期结束时间前

接口说明

支持商户：【普通服务商】　【渠道商】

请求方式：【PATCH】/v3/marketing/busifavor/stocks/{stock_id}

请求域名：【主域名】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

path 路径参数

stock_id 　必填 string

【批次号】批次号

body 包体参数

custom_entrance 　选填 object

【自定义入口】卡详情页面，可选择多种入口引导用户

属性

mini_programs_info 　选填 object

【小程序入口】需要小程序APPID、path、入口文案、引导文案。如果需要跳转小程序，APPID、path、入口文案为必填，引导文案非必填。AppID要与归属商户号有绑定关系

属性

appid 　选填 string

【商户公众号AppID】可配置商户公众号，从券详情可跳转至公众号

hall_id 　选填 string

【更多优惠入口；营销馆创建地址：https://pay.weixin.qq.com/index.php/xphp/cfav_market/hall#/pages/list/list】填写微信支付营销馆的馆id，用户自定义字段。营销馆需在商户平台创建。

code_display_mode 　选填 string

【code展示模式】code展示模式

可选取值：：

NOT_SHOW: 不展示code
BARCODE: 一维码
QRCODE: 二维码

stock_name 　选填 string

【批次名称】批次名称，字数上限为21个，一个中文汉字/英文字母/数字均占用一个字数。
注：该字段暂不支持修改

comment 　选填 string

【批次备注】仅配置商户可见，用于自定义信息。字数上限为20个，一个中文汉字/英文字母/数字均占用一个字数。

goods_name 　选填 string

【适用商品范围】用来描述批次在哪些商品可用，会显示在微信卡包中。字数上限为15个，一个中文汉字/英文字母/数字均占用一个字数。

out_request_no 　必填 string

【商户请求单号】商户修改批次凭据号（格式：商户ID+日期+流水号），商户侧需保持唯一性。

display_pattern_info 　选填 object

【样式信息】

属性

description 　选填 string(1000)

【使用须知】用于说明详细的活动规则，会展示在代金券详情页。

merchant_logo_url 　选填 string

【商户logo】若券归属商户号有认证品牌，则系统将自动拉取对应品牌logo；若券归属商户号不在认证品牌下，需自定义上传logo，未上传时将展示兜底灰色logo样式，影响券详情页用户体验，请及时上传。
商户logo的URL地址，仅支持通过《图片上传API》接口获取的图片URL地址。
1、商户logo大小需为120像素*120像素。
2、支持JPG/JPEG/PNG格式，且图片小于1M。
注：该字段暂不支持修改

merchant_name 　选填 string(16)

【商户名称】不支持商户自定义。若券归属商户号有认证品牌，系统将自动拉取认证品牌号下的品牌名称；若券归属商户号不在认证品牌下，则拉取本商户号的商户简称。展示上限12个字符。
注：该字段暂不支持修改

background_color 　选填 string

【背景颜色】券的背景颜色，可设置10种颜色，色值请参考下方说明。颜色取值为颜色图中的颜色名称。

coupon_image_url 　选填 string

【券详情图片】券详情图片，1074像素（宽）*603像素（高），图片大小不超过2M，支持JPG/PNG格式。仅支持通过《图片上传API》接口获取的图片URL地址。

finder_info 　选填 object

【视频号相关信息】视频号相关信息

属性

coupon_use_rule 　选填 object

【核销规则】券核销相关规则

属性

use_method 　选填 string

【核销方式】核销方式

可选取值：：

OFF_LINE: 线下滴码核销，点击券“立即使用”跳转展示券二维码详情。
MINI_PROGRAMS: 线上小程序核销，点击券“立即使用”跳转至配置的商家小程序（需要添加小程序AppID和path）。
SELF_CONSUME: 微信支付付款码核销，点击券“立即使用”跳转至微信支付钱包付款码。
PAYMENT_CODE: 用户自助核销，点击券“立即使用”跳转至用户自助操作核销界面（当前暂不支持用户自助核销）。

mini_programs_appid 　选填 string

【小程序AppID】核销方式为线上小程序核销才有效

mini_programs_path 　选填 string

【小程序path】核销方式为线上小程序核销才有效

stock_send_rule 　选填 object

【发放规则】券发放相关规则

属性

notify_config 　选填 object

【事件通知配置】事件回调通知商户的配置

	属性
	notify_appid 　选填 string(64) 【事件通知AppID】用于回调通知时，计算返回操作用户的OpenID（诸如领券用户），支持小程序or公众号的AppID；如该字段不填写，则回调通知中涉及到用户身份信息的OpenID与UnionID都将为空。

subsidy 　选填 boolean

【是否允许营销补差】该批次发放的券是否允许进行补差。只允许从false改为true，不支持从true改为false
注：该字段暂未开放

请求示例

PATCH

1curl -X PATCH \
2  https://api.mch.weixin.qq.com/v3/marketing/busifavor/stocks/101156451224 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Content-Type: application/json" \
6  -d '{
7    "custom_entrance" : {
8      "mini_programs_info" : {
9        "mini_programs_appid" : "wx234545656765876",
10        "mini_programs_path" : "/path/index/index",
11        "entrance_words" : "欢迎选购",
12        "guiding_words" : "获取更多优惠"
13      },
14      "appid" : "wx324345hgfhfghfg",
15      "hall_id" : "233455656",
16      "code_display_mode" : "NOT_SHOW"
17    },
18    "stock_name" : "8月1日活动券",
19    "comment" : "活动使用",
20    "goods_name" : "xxx商品使用",
21    "out_request_no" : "6122352020010133287985742",
22    "display_pattern_info" : {
23      "description" : "xxx门店可用",
24      "merchant_logo_url" : "https://xxx",
25      "merchant_name" : "微信支付",
26      "background_color" : "xxxxx",
27      "coupon_image_url" : "图片cdn地址",
28      "finder_info" : {
29        "finder_id" : "sph6Rngt2T4RlUf",
30        "finder_video_id" : "export/UzFfAgtgekIEAQAAAAAAb4MgnPInmAAAAAstQy6ubaLX4KHWvLEZgBPEwIEgVnk9HIP-zNPgMJofG6tpdGPJNg_ojtEjoT94",
31        "finder_video_cover_image_url" : "https://wxpaylogo.qpic.cn/xxx"
32      }
33    },
34    "coupon_use_rule" : {
35      "use_method" : "OFF_LINE",
36      "mini_programs_appid" : "wx23232232323",
37      "mini_programs_path" : "/path/index/index"
38    },
39    "stock_send_rule" : {
40      "natural_person_limit" : false,
41      "prevent_api_abuse" : false
42    },
43    "notify_config" : {
44      "notify_appid" : "wx23232232323"
45    },
46    "subsidy" : true
47  }'
48

应答参数

无应答包体

应答示例

204 No Content

1'无应答包体'
2

错误码

公共错误码

状态码	错误码	描述	解决方案
400	PARAM_ERROR	参数错误	请根据错误提示正确传入参数
400	INVALID_REQUEST	HTTP 请求不符合微信支付 APIv3 接口规则	请参阅接口规则
401	SIGN_ERROR	验证不通过	请参阅签名常见问题
500	SYSTEM_ERROR	系统异常，请稍后重试	请稍后重试

业务错误码

状态码	错误码	描述	解决方案
400	INVALID_REQUEST	修改跳转到小程序的自定义入口请填入小程序AppID	需要修改小程序自定义入口，请填入正确的小程序AppID
400	INVALID_REQUEST	修改字段中包含敏感词	请更换提示的敏感词字段后重试
400	INVALID_REQUEST	修改的AppID与商户号没有绑定关系	请更换正确的AppID后重试
400	INVALID_REQUEST	修改的图片URL包含敏感内容	请更换待修改图片后重试
403	RULELIMIT	修改流程中仅允许创建方进行操作	仅允许调用方进行修改，请更换调用API的商户号
403	RULELIMIT	修改的营销馆无权限	请更换正确的营销馆ID后重试
404	RESOURCE_NOT_EXISTS	批次不存在	请检查批次ID后重试
404	RESOURCE_NOT_EXISTS	修改的AppID不合法	请更换正确的AppID后重试
404	RESOURCE_NOT_EXISTS	营销馆ID不存在	请更换正确的营销馆ID后重试

文档是否有帮助

更多支持

开发文档(商户)开发文档(V2版)开发者社区微信开放平台微信公众平台腾讯客服