# 客户批量发放优惠券
# 接口地址
/macan/coupon/syncBatchTake
# 入参
# 字段说明
| 名称 | 类型 | 必填 | 示例 | 描述 |
|---|---|---|---|---|
| idCustomer | Number | 是 | 10545360219000304622 | 领券客户 ID。 |
| couponTemplateList | CouponTemplateQuantityParam[] | 是 | 发放的优惠券模板列表，最多支持发放 50 张券，即 sum(模板x数量) <= 50 | |
| takeChannelCode | Number | 是 | 1 | 优惠券领取渠道。1-线下，3-微信 |
| takeSourceName | String | 否 | "门店推送" | 优惠券领取方式名称，不传默认为“门店推送”。字数范围：1~10。 |
| carRangeType | Number | 是 | 1 | 优惠券适用车辆范围。枚举值如下：0（部分车辆），1（全部车辆） |
| idCarList | Number[] | 否 | [10545360219000304622] | 优惠券适用车辆 ID 列表，当 carRangeType=0 时，该字段不能为空。 |
| memo | String | 否 | "保养送洗车" | 优惠券发放备注。字数范围：1~200. |
| serialNumber | String | 是 | "b8b5418a439f417fa9527015aaf53bfb" | 发券流水号。用作幂等，长度为10~32个字符。幂等的能力暂未提供，预计 2025/01/16 上线支持。 |
# CouponTemplateQuantityParam
| 名称 | 类型 | 必填 | 示例 | 描述 |
|---|---|---|---|---|
| couponTemplateId | Number | 是 | 10545360219000304629 | 优惠券模板 ID |
| quantity | Number | 是 | 5 | 当前优惠券模板发券数量 |
# JSON示例
{
"paramValues": [
{
"idCustomer": 12005608973832138768,
"couponTemplateList": [
{
"couponTemplateId": 174483,
"quantity": 1
},
{
"couponTemplateId": 170567,
"quantity": 1
}
],
"takeChannelCode": 1,
"takeSourceName": "门店推送",
"carRangeType": 0,
"idCarList": [
12005610398960164960
],
"memo": "测试批量发券",
"serialNumber": "b8b54a439f41727015aa02510204bfb"
}
]
}
# 出参
# 字段说明
| 名称 | 类型 | 示例 | 描述 |
|---|---|---|---|
| code | Number | 200 | 200-请求成功，其他均为失败。 注意：200 仅仅代表请求成功，业务处理结果需要根据 data 返回值进行判断 |
| message | String | "SUCCESS" | SUCCESS-正常返回 其他则是异常响应的错误提示 |
| data | GatewayResponse | 业务处理结果 |
# GatewayResponse
| 名称 | 类型 | 示例 | 描述 |
|---|---|---|---|
| code | String | "0" | 业务错误码，"0" 为成功，其他均为失败。 "-1"：失败（比如库存扣减失败等） "0"：成功 "3000"：优惠券模板不存在 "3001"：优惠券模板已删除 "3002"：优惠券模板已停用 "3003"：优惠券模板库存不足 "3004"：优惠券模板触发限领 "4006"：客户不存在 "4007"：适用车辆不存在或无效 "9999"：系统繁忙 |
| message | String | "OK" | 业务错误描述 |
| data | CouponSyncBatchTakeResponse | 业务响应数据。 发券成功时，该字段必返回； 发券失败时，该字段可能返回、也可能为空。 |
# CouponSyncBatchTakeResponse
| 名称 | 类型 | 示例 | 描述 |
|---|---|---|---|
| detailList | CouponSyncBatchTakeDetailInfo[] | 发券明细列表。 发券成功时，该列表返回券实体明细； 发券失败时，该列表返回失败明细。 |
# CouponSyncBatchTakeDetailInfo
| 名称 | 类型 | 示例 | 描述 |
|---|---|---|---|
| couponTemplateId | CouponSyncBatchTakeDetailInfo[] | 优惠券模板 ID | |
| couponIdList | Number[] | [15835197,15835196] | 优惠券实体 ID 列表。成功时该字段才有值 |
| errorCode | String | "3004" | 当前优惠券模板发放失败的错误码。 具体枚举值参考 GatewayResponse 的 code 字段描述 |
| errorMsg | String | "优惠券模板触发限领" | 当前优惠券模板发放失败的错误描述 |
# JSON示例
{
"code": 200,
"data": {
"code": "0",
"data": {
"detailList": [
{
"couponTemplateId": 174483,
"couponIdList": [
15835197
]
},
{
"couponTemplateId": 170567,
"couponIdList": [
15835196
]
}
]
},
"message": "OK"
},
"message": "SUCCESS"
}
{
"code": 200,
"data": {
"code": "3004",
"data": {
"detailList": [
{
"couponTemplateId": 178190,
"errorCode": "3004",
"errorMsg": "优惠券模板触发限领"
}
]
},
"message": "优惠券模板触发限领"
},
"message": "SUCCESS"
}