修改商家券基本信息API

最新更新时间:2020.11.04 版本说明


商户可以通过该接口修改商家券基本信息

接口说明

适用对象:直连商户 服务商 渠道商

请求URL:https://api.mch.weixin.qq.com/v3/marketing/busifavor/stocks/{stock_id}

请求方式:Patch

前置条件: 已创建商家券批次,且修改时间位于有效期结束时间前

接口规则:https://wechatpay-api.gitbook.io/wechatpay-api-v3


path 指该参数为路径参数

query 指该参数为URL参数

body 指该参数需在请求JSON传参


请求参数

参数名 变量 类型[长度限制] 必填 描述
批次号 stock_id string[1,20] path批次号
示例值:101156451224
+自定义入口 custom_entrance object body卡详情页面,可选择多种入口引导用户
参数名 变量 类型[长度限制] 必填 描述
+小程序入口 mini_programs_info object 需要小程序APPID、path、入口文案、引导文案。如果需要跳转小程序,APPID、path、入口文案为必填,引导文案非必填。appid要与归属商户号有绑定关系
参数名 变量 类型[长度限制] 必填 描述
商家小程序appid mini_programs_appid string[1,32] 需要小程序appid与归属商户号有绑定关系
示例值:wx234545656765876
商家小程序path mini_programs_path string[1,128] 商家小程序path
示例值:/path/index/index
入口文案 entrance_words string[1,5] 入口文案,字数上限为5个,一个中文汉字/英文字母/数字均占用一个字数。
示例值:欢迎选购
引导文案 guiding_words string[1,6] 小程序入口引导文案,字数上限为6个,一个中文汉字/英文字母/数字均占用一个字数。
示例值:获取更多优惠
商户公众号appid appid string[1,32] 可配置商户公众号,从券详情可跳转至公众号
示例值:wx324345hgfhfghfg
营销馆id hall_id string[1,64] 填写微信支付营销馆的馆id,用户自定义字段。 营销馆需在商户平台 创建。
示例值:233455656
code展示模式 code_display_mode string[1,8] 枚举值:
NOT_SHOW:不展示
code BARCODE:一维码
QRCODE:二维码
示例值:BARCODE
商家券批次名称 stock_name string[1,21] body批次名称,字数上限为21个,一个中文汉字/英文字母/数字均占用一个字数。
示例值:8月1日活动券
批次备注 comment string[1,20] body仅配置商户可见,用于自定义信息。字数上限为20个,一个中文汉字/英文字母/数字均占用一个字数。
示例值:活动使用
适用商品范围 goods_name string[1,15] body用来描述批次在哪些商品可用,会显示在微信卡包中。字数上限为15个,一个中文汉字/英文字母/数字均占用一个字数。
示例值:xxx商品使用
商户请求单号 out_request_no string[1,128] body商户修改批次凭据号(格式:商户id+日期+流水号),商户侧需保持唯一性。
示例值:6122352020010133287985742
+样式信息 display_pattern_info object body创建批次时的样式信息。
参数名 变量 类型[长度限制] 必填 描述
使用须知 description string[1, 1000] 用于说明详细的活动规则,会展示在代金券详情页。
示例值:xxx门店可用
商户logo merchant_logo_url string[1,128] 商户logo的URL地址, 可通过《图片上传API》获得图片URL地址。
1、商户logo大小需为120像素*120像素。
2、支持JPG/JPEG/PNG格式,且图片小于1M。
示例值:https://xxx
商户名称 merchant_name string[1, 16] 商户名称,字数上限为16个,一个中文汉字/英文字母/数字均占用一个字数。
示例值:微信支付
背景颜色 background_color string[1,15] 代金券的背景颜色,可设置10种颜色,色值请参考卡券背景颜色图。颜色取值为颜色图中的颜色名称。
示例值:Color020
券详情图片 coupon_image_url string[1,128] 券详情图片,850像素*350像素,且图片大小不超过2M,支持JPG/PNG格式,可通过《图片上传API》获得图片URL地址。
示例值:https://qpic.cn/xxx
+核销规则 coupon_use_rule object body券核销相关规则
参数名 变量 类型[长度限制] 必填 描述
核销方式 use_method string[1,128] 核销方式,枚举值:
OFF_LINE:线下滴码核销
MINI_PROGRAMS:小程序核销
SELF_CONSUME:用户自主核销
PAYMENT_CODE:微信支付付款码核销
示例值:OFF_LINE
小程序appid mini_programs_appid string[1,32] 核销方式为线上小程序核销才有效
示例值:wx23232232323
小程序path mini_programs_path string[1,128] 核销方式为线上小程序核销才有效
示例值:/path/index/index
+发放规则 stock_send_rule object body券发放相关规则
参数名 变量 类型[长度限制] 必填 描述
是否开启自然人限领 natural_person_limit boolean 不填默认否,枚举值:
true:是
false:否
示例值:false
可疑账号拦截 prevent_api_abuse boolean 不填默认否,枚举值:
true:是
false:否
示例值:false
+事件通知配置 notify_config object body事件回调通知商户的配置
参数名 变量 类型[长度限制] 必填 描述
事件通知appid notify_appid string[1, 64] 用于回调通知时,计算返回操作用户的openid(诸如领券用户),支持小程序or公众号的APPID;如该字段不填写,则回调通知中涉及到用户身份信息的openid与unionid都将为空。
示例值:wx23232232323

请求示例


{
  "custom_entrance": {
    "mini_programs_info": {
      "mini_programs_appid": "wx234545656765876",
      "mini_programs_path": "/path/index/index",
      "entrance_words": "欢迎选购",
      "guiding_words": "获取更多优惠"
    },
	"appid": "wx324345hgfhfghfg",
    "hall_id": "233455656",
    "code_display_mode": "BARCODE"
  },
  "stock_name": "8月1日活动券",
  "comment": "活动使用",
  "goods_name": "xxx商品使用",
  "out_request_no": "6122352020010133287985742",
  "display_pattern_info": {
    "description": "xxx门店可用",
    "merchant_logo_url": "https://xxx",
    "merchant_name": "微信支付",
    "background_color": "xxxxx",
    "coupon_image_url": "图片cdn地址"
  },
  "coupon_use_rule": {
    "use_method": "OFF_LINE",
    "mini_programs_appid": "wx23232232323",
    "mini_programs_path": "/path/index/index"
  },
  "stock_send_rule": {
    "natural_person_limit": false,
    "prevent_api_abuse": false
  },
  "notify_config": {
    "notify_appid": "wx23232232323"
  }
}

{
JAVA示例代码
}

返回参数


处理成功,应答无内容

返回示例

 
204
处理成功,应答无内容
                    

http://2323weixin.qq.com
                    

错误码公共错误码

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


版本说明

关闭
V1.0
2020年11月04
修改商家券基本信息接口上线

技术咨询

反馈有奖