码信息查询

接口用途 

 当需要查询某个指定码时，取码方调用此接口 

 接口说明 

 码表中以掩码为分表位，每查询某个码时必须有明确的码号。 

 如果券码预售提前激活，还未生效前 1、抖音本地， 直接返回券码状态不做拦截，核销时候会拦截无法使用 2、其他的渠道直接返回  券码不在有效期 

 action 

 CodeQuery 

 请求参数，CHANNEL===> WHALE 

 字段 

 类型 

 是否必填 

 字段意义 

 备注 

 requestId 

 String 

 是 

 请求流水号 

 32个字符，用于标识唯一一笔交易 

 codes 

 List 

 是 

 验码集合 

 最大不超过20 

 brandId 

 String 

 否 

 核销门店所属品牌 

 组合劵必须上送，易百提供 

 cityId 

 String 

 否 

 门店所在城市id 

 易百提供的城市id 

 storeInfo 

 Object< storeInfo > 

 否 

 门店串码查询时上送 

 请求报文举例 

 {

 "requestId": "20181019112535100000000000000002",

 "codes": ["1021242013780905000"],

 "brandId":"2429",

 "cityId":5493

}

 

 返回参数， WHALE ===>CHANNEL 

 字段 

 类型 

 是否必填 

 字段意义 

 备注 

 returnCode 

 String 

 是 

 请求返回码 

 

 returnMsg 

 String 

 是 

 请求返回信息 

 

 data 

 Object< codeQueryResponseData > 

 否 

 码信息 

 返回报文举例 

 {

 "returnCode": "00",

 "returnMsg": "操作成功",

 "requestId": "171698602301",

 "data":{

 "codeDetail":[{

 "code":"1021242013780905000",

 "saleChannelOrderId":"20181120155110",

 "sendChannelName":"易百自制渠道",

 "saleChannelCode":"990001",

 "useTimes":1,

 "verifyTimes":1

 "remainTimes":0,

 "createDate": "20180905",

 "createTime": "20180905160911",

 "validStart":"20181123000000",

 "validEnd":"20181124235959",

 "verifyDate":"20181123",

 "verifyTime":"20181124121243",

 "status": "01",

 "statusDesc": "已使用",

 "cityCheck":"Y",

 "ticketId":"9000000001",

 "faceValue":3000,

 "ticketName":"星巴克30元代金券",

 "shopNo":"1111",

 "shopName":"星巴克测试门店"

 "faceValue":1000,

 },{

 "code":"1021242013780905001",

 "saleChannelOrderId":"20181120155110",

 "sendChannelName":"易百自制渠道",

 "remainTimes":1,

 "createDate": "20180905",

 "createTime": "20180905160911",

 "validStart":"20181123000000",

 "validEnd":"20181124235959",

 "verifyDate":"20181123",

 "verifyTime":"20181124121243",

 "status": "01",

 "statusDesc": "已使用",

 "cityCheck":"Y",

 "ticketId":"9000000001",

 "faceValue":3000,

 "ticketName":"星巴克30元代金券",

 "shopNo":"1111",

 "shopName":"星巴克测试门店"

 "faceValue":1000,

 }]

 }

}

 

 券状态枚举 

 字段 

 字段意义 

 备注 

 00 

 可使用 

 

 01 

 已使用 

 

 02 

 可使用(一码多次使用时，码还有可用次数) 

 

 03 

 未激活 

 未激活的码需调用激活接口才能 

 04 

 已冻结 

 

 05 

 已作废 

 

 06 

 已过期 

 

 07 

 未生效 

 当制码时选择次日生效，核销时会返回该状态 

 08 

 不能退款 

 仅核销场景-不支持核销撤销(根据业务场景配置是否支持隔日和当日核销撤销) 

 09 

 券不存在 

 券码不存在(券码查询、核销、核销撤销) 

 21 

 电子凭证不可用 

 

 券码不在有效期 

 

 35 

 码配置异常 

 

 51 

 改码不存在制码方 

 

 97 

 报文错误 

 接口调用参数校验不通过 

 C2 

 商户无权限 

 券码查询和核销 权限校验不通过