使用场景：

企业将自有系统中的优惠券导入兔展平台

接口地址 /api/integrate/coupon/batchAdd

请求方式 POST

consumes ["application/json"]

produces ["application/json"]

接口描述 优惠券导入接口

应用权限 优惠券->券库券码同步

#请求参数

###请求头参数

参数名称参数说明请求类型是否必须数据类型schema
X-Token自建应用访问tokenheadertruestring

###公共参数

参数名称参数说明请求类型是否必须数据类型schema
publicParams导入配置bodytrueobject优惠券导入配置
data导入数据，每次最大500条bodytruearray优惠券

###优惠券导入配置

参数名称参数说明请求类型是否必须数据类型schema
optType导入方式(add: 新增)bodytrueString
batchId批次IDbodytrueString
batchStatus批次同步状态(0:同步开始, 1:同步中, 2:同步完成, 3:同步失败)bodytrueint
batchMsg批次同步信息，同步失败时候，失败信息bodyfalseString
batchTotal批次总数bodyfalselong

###优惠券

参数名称参数说明请求类型是否必须数据类型schema
thirdCouponTplId第三方卡券模板IDbodyfalseString
couponCode券CODEbodytrueString
validateType卡券码领取时效类型(1:时间区间, 2:按领取后有效天数, 3:永久有效)，不传以券模板数据为准bodyfalseInteger
startTime卡券有效开始时间，validateType=1必填bodyfalseDate
endTime卡券有效结束时间，validateType=1必填bodyfalseDate
awardAfterDay领取后有效天数，validateType=2必填bodyfalseInteger

###请求示例

{
    "publicParams":{
        "optType":"add"
    },
    "data":[{
        "thirdCouponTplId":"TTPL00000001",
        "couponCode":"C00000001",
        "validateType":"2",
        "startTime":"",
        "endTime":"",
        "awardAfterDay":"20"
    }]
}

#响应参数

参数名称参数说明请求类型是否必须数据类型schema
code状态码bodytruestring
errorCode异常码bodytruestring
msg描述bodytruestring
data响应数据bodytrueobject优惠券导入结果

###优惠券导入结果 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | status | 任务状态(-1: 失败, 0: 进行中, 1: 成功, 2: 部分导入成功) | body | true | int | | | errorData | 导入失败数据 | body | true | array | 优惠券 |

###响应状态

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

###响应示例

{
    "code": "200",
    "errorCode": "SUCCESS",
    "msg": "ok",
    "data": {
        "status": 1,
        "errorData": null,
        "errorMsg": null
    }
}


  • 无标签