上传预存code API

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


商家券的Code码可由微信后台随机分配,同时支持商户自定义。如商家已有自己的优惠券系统,可直接使用自定义模式。即商家预先向微信支付上传券Code,当券在发放时,微信支付自动从已导入的Code中随机取值(不能指定),派发给用户。

接口说明

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

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

请求方式:POST

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


path 指该参数为路径参数

query 指该参数需在请求URL传参

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


请求参数

参数名 变量 类型[长度限制] 必填 描述
批次号 stock_id string[1,20] path 微信为每个商家券批次分配的唯一ID
示例值:98065001
券code列表 coupon_code_list array body 商户上传的券code列表,code允许包含的字符有0-9、a-z、A-Z、-、_、\、/、=、|。
特殊规则:单个券code长度为【1,32】,条目个数限制为【1,200】。
示例值:ABC9588200,ABC9588201
请求业务单据号 upload_request_no string[1,128] body 商户上传code的凭据号,商户侧需保持唯一性。
示例值:100002322019090134234sfdf

请求示例


{
  "coupon_code_list": [
    "ABC9588200",
    "ABC9588201"
  ],
  "upload_request_no": "100002322019090134234sfdf"
}
    
{
JAVA示例代码
}
    

返回参数

参数名 变量 类型[长度限制] 必填 描述
批次号 stock_id string[1,20] 微信为每个商家券批次分配的唯一ID。
示例值:98065001
去重后上传code总数 total_count uint64 本次上传操作,去重后实际上传的code数目。
示例值:500
上传成功code个数 success_count uint64 本次上传操作上传成功个数。
示例值:20
上传成功的code列表 success_codes array
本次新增上传成功的code信息。
特殊规则:单个券code长度为【1,32】,条目个数限制为【1,200】。
示例值:MMAA12345
上传成功时间 success_time string[1,32] 上传操作完成时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。
示例值:2015-05-20T13:29:35+08:00
上传失败code个数 fail_count uint64 本次上传操作上传失败的code数。
示例值:10
+上传失败的code及原因 fail_codes array 本次导入失败的code信息,请参照错误信息,修改后重试。
参数名 变量 类型[长度限制] 必填 描述
上传失败的券code coupon_code string[1,32] 商户通过API上传的券code。
示例值:ABCD23456
上传失败错误码 code string[1,32] 对应券code上传失败的错误码。
示例值:LENGTH_LIMIT
上传失败错误信息 message string[1,128] 上传失败的错误信息描述。
示例值:长度超过最大值32位
已存在的code列表 exist_codes array 历史已存在的code列表,本次不会重复导入。
特殊规则:单个券code长度为【1,32】,条目个数限制为【1,200】。
示例值:ABCD2345
本次请求中重复的code列表 duplicate_codes array 本次重复导入的code会被自动过滤,仅保留一个做导入,如满足要求则成功;如不满足要求,则失败;请参照报错提示修改重试。
特殊规则:单个券code长度为【1,32】,条目个数限制为【1,200】。
示例值:AACC2345

返回示例


> 200 Response
{
  "stock_id": "98065001",
  "total_count": 500,
  "success_count": 20,
  "success_codes": [
    "MMAA12345"
  ],
  "success_time": "2015-05-20T13:29:35+08:00",
  "fail_count": 10,
  "fail_codes": [
    {
      "coupon_code": "ABCD23456",
      "code": "LENGTH_LIMIT",
      "message": "长度超过最大值32位"
    }
  ],
  "exist_codes": [
    "ABCD2345"
  ],
  "duplicate_codes": [
    "AACC2345"
  ]
}
                                

    http://2323weixin.qq.com
                                

错误码公共错误码

状态码 错误码 描述 解决方案
400 PARAM_ERROR 参数错误 查看具体错误信息,调整参数
400 SYSTEM_ERROR 系统错误 请使用相同参数稍后重新调用
400 RESOURCE_ALREADY_EXISTS 批次已存在 查看out_request_no字段是否重复使用
券已被其他订单核销 请通过查询券API确认券是否已被其他订单核销
404 RESOURCE_NOT_EXISTS 查询的资源不存在 请检查查询资源的对应id是否填写正确
403 NOAUTH 无权限 查看具体错误信息,确认是否有权限
400 APPID_MCHID_NOT_MATCH appid与请求方商户无关联关系 appid与请求方商户不匹配,请确认appid与请求方商户是否有关联关系
400 MCH_NOT_EXISTS 商户号不存在 请确认传入的商户号是否正确
404 USER_NOT_EXISTS openid不正确 请确认传入的openid是否正确
500 SYSTEM_ERROR 系统失败 多为网络超时引起,重试
429 FREQUENCY_LIMITED 频率限制 调用太频繁,请降低调用接口频率
403 RULELIMIT 券不在有效期 请确认券是否能在当前时间核销
400 INVALID_REQUEST 发券模式不合法 请更换支持预上传code的批次后重试
上传的自定义code已达上限 请更换一个新的批次后重试

版本说明

关闭
V1.0
2019年11月8日
1. 上传预存code接口上线

技术咨询

反馈有奖