# 码预核销接口

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

- 当需要确认码是否可用在当前场景时，调用此接口，

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

- 建议单码场景使用。多码需确认是否满足需求。

#### **action**

- `CodeCheck`

**请求参数，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> </td></tr><tr><td>cashTotalAmount</td><td>Number</td><td>是</td><td>订单金额</td><td>单位：分</td></tr><tr><td>isProductCheck</td><td>String</td><td>是</td><td>是否校验订单产品规则</td><td>是Y，否N</td></tr><tr><td>brandId</td><td>String</td><td>否</td><td>品牌id</td><td>多品牌使用的码，此字段必传</td></tr><tr><td>shopNo</td><td>String(20)</td><td>否</td><td>门店号</td><td>线下场景必填</td></tr><tr><td>tid</td><td>String(8)</td><td>否</td><td>终端号</td><td> </td></tr><tr><td>cityId</td><td>String</td><td>否</td><td>城市id，对接时使用ebuy城市id</td><td>有规则时必须上传</td></tr><tr><td>goodsDetail</td><td>Object&lt;[goodsDetail](https://book.e-buy.com/books/e-buy-40/page/1d7f7-Fbe "goodsDetail")&gt;</td><td>否</td><td>折抵产品明细</td><td>目前支持单码预核销检查使用</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId":"2018111911253510000010",
    "codes":["101111111111","1022222222222","1033333333333","104444444444"],
    "cashTotalAmount":"20000",
    "brandId":"121",
    "tid":"99000014",
    "shopNo":"123456",
    "cityId":"1012",
    "companyId":"11",
    "goodsDetail":[{
        "sku": "1112343",
        "qty": 1,
        "price": 3000,
        "type": "03",
        "spec": "03"
            }, {
        "sku": "1212342",
        "qty": 1,
        "price": 3500,
        "type": "03",
        "spec": "03"
        }]
}

```

**返回参数，[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>00为成功，其他均为失败</td><td> </td></tr><tr><td>returnMsg</td><td>String</td><td>是</td><td>请求返回信息</td><td> </td></tr><tr><td>data/checkResult</td><td>Object&lt;[data/checkResult](https://book.e-buy.com/books/e-buy-40/page/e1e32 "checkResult")&gt;</td><td>是</td><td>劵码查询结果</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "操作成功",
    "data": {
        "checkResult":[{
            "code":"1021242013780905000",
            "saleChannelCode":"990001",
            "saleChannelName":"易百码",
            "status": "00",
            "discountAmount":3000
        },{
            "code":"1021242013780905000",
            "saleChannelCode":"990001",
            "saleChannelName":"易百码",
            "status": "06",
            "discountAmount":3000,
        }]
    }
}

```

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

<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%E7%94%A8-01-"><thead><tr><th>字段</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>00</td><td>可用</td></tr><tr><td>01</td><td>已使用</td></tr><tr><td>03</td><td>未激活</td><td>未激活的码需调用激活接口才能</td></tr><tr><td>04</td><td>已冻结</td></tr><tr><td>05</td><td>已作废</td></tr><tr><td>06</td><td>已过期</td><td> </td></tr><tr><td>07</td><td>未生效</td><td>当制码时选择次日生效，核销时会返回该状态</td></tr><tr><td>09</td><td>码不存在</td></tr><tr><td>35</td><td>劵数据异常</td><td>联系易百确认</td></tr><tr><td>39</td><td>核销失败</td></tr><tr><td>91</td><td>核销异常</td></tr></tbody></table>