# 码信息查询

#### **接口用途**

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

#### **接口说明**

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

#### **action**

- `CodeQuery`

**请求参数，CHANNEL===>[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-r"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr><tr><td>codes</td><td>List</td><td>是</td><td>验码集合</td><td>最大不超过20</td></tr><tr><td>brandId</td><td>String</td><td>否</td><td>核销门店所属品牌</td><td>组合劵必须上送，易百提供</td></tr><tr><td>cityId</td><td>String</td><td>否</td><td>门店所在城市id</td><td>易百提供的城市id</td></tr><tr><td>storeInfo</td><td>Object&lt;[storeInfo](https://book.e-buy.com/books/e-buy-40/page/54229 "storeInfo")&gt;</td><td>否</td><td>门店串码查询时上送</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId": "20181019112535100000000000000002",
    "codes": ["1021242013780905000"],
    "brandId":"2429",
    "cityId":5493
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-r-0"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>returnCode</td><td>String</td><td>是</td><td>请求返回码</td><td>  
</td></tr><tr><td>returnMsg</td><td>String</td><td>是</td><td>请求返回信息</td><td>  
</td></tr><tr><td>data</td><td>Object&lt;[codeQueryResponseData](https://book.e-buy.com/books/e-buy-40/page/0584c "codeQueryResponseData")&gt;</td><td>否</td><td>码信息</td></tr></tbody></table>

**返回报文举例**

```
{
    "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,
        }]
    }
}

```

#### **券状态枚举**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-00-%E5%8F%AF%E4%BD%BF%E7%94%A8-01" style="width: 76.5432%; height: 560.8px;"><thead><tr style="height: 46.6px;"><th style="width: 7.26994%; height: 46.6px;">字段</th><th style="width: 44.7505%; height: 46.6px;">字段意义</th><th style="width: 47.9816%; height: 46.6px;">备注</th></tr></thead><tbody><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">00</td><td style="width: 44.7505%; height: 29.8px;">可使用</td><td style="width: 47.9816%; height: 29.8px;">  
</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">01</td><td style="width: 44.7505%; height: 29.8px;">已使用</td><td style="width: 47.9816%; height: 29.8px;">  
</td></tr><tr style="height: 46.6px;"><td style="width: 7.26994%; height: 46.6px;">02</td><td style="width: 44.7505%; height: 46.6px;">可使用(一码多次使用时，码还有可用次数)</td><td style="width: 47.9816%; height: 46.6px;">  
</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">03</td><td style="width: 44.7505%; height: 29.8px;">未激活</td><td style="width: 47.9816%; height: 29.8px;">未激活的码需调用激活接口才能</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">04</td><td style="width: 44.7505%; height: 29.8px;">已冻结</td><td style="width: 47.9816%; height: 29.8px;">  
</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">05</td><td style="width: 44.7505%; height: 29.8px;">已作废</td><td style="width: 47.9816%; height: 29.8px;">  
</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">06</td><td style="width: 44.7505%; height: 29.8px;">已过期</td><td style="width: 47.9816%; height: 29.8px;">  
</td></tr><tr style="height: 46.6px;"><td style="width: 7.26994%; height: 46.6px;">07</td><td style="width: 44.7505%; height: 46.6px;">未生效</td><td style="width: 47.9816%; height: 46.6px;">当制码时选择次日生效，核销时会返回该状态</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">08</td><td style="width: 44.7505%; height: 29.8px;">不能退款</td><td style="width: 47.9816%; height: 29.8px;">仅核销场景-不支持核销撤销(根据业务场景配置是否支持隔日和当日核销撤销)</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">09</td><td style="width: 44.7505%; height: 29.8px;">券不存在</td><td style="width: 47.9816%; height: 29.8px;">券码不存在(券码查询、核销、核销撤销)</td></tr><tr><td style="width: 7.26994%; height: 29.8px;">21</td><td style="width: 44.7505%; height: 29.8px;">电子凭证不可用</td><td style="width: 47.9816%; height: 29.8px;">券码不在有效期

</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">35</td><td style="width: 44.7505%; height: 29.8px;">码配置异常</td><td style="width: 47.9816%; height: 29.8px;">  
</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">51</td><td style="width: 44.7505%; height: 29.8px;">改码不存在制码方</td><td style="width: 47.9816%; height: 29.8px;">  
</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">97</td><td style="width: 44.7505%; height: 29.8px;">报文错误</td><td style="width: 47.9816%; height: 29.8px;">接口调用参数校验不通过</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">C2</td><td style="width: 44.7505%; height: 29.8px;">商户无权限</td><td style="width: 47.9816%; height: 29.8px;">券码查询和核销 权限校验不通过</td></tr></tbody></table>