客如云开放平台

查询优惠券详情收费

(下行接口)合作方查询优惠券详情

授权方式：门店授权

请求描述

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

请求参数

1.公共参数

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

2.业务参数

参数名	参数类型	是否必填	参数描述
id	Long	是	优惠券id

业务示例

{
  "id": 12345
}

响应参数

参数名	参数类型	是否必填	参数描述
code	Integer	是	错误码；0：成功；其他值认为失败
message	string	是	返回信息
messageUuid	string	是	错误信息序列码
result	CrmCoupInstanceDetail	否	无

CrmCoupInstanceDetail

参数名称	参数类型	描述
id	long	优惠券Id
couponId	long	券模板id
couponName	String	优惠券名称
code_number	String	券编号
couponStatus	Integer	优惠券状态 4：已失效，1：未使用，2：使用中，3：无库存
couponType	Integer	优惠券类型：2：折扣，3：礼品，4：现金
fullValue	String	满值满x x元可用
offervalue	BigDecimal	用券后少付金额礼品券为空
disCount	BigDecimal	折扣(0.0~9.9)，eg：8.0
faceValue	BigDecimal	代金券金额
giftValue	BigDecimal	礼品券金额
ruleDesc	String	优惠券使用规则描述
validStartDate	Date	有效开始日期,eg:2017-01-01 23:00:23
validEndDate	Date	有效截至日期,eg:2017-01-01 23:00:23
periodStart	String	使用时间段开始时间
periodEnd	String	使用时间段结束时间
extraPeriodStart	String	扩展使用时间段开始时间
extraPeriodEnd	String	扩展使用时间段结束时间
week	String	使用星期限制七位字符串表示，1表示可用，0表示不可用，第一位表示周日，最后一位表示周六。如1100000表示周日、周一可用。1111110表示除了周六都能用
customerId	Long	顾客ID
instructions	String	使用说明
checkTime	Date	验券时间
checkerName	String	验券人
availableCommercialList	List<Long>	可用门店id集合
usableCommercialDesc	String	可用券门店名称列表
tradeNo	String	订单号
tradeTime	Date	订单时间
personCount	Integer	消费人数
dishId	Long	品牌菜ID
dishName	String	菜品名称
planName	String	方案名称
dishConditionType	Integer	适用商品范围：1 全部可用 2 部分可用，3 部分不可用
tradeId	Long	订单ID
code_number	String	券编号
tradeAmount	BigDecimal	消费金额
coupInstanceDetailUseDishList	List<CrmCoupInstanceDetailUseDishDTO>	适用商品列表：dishConditionType为：2、3的时候有值，1为空

CrmCoupInstanceDetailUseDishDTO

参数名称	参数类型	描述
dishTypeId	Long	菜品种类id
dishTypeName	String	菜品种类名称
dishId	Long	菜品id
dishName	String	菜品的名称
unitName	String	单位名称
price	BigDecimal	价格
dishCount	Long	该中类下菜品总数
couponUseRuleDishType	String	当前数据类型：DISHTYPE：种类；DISH：菜品

响应示例代码

{
    "result":{
         "brandId":101819,
         "code_number":"168736860959456256",
         "couponId":164768431294430208,
         "couponName":"不限库存3",
         "couponStatus":3,
         "couponType":4,
         "couponUseRuleDishList":[
             {
                 "dishTypeId": 66172478531055616,
                 "dishTypeName": "素菜",
                 "dishId": 4155104,
                 "dishName": "橙汁",
                 "unitName": "瓶",
                 "price": 15.00,
                 "couponUseRuleDishType": "DISH"
             }
         ],
         "createTime":1544425202688,
         "creatorId":-1,
         "customerId":162233171356765184,
         "dishConditionType":2,
         "extraPeriodEnd":"23:59:00",
         "extraPeriodStart":"13:00:00",
         "faceValue":2,
         "id":168736861194337280,
         "instructions":"公众号后台获取的二维码，顾客扫码领券会导致无法验券公众号后台获取的二维码，顾客扫码领券会导致无法验券公众号后台获取的二维码，顾客扫码领券会导致无法验券公众号后台获取的二维码，顾客扫码领券会导致无法验券",
         "isAllCommercial":false,
         "periodEnd":"12:30:00",
         "periodStart":"06:00:00",
         "planId":168736452367137792,
         "updateTime":1544461200000,
         "usableCommercialDesc":"仅限CI稳定区新权限01,CI稳定区新权限02,CI稳定区名字长名字长名字长名字长名字长名字长名字长名字长名字长名字长名字长,CI稳定区发还是发顺丰发还是发顺丰发还是发顺丰发还是发顺丰发还是发顺丰发还是发顺丰,CI稳定区哇哈哈哇哈哈哇哈哈哇哈哈哇哈哈哇哈哈哇哈哈哇哈哈哇哈哈哇哈哈哇哈哈,CI稳定区名字长2名字长2名字长2名字长2名字长2名字长2名字长2名字长2名字长2名字长2名字长2名字长2名",
         "usableCommercialIdList":[
             850018026,
             850018030,
             810022059,
             810022074,
             810022073,
             810022072
         ],
         "validEndDate":1544457599000,
         "validStartDate":1544371200000,
         "week":"1111110"
     },
    "code":0,
    "message":"成功[OK]",
    "messageUuid":"964644b070104fd0985b4a59023813bb",
    "apiMessage":"成功[OK]"
}