客如云开放平台

查询优惠券列表收费

(下行接口)合作方查询优惠券列表

授权方式：门店授权

请求描述

HTTP请求方式：POST
HTTP请求头类型：Content-Type=application/json
URI:  /open/v1/crm/fetchCoupInstanceList

请求参数

1.公共参数

详情可查看【公共说明】中的公共参数模块

2.业务参数

参数名	类型	是否必填	参数描述
couponStatus	List<Integer>	是	优惠券状态(1:未使用;2:已验证;3:已过期;4:作废;)
couponTypes	List<Integer>	是	优惠券类型(2:折扣券;3:礼品券;4:现金券;)
customerId	Long	是	顾客ID
page	Integer	是	第几页
pageSize	Integer	是	每页查询数据条数

业务示例（JSON）

{
    "customerId": 888893406139,
    "couponStatus": [
        1,
        2
    ],
    "couponTypes": [
            1
        ],
    "page": 1,
    "pageSize": 12
}

响应参数

参数名	类型	是否必填	参数描述
code	Int	是	返回编码，详见错误码
message	String	是	返回信息
messageUuid	String	是	消息uuid
result	CRMPager<CRMCoupInstanceVO>	否	返回响应数据，json对象或数组，可空

CRMPager<CRMCoupInstanceVO>

参数名	类型	是否必填	参数描述
currentPage	Integer	是	当前页
items	List<CRMCoupInstanceVO>	否	数据对象
pageSize	Integer	否	每页记录数
startRow	Integer	否	开始记录数
totalPage	Integer	否	总页码数
totalRows	Integer	否	总记录数

CRMCoupInstanceVO

参数名	类型	是否必填	参数描述
codeNumber	Long	否	券号
couponId	Long	否	券模板ID
couponName	String	否	券名称
couponStatus	Integer	否	券状态(1:未使用;2:已验证;3:已过期;4:作废;)
couponType	Integer	否	券类型(1:满减券;2:折扣券;3:礼品券;4:现金券;)
id	Long	否	优惠券ID
periodEnd	String	否	使用时间段结束时间
periodStart	String	否	使用时间段开始时间
ruleDesc	String	否	优惠券使用规则描述
usableCommercialDesc	String	否	可用门店名称
usableCommercialIdList	List<Long>	是	可用门店ID集合
validateEndDay	String	否	有效截至日期
validateStartDay	String	否	有效期开始日期
week	String	否	使用星期限制七位字符串表示，1表示可用，0表示不可用，第一位表示周日，最后一位表示周六。如1100000表示周日、周一可用。1111110表示除了周六都能用

响应示例（JSON）

{
    "code": "1",
    "result": {
        "currentPage": 1,
        "pageSize": 10,
        "totalRows": 11,
        "startRow": 0,
        "totalPage": 2,
        "items": [
            {
                "codeNumber": 3268120690040015,
                "couponType": 1,
                "id": 1657945,
                "couponName": "oetuaoetn",
                "ruleDesc": "满12减1",
                "periodStart": "00:00:00",
                "periodEnd": "23:59:00",
                "week": "1111111",
                "usableCommercialDesc": "仅限重庆冷锅鱼5,重庆冷锅鱼2,重庆冷锅鱼,重庆冷锅鱼1\",重庆冷锅鱼('小猪店),重庆冷锅鱼重庆冷锅4,重庆冷锅鱼1号店,重庆\"冷锅鱼2\"号店,重庆冷锅鱼4号店haohaohoa",
                "usableCommercialIdList": [
                    880000880,
                    800000098,
                    800000096,
                    800000095,
                    810002316,
                    810004945,
                    810005934,
                    810005935,
                    810005937
                ],
                "couponStatus": 3
            },
            {
                "codeNumber": 3268125450090017,
                "couponType": 3,
                "id": 1659520,
                "couponName": "aaaqqqq",
                "ruleDesc": "满0元可用",
                "periodStart": "00:00:00",
                "periodEnd": "23:59:00",
                "week": "1111111",
                "usableCommercialDesc": "仅限重庆冷锅鱼5,重庆冷锅鱼2,重庆冷锅鱼,重庆冷锅鱼1\",重庆冷锅鱼('小猪店),重庆冷锅鱼重庆冷锅4,重庆冷锅鱼1号店,重庆\"冷锅鱼2\"号店,重庆冷锅鱼4号店haohaohoa",
                "usableCommercialIdList": [
                    880000880,
                    800000098,
                    800000096,
                    800000095,
                    810002316,
                    810004945,
                    810005934,
                    810005935,
                    810005937
                ],
                "couponStatus": 3
            }
        ]
    }
}