# 箱本包处理类接口



# 激活查询

**接口用途**

- 激活前查询是否可以激活 （实际场景 激活前和激活后都会查询，如果上送券码都是激活返回已激活，如果上含未激活返回未激活）

**action**

- activePreQuery

**请求参数，中间件===>易百后台**

<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-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>traceNo</td><td>String</td><td>是</td><td>收银机流水号</td><td>不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列</td></tr><tr><td>qrcode</td><td>String</td><td>是</td><td>二维码内容</td><td>券号code</td></tr><tr><td>businessType</td><td>Integer</td><td>是</td><td>业务类型</td><td>当businessType=12时为新逻辑支持箱的概念，返回的数据中包含箱的结构，该字段不传或者不等于12则为原来的逻辑不做任何变动，返回数据中不包含箱的结构</td></tr></tbody></table>

**请求报文举例**

```
{
    "traceNo": "99000009100010101732123",
    "qrcode": "R156A001-0000491-0505,R156A002-0000491-0505",
    "businessType": 12
}

```

**返回参数，易百后台===&gt;中件间**

<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-t-1"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>traceNo</td><td>String</td><td>是</td><td>收银机流水号</td><td>不允许重复</td></tr><tr><td>transDate</td><td>String</td><td>是</td><td>交易时间</td><td>格式为：yyyyMMddHHmmss</td></tr><tr><td>returnCode</td><td>String</td><td>是</td><td>返回码</td><td>P00表示待激活（可激活）；P01表示正在激活中（不可激活）；P02表示有部分券处于不可激活状态（不可激活）；P03表示已全部激活；P09表示该门店该城市不可激活</td></tr><tr><td>returnDesc</td><td>String</td><td>是</td><td>返回信息</td><td>交易结果描述或错误原因</td></tr><tr><td>voucherPkg</td><td>List&lt;[voucherPkg](https://gitbook.e-fuli.com/ebuy-cashier-integration-api/cn/api-introduction/parameter-object/dian-zi-quan-bao-xin-xi.html)&gt;</td><td>否</td><td>电子券包信息</td><td>返回电子券包信息</td></tr></tbody></table>

**返回报文举例（请求中 businessType 值为 12 时）**

```
{
  "transDate": "20190107143930",
  "returnDesc": "success",
  "voucherBox": [{
    "boxId":"X22169-3141157-33475",
    "voucherPkg":[
        {
            "pkgId":"B1123-6430582-102F5",
            "voucherReel":[
                {
                    "reelId":"R112102F-0000242-2585",
                    "codeDetail":[
                        {
                            "createTime":"20190107100500",
                            "saleChannelOrderId":"a1c4efb107df46f0ba230de6477bd337",
                            "remainTimes":2,
                            "status":"03",
                            "ticketName":"买N赠M券[望湘园_储值卡]",
                            "code":"1001901070000000258-M4DEDSfV",
                            "activityId":500706,
                            "validEnd":"00000000000000",
                            "sendChannelName":"测试易百制码",
                            "ticketId":500811,
                            "saleChannelName":"望湘园_储值卡",
                            "validStart":"00000000000000",
                            "faceValue":"0.0",
                            "createDate":"20190107",
                            "activityName":"【吉野家】 黏贴板主题-2018第6期",
                            "statusDesc":"未激活"
                        },
                        {
                            "createTime":"20190107100500",
                            "saleChannelOrderId":"a1c4efb107df46f0ba230de6477bd337",
                            "remainTimes":2,
                            "status":"03",
                            "ticketName":"买N赠M券[望湘园_储值卡]",
                            "code":"1001901070000000242-EOHEMM9K",
                            "activityId":500706,
                            "validEnd":"00000000000000",
                            "sendChannelName":"测试易百制码",
                            "ticketId":500811,
                            "saleChannelName":"望湘园_储值卡",
                            "validStart":"00000000000000",
                            "faceValue":"0.0",
                            "createDate":"20190107",
                            "activityName":"【吉野家】 黏贴板主题-2018第6期",
                            "statusDesc":"未激活"
                        }
                    ]
                },
                {
                    "reelId":"R151102F-0000241-2555",
                    "codeDetail":[
                        {
                            "createTime":"20190107100459",
                            "saleChannelOrderId":"044b5ff93e2d491fa364acb154079e05",
                            "remainTimes":2,
                            "status":"03",
                            "ticketName":"买N赠M券[望湘园_储值卡]",
                            "code":"1001901070000000255-e6tdHe8m",
                            "activityId":500706,
                            "validEnd":"00000000000000",
                            "sendChannelName":"测试易百制码",
                            "ticketId":500811,
                            "saleChannelName":"望湘园_储值卡",
                            "validStart":"00000000000000",
                            "faceValue":"0.0",
                            "createDate":"20190107",
                            "activityName":"【吉野家】 黏贴板主题-2018第6期",
                            "statusDesc":"未激活"
                        },
                        {
                            "createTime":"20190107100459",
                            "saleChannelOrderId":"044b5ff93e2d491fa364acb154079e05",
                            "remainTimes":2,
                            "status":"03",
                            "ticketName":"买N赠M券[望湘园_储值卡]",
                            "code":"1001901070000000241-RTxJO2bX",
                            "activityId":500706,
                            "validEnd":"00000000000000",
                            "sendChannelName":"测试易百制码",
                            "ticketId":500811,
                            "saleChannelName":"望湘园_储值卡",
                            "validStart":"00000000000000",
                            "faceValue":"0.0",
                            "createDate":"20190107",
                            "activityName":"【吉野家】 黏贴板主题-2018第6期",
                            "statusDesc":"未激活"
                        }
                    ]
                }
            ]
        },
        {
            "pkgId":"B1123-6430582-102F5",
            "voucherReel":[
                {
                    "reelId":"R112102F-0000242-2585",
                    "codeDetail":[
                        {
                            "createTime":"20190107100500",
                            "saleChannelOrderId":"a1c4efb107df46f0ba230de6477bd337",
                            "remainTimes":2,
                            "status":"03",
                            "ticketName":"买N赠M券[望湘园_储值卡]",
                            "code":"1001901070000000258-M4DEDSfV",
                            "activityId":500706,
                            "validEnd":"00000000000000",
                            "sendChannelName":"测试易百制码",
                            "ticketId":500811,
                            "saleChannelName":"望湘园_储值卡",
                            "validStart":"00000000000000",
                            "faceValue":"0.0",
                            "createDate":"20190107",
                            "activityName":"【吉野家】 黏贴板主题-2018第6期",
                            "statusDesc":"未激活"
                        },
                        {
                            "createTime":"20190107100500",
                            "saleChannelOrderId":"a1c4efb107df46f0ba230de6477bd337",
                            "remainTimes":2,
                            "status":"03",
                            "ticketName":"买N赠M券[望湘园_储值卡]",
                            "code":"1001901070000000242-EOHEMM9K",
                            "activityId":500706,
                            "validEnd":"00000000000000",
                            "sendChannelName":"测试易百制码",
                            "ticketId":500811,
                            "saleChannelName":"望湘园_储值卡",
                            "validStart":"00000000000000",
                            "faceValue":"0.0",
                            "createDate":"20190107",
                            "activityName":"【吉野家】 黏贴板主题-2018第6期",
                            "statusDesc":"未激活"
                        }
                    ]
                },
                {
                    "reelId":"R151102F-0000241-2555",
                    "codeDetail":[
                        {
                            "createTime":"20190107100459",
                            "saleChannelOrderId":"044b5ff93e2d491fa364acb154079e05",
                            "remainTimes":2,
                            "status":"03",
                            "ticketName":"买N赠M券[望湘园_储值卡]",
                            "code":"1001901070000000255-e6tdHe8m",
                            "activityId":500706,
                            "validEnd":"00000000000000",
                            "sendChannelName":"测试易百制码",
                            "ticketId":500811,
                            "saleChannelName":"望湘园_储值卡",
                            "validStart":"00000000000000",
                            "faceValue":"0.0",
                            "createDate":"20190107",
                            "activityName":"【吉野家】 黏贴板主题-2018第6期",
                            "statusDesc":"未激活"
                        },
                        {
                            "createTime":"20190107100459",
                            "saleChannelOrderId":"044b5ff93e2d491fa364acb154079e05",
                            "remainTimes":2,
                            "status":"03",
                            "ticketName":"买N赠M券[望湘园_储值卡]",
                            "code":"1001901070000000241-RTxJO2bX",
                            "activityId":500706,
                            "validEnd":"00000000000000",
                            "sendChannelName":"测试易百制码",
                            "ticketId":500811,
                            "saleChannelName":"望湘园_储值卡",
                            "validStart":"00000000000000",
                            "faceValue":"0.0",
                            "createDate":"20190107",
                            "activityName":"【吉野家】 黏贴板主题-2018第6期",
                            "statusDesc":"未激活"
                        }
                    ]
                }
            ]
        }
    ]
}],
  "paidAmount": 0,
  "invoiceAmount": 0,
  "returnCode": "P00",
  "receiptAmount": 0,
  "printDetail": {
    "content": "00||"
  },
  "orderNo": "179031014530",
  "traceNo": "ccs203781546843174561"
}

```

**返回报文举例（请求中 businessType 值不为 12，或为空，或不传时）**

```
{
    "transDate":"20190107143930",
    "returnDesc":"success",
    "voucherPkg":[
        {
            "pkgId":"B1123-6430582-102F5",
            "voucherReel":[
                {
                    "reelId":"R112102F-0000242-2585",
                    "codeDetail":[
                        {
                            "createTime":"20190107100500",
                            "saleChannelOrderId":"a1c4efb107df46f0ba230de6477bd337",
                            "remainTimes":2,
                            "status":"03",
                            "ticketName":"买N赠M券[望湘园_储值卡]",
                            "code":"1001901070000000258-M4DEDSfV",
                            "activityId":500706,
                            "validEnd":"00000000000000",
                            "sendChannelName":"测试易百制码",
                            "ticketId":500811,
                            "saleChannelName":"望湘园_储值卡",
                            "validStart":"00000000000000",
                            "faceValue":"0.0",
                            "createDate":"20190107",
                            "activityName":"【吉野家】 黏贴板主题-2018第6期",
                            "statusDesc":"未激活"
                        },
                        {
                            "createTime":"20190107100500",
                            "saleChannelOrderId":"a1c4efb107df46f0ba230de6477bd337",
                            "remainTimes":2,
                            "status":"03",
                            "ticketName":"买N赠M券[望湘园_储值卡]",
                            "code":"1001901070000000242-EOHEMM9K",
                            "activityId":500706,
                            "validEnd":"00000000000000",
                            "sendChannelName":"测试易百制码",
                            "ticketId":500811,
                            "saleChannelName":"望湘园_储值卡",
                            "validStart":"00000000000000",
                            "faceValue":"0.0",
                            "createDate":"20190107",
                            "activityName":"【吉野家】 黏贴板主题-2018第6期",
                            "statusDesc":"未激活"
                        }
                    ]
                },
                {
                    "reelId":"R151102F-0000241-2555",
                    "codeDetail":[
                        {
                            "createTime":"20190107100459",
                            "saleChannelOrderId":"044b5ff93e2d491fa364acb154079e05",
                            "remainTimes":2,
                            "status":"03",
                            "ticketName":"买N赠M券[望湘园_储值卡]",
                            "code":"1001901070000000255-e6tdHe8m",
                            "activityId":500706,
                            "validEnd":"00000000000000",
                            "sendChannelName":"测试易百制码",
                            "ticketId":500811,
                            "saleChannelName":"望湘园_储值卡",
                            "validStart":"00000000000000",
                            "faceValue":"0.0",
                            "createDate":"20190107",
                            "activityName":"【吉野家】 黏贴板主题-2018第6期",
                            "statusDesc":"未激活"
                        },
                        {
                            "createTime":"20190107100459",
                            "saleChannelOrderId":"044b5ff93e2d491fa364acb154079e05",
                            "remainTimes":2,
                            "status":"03",
                            "ticketName":"买N赠M券[望湘园_储值卡]",
                            "code":"1001901070000000241-RTxJO2bX",
                            "activityId":500706,
                            "validEnd":"00000000000000",
                            "sendChannelName":"测试易百制码",
                            "ticketId":500811,
                            "saleChannelName":"望湘园_储值卡",
                            "validStart":"00000000000000",
                            "faceValue":"0.0",
                            "createDate":"20190107",
                            "activityName":"【吉野家】 黏贴板主题-2018第6期",
                            "statusDesc":"未激活"
                        }
                    ]
                }
            ]
        }
    ],
    "paidAmount":0,
    "invoiceAmount":0,
    "returnCode":"P00",
    "receiptAmount":0,
    "printDetail":{
        "content":"00||"
    },
    "orderNo":"179031014530",
    "traceNo":"ccs203781546843174561"
}
```

# 激活

**接口用途**

- 激活

**action**

- activeVoucher

**请求参数，中间件===&gt;易百后台**

<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-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>traceNo</td><td>String</td><td>是</td><td>收银机流水号</td><td>不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列</td></tr><tr><td>qrcode</td><td>String</td><td>是</td><td>二维码内容</td><td>券号code</td></tr><tr><td>totalAmount</td><td>String</td><td>否</td><td>折后金额</td><td>激活券的折后金额，多个券则为总折后金额，单位：分</td></tr><tr><td>businessType</td><td>Integer</td><td>是</td><td>业务类型</td><td>当businessType=12时为新逻辑支持箱的概念，返回的数据中包含箱的结构，该字段不传或者不等于12则为原来的逻辑不做任何变动，返回数据中不包含箱的结构</td></tr><tr><td>extendData</td><td>JSONObject&lt;[activeInfo](https://book.e-buy.com/books/c20ad/page/310dc)&gt;</td><td>否</td><td>扩展信息</td><td>特殊场景填值需与易百技术沟通</td></tr></tbody></table>

**请求报文举例**

```
{
    "traceNo": "99000009100010101732123",
    "qrcode": "R156A001-0000491-0505",
    "totalAmount": "3000",
    "businessType": 12
}

```

**返回参数，易百后台===&gt;中件间**

<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-t-1"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>traceNo</td><td>String</td><td>是</td><td>收银机流水号</td><td>不允许重复</td></tr><tr><td>orderNo</td><td>String</td><td>是</td><td>本次激活操作订单号</td><td> </td></tr><tr><td>transDate</td><td>String</td><td>是</td><td>交易时间</td><td>格式为：yyyyMMddHHmmss</td></tr><tr><td>returnCode</td><td>String</td><td>是</td><td>返回码</td><td>A00表示正在激活中（等待，做结果查询）；A02表示有部分券处于不可激活状态（未进行激活）；A03表示其他异常（未进行激活）</td></tr><tr><td>returnDesc</td><td>String</td><td>是</td><td>返回信息</td><td>交易结果描述或错误原因</td></tr><tr><td>voucherPkg</td><td>List&lt;[voucherPkg](https://gitbook.e-fuli.com/ebuy-cashier-integration-api/cn/api-introduction/parameter-object/dian-zi-quan-bao-xin-xi.html)&gt;</td><td>否</td><td>电子券包信息</td><td>返回电子券包信息</td></tr></tbody></table>

**返回报文举例**

```
{
    "traceNo": "99000009100010101732123",
    "orderNo": "99000009100010101732123",
    "transDate": "20161231120533",
    "returnCode": "00",
    "returnDesc": "SUCCESS"
}
```

# 激活结果查询

**接口用途**

- 激活结果查询

**action**

- activeResultQuery

**请求参数，中间件===&gt;易百后台**

<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-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>traceNo</td><td>String</td><td>是</td><td>收银机流水号</td><td>不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列</td></tr><tr><td>originalTraceNo</td><td>String</td><td>是</td><td>激活操作订单号</td><td> </td></tr><tr><td>businessType</td><td>Integer</td><td>是</td><td>业务类型</td><td>当businessType=12时为新逻辑支持箱的概念，返回的数据中包含箱的结构，该字段不传或者不等于12则为原来的逻辑不做任何变动，返回数据中不包含箱的结构</td></tr></tbody></table>

**请求报文举例**

```
{
    "traceNo": "99000009100010101732123",
    "originalTraceNo": "99000009100010101732129",
    "businessType": 12
}

```

**返回参数，易百后台===&gt;中件间**

<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-t-1"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>traceNo</td><td>String</td><td>是</td><td>收银机流水号</td><td>不允许重复</td></tr><tr><td>orderNo</td><td>String</td><td>是</td><td>原激活操作订单号</td><td> </td></tr><tr><td>transDate</td><td>String</td><td>是</td><td>交易时间</td><td>格式为：yyyyMMddHHmmss</td></tr><tr><td>returnCode</td><td>String</td><td>是</td><td>返回码</td><td>R00表示激活成功；R01表示激活失败；R02表示找不到原订单</td></tr><tr><td>returnDesc</td><td>String</td><td>是</td><td>返回信息</td><td>交易结果描述或错误原因</td></tr><tr><td>voucherPkg</td><td>List&lt;[voucherPkg](https://gitbook.e-fuli.com/ebuy-cashier-integration-api/cn/api-introduction/parameter-object/dian-zi-quan-bao-xin-xi.html)&gt;</td><td>否</td><td>电子券包信息</td><td>返回电子券包信息</td></tr></tbody></table>

**返回报文举例**

```
{
    "traceNo": "99000009100010101732123",
    "orderNo": "99000009100010101732123",
    "transDate": "20161231120533",
    "returnCode": "00",
    "returnDesc": "SUCCESS"
}
```

# 作废

**接口用途**

- 作废，作废后的券不可激活

**action**

- delVoucher

**请求参数，中间件===&gt;易百后台**

<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-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>traceNo</td><td>String</td><td>是</td><td>收银机流水号</td><td>不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列</td></tr><tr><td>qrcode</td><td>String</td><td>是</td><td>二维码内容</td><td>券号code</td></tr></tbody></table>

**请求报文举例**

```
{
    "traceNo": "9900000910001010920150201",
    "qrcode": "10014030013500006013",
    "businessType": 12
}

```

**返回参数，易百后台===&gt;中件间**

<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-t-1"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>traceNo</td><td>String</td><td>是</td><td>收银机流水号</td><td>不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列</td></tr><tr><td>orderNo</td><td>String</td><td>是</td><td>本次作废操作订单号</td><td> </td></tr><tr><td>transDate</td><td>String</td><td>是</td><td>交易时间</td><td>格式为：yyyyMMddHHmmss</td></tr><tr><td>returnCode</td><td>String</td><td>是</td><td>返回码</td><td>V00表示作废成功；V01表示作废失败；V03表示券号错误</td></tr><tr><td>returnDesc</td><td>String</td><td>是</td><td>返回信息</td><td>交易结果描述或错误原因</td></tr><tr><td>voucherPkg</td><td>List&lt;[voucherPkg](https://gitbook.e-fuli.com/ebuy-cashier-integration-api/cn/api-introduction/parameter-object/dian-zi-quan-bao-xin-xi.html)&gt;</td><td>否</td><td>电子券包信息</td><td>返回电子券包信息</td></tr></tbody></table>

**返回报文举例**

```
{
    "traceNo": "9900000910001011020150201",
    "orderNo": "99000009100010101732123",
    "transDate": "20161231120533",
    "returnCode": "00",
    "returnDesc": "SUCCESS"
}
```

# 核销信息以及城市范围查询

**接口用途**

- 核销信息以及城市范围查询

**action**

- queryVerifyInfo

**请求参数，中间件===&gt;易百后台**

<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-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>traceNo</td><td>String</td><td>是</td><td>收银机流水号</td><td>不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列</td></tr><tr><td>qrcode</td><td>String</td><td>是</td><td>二维码内容</td><td>券号code</td></tr><tr><td>businessType</td><td>Integer</td><td>是</td><td>业务类型</td><td>当businessType=12时为新逻辑支持箱的概念，返回的数据中包含箱的结构，该字段不传或者不等于12则为原来的逻辑不做任何变动，返回数据中不包含箱的结构</td></tr></tbody></table>

**请求报文举例**

```
{
    "traceNo": "9900000910001010720150201",
    "qrcode": "10085748356738476396436",
    "businessType": 12
}

```

**返回参数，易百后台===&gt;中件间**

<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-t-1"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>traceNo</td><td>String</td><td>是</td><td>收银机流水号</td><td>不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列</td></tr><tr><td>transDate</td><td>String</td><td>是</td><td>交易时间</td><td>格式为：yyyyMMddHHmmss</td></tr><tr><td>returnCode</td><td>String</td><td>是</td><td>返回码</td><td>H00表示可核销；H01表示该券未激活；H02表示该券已核销；H03表示券号有误</td></tr><tr><td>returnDesc</td><td>String</td><td>是</td><td>返回信息</td><td>交易结果描述或错误原因</td></tr><tr><td>voucherPkg</td><td>List&lt;[voucherPkg](https://gitbook.e-fuli.com/ebuy-cashier-integration-api/cn/api-introduction/parameter-object/dian-zi-quan-bao-xin-xi.html)&gt;</td><td>否</td><td>电子券包信息</td><td>返回电子券包信息</td></tr></tbody></table>

**返回报文举例**

```
{
    "transDate":"20190107143930",
    "returnDesc":"success",
    "voucherBox":[
        {
            "boxId":"X1123-6430582-102F5",
            "voucherPkg":[
                {
                    "pkgId":"B1123-6430582-102F5",
                    "voucherReel":[
                        {
                            "codeDetail":[
                                {
                                    "createTime":"20190107100500",
                                    "saleChannelOrderId":"a1c4efb107df46f0ba230de6477bd337",
                                    "remainTimes":2,
                                    "status":"03",
                                    "ticketName":"买N赠M券[望湘园_储值卡]",
                                    "code":"1001901070000000258-M4DEDSfV",
                                    "activityId":500706,
                                    "validEnd":"00000000000000",
                                    "sendChannelName":"测试易百制码",
                                    "ticketId":500811,
                                    "saleChannelName":"望湘园_储值卡",
                                    "validStart":"00000000000000",
                                    "faceValue":"0.0",
                                    "createDate":"20190107",
                                    "activityName":"【吉野家】 黏贴板主题-2018第6期",
                                    "statusDesc":"未激活"
                                }
                            ],
                            "reelId":"R112102F-0000242-2585"
                        }
                    ]
                }
            ]
        }
    ],
    "paidAmount":0,
    "invoiceAmount":0,
    "returnCode":"P00",
    "receiptAmount":0,
    "printDetail":{
        "content":"00||"
    },
    "orderNo":"179031014530",
    "traceNo":"ccs2037815468431420150201"
}
```

# B2B饮料券箱本激活

**接口用途**

- 激活

**action**

- reelActiveVoucher

**请求参数，中间件===&gt;易百后台**

<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-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>traceNo</td><td>String</td><td>是</td><td>收银机流水号</td><td>不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列</td></tr><tr><td>qrcode</td><td>String</td><td>是</td><td>二维码内容</td><td>本号reelId</td></tr><tr><td>totalAmount</td><td>String</td><td>否</td><td>折后金额</td><td>激活券的折后金额，多个券则为总折后金额，单位：分</td></tr><tr><td>businessType</td><td>Integer</td><td>是</td><td>业务类型</td><td>当businessType=12时为新逻辑支持箱的概念，返回的数据中包含箱的结构，该字段不传或者不等于12则为原来的逻辑不做任何变动，返回数据中不包含箱的结构</td></tr></tbody></table>

**请求报文举例**

```
{
    "traceNo": "99000009100010101732123",
    "qrcode": "R156A001-0000491-0505",
    "totalAmount": "3000",
    "businessType": 12
}

```

**返回参数，易百后台===&gt;中件间**

<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-t-1"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>traceNo</td><td>String</td><td>是</td><td>收银机流水号</td><td>不允许重复</td></tr><tr><td>orderNo</td><td>String</td><td>是</td><td>本次激活操作订单号</td><td> </td></tr><tr><td>transDate</td><td>String</td><td>是</td><td>交易时间</td><td>格式为：yyyyMMddHHmmss</td></tr><tr><td>returnCode</td><td>String</td><td>是</td><td>返回码</td><td>A00表示正在激活中（等待，做结果查询）；A02表示有部分券处于不可激活状态（未进行激活）；A03表示其他异常（未进行激活）</td></tr><tr><td>returnDesc</td><td>String</td><td>是</td><td>返回信息</td><td>交易结果描述或错误原因</td></tr><tr><td>voucherPkg</td><td>List&lt;[voucherPkg](https://gitbook.e-fuli.com/ebuy-cashier-integration-api/cn/api-introduction/parameter-object/dian-zi-quan-bao-xin-xi.html)&gt;</td><td>否</td><td>电子券包信息</td><td>返回电子券包信息</td></tr></tbody></table>

**返回报文举例**

```
{
    "traceNo": "99000009100010101732123",
    "orderNo": "99000009100010101732123",
    "transDate": "20161231120533",
    "returnCode": "00",
    "returnDesc": "SUCCESS"
}
```

# B2B饮料券箱本作废

**接口用途**

- 作废，作废后的券不可激活

**action**

- reelDelVoucher

**请求参数，中间件===&gt;易百后台**

<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-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>traceNo</td><td>String</td><td>是</td><td>收银机流水号</td><td>不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列</td></tr><tr><td>qrcode</td><td>String</td><td>是</td><td>二维码内容</td><td>券号code</td></tr><tr><td>businessType</td><td>Integer</td><td>是</td><td>业务类型</td><td>当businessType=12时为新逻辑支持箱的概念，返回的数据中包含箱的结构，该字段不传或者不等于12则为原来的逻辑不做任何变动，返回数据中不包含箱的结构</td></tr></tbody></table>

**请求报文举例**

```
{
    "traceNo": "9900000910001010920150201",
    "qrcode": "10014030013500006013",
    "businessType": 12
}

```

**返回参数，易百后台===&gt;中件间**

<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-t-1"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>traceNo</td><td>String</td><td>是</td><td>收银机流水号</td><td>不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列</td></tr><tr><td>orderNo</td><td>String</td><td>是</td><td>本次作废操作订单号</td><td> </td></tr><tr><td>transDate</td><td>String</td><td>是</td><td>交易时间</td><td>格式为：yyyyMMddHHmmss</td></tr><tr><td>returnCode</td><td>String</td><td>是</td><td>返回码</td><td>V00表示作废成功；V01表示作废失败；V03表示券号错误</td></tr><tr><td>returnDesc</td><td>String</td><td>是</td><td>返回信息</td><td>交易结果描述或错误原因</td></tr><tr><td>voucherPkg</td><td>List&lt;[voucherPkg](https://gitbook.e-fuli.com/ebuy-cashier-integration-api/cn/api-introduction/parameter-object/dian-zi-quan-bao-xin-xi.html)&gt;</td><td>否</td><td>电子券包信息</td><td>返回电子券包信息</td></tr></tbody></table>

**返回报文举例**

```
{
    "traceNo": "9900000910001011020150201",
    "orderNo": "99000009100010101732123",
    "transDate": "20161231120533",
    "returnCode": "00",
    "returnDesc": "SUCCESS"
}
```

# 卡号段激活实体卡券（B2B定制）

**接口用途**

- 指定券码号段激活，相同<span style="font-family: 微软雅黑;">激活订单号直接返回当前状态</span>

**action**

- b2b/code/activeByPartNo

**请求参数，中间件===&gt;易百后台**

<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-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td valign="center" width="410">ver

</td><td valign="center" width="81">int

</td><td valign="center" width="146"><span style="font-family: 宋体;">是</span>

</td><td valign="center" width="271"><span style="font-family: 宋体;">2</span>

</td><td valign="center" width="214"><span style="font-family: 宋体;">接口版本(固定参数值)</span>

</td></tr><tr><td valign="center" width="410">partnerId

</td><td valign="center" width="81"><span style="font-family: 宋体;">int</span>

</td><td valign="center" width="146"><span style="font-family: 宋体;">是</span>

</td><td valign="center" width="271"><span style="font-family: 宋体;">1504</span>

</td><td valign="center" width="214"><span style="font-family: 宋体;">商户编号</span><span style="font-family: 宋体;">(固定参数值)</span>

</td></tr><tr><td valign="center" width="410">merchantId

</td><td valign="center" width="81"><span style="font-family: 宋体;">string</span>

</td><td valign="center" width="146"><span style="font-family: 宋体;">是</span>

</td><td valign="center" width="271">10001(星巴克中国)

</td><td valign="center" width="214"><span style="font-family: 宋体;">App商家在非码系统中的编</span><span style="font-family: 宋体;">号(固定参数值)</span>

</td></tr><tr><td valign="center" width="410">s<span style="font-family: 宋体;">ign</span>

</td><td valign="center" width="81"><span style="font-family: 宋体;">string</span>

</td><td valign="center" width="146"><span style="font-family: 宋体;">是</span>

</td><td valign="center" width="271"></td><td valign="center" width="214"><span style="font-family: 宋体;">参考签名举例</span>

</td></tr><tr><td valign="center" width="410"><span style="font-family: 宋体;">partnerOrderId</span>

</td><td valign="center" width="81"><span style="font-family: 宋体;">String </span>

</td><td valign="center" width="146"><span style="font-family: 宋体;">是</span>

</td><td valign="center" width="271"></td><td valign="center" width="214"><span style="font-family: 微软雅黑;">激活订单号，商户激活操作唯一，最大</span><span style="font-family: 宋体;">28</span><span style="font-family: 微软雅黑;">位。(若第一次请求成功的订单号再次请求，则返回此订单号处理进度，与</span><span style="font-family: 宋体;">startCardSe</span><span style="font-family: 微软雅黑;">、</span><span style="font-family: 宋体;">endCardSe</span><span style="font-family: 微软雅黑;">值无关)</span>

</td></tr><tr><td valign="top" width="410"><span style="font-family: 宋体;">type</span>

</td><td valign="top" width="81"><span style="font-family: 宋体;">int</span>

</td><td valign="top" width="146"><span style="font-family: 宋体;">是</span>

</td><td valign="top" width="271"></td><td valign="top" width="214"><span style="font-family: 宋体;">激活对象类型(固定值实体券2)</span>

</td></tr><tr><td valign="center" width="410"><span style="font-family: 宋体;">bin</span>

</td><td valign="top" width="81"><span style="font-family: 宋体;">string</span>

</td><td valign="top" width="146"><span style="font-family: 宋体;">是</span>

</td><td valign="center" width="271"></td><td valign="center" width="214"><span style="font-family: 微软雅黑;">卡</span><span style="font-family: 宋体;">bin</span><span style="font-family: 微软雅黑;">(</span><span style="font-family: 微软雅黑;">实体券：</span><span style="font-family: 宋体;">7020</span><span style="font-family: 微软雅黑;">)获取券码取前<span style="font-family: 宋体;">4</span>位</span>

</td></tr><tr><td valign="center" width="410"><span style="font-family: 宋体;">codeType</span>

</td><td valign="top" width="81"><span style="font-family: 宋体;">string</span>

</td><td valign="top" width="146"><span style="font-family: 宋体;">是</span>

</td><td valign="center" width="271"></td><td valign="center" width="214"><span style="font-family: 微软雅黑;">激活实体券时必填，</span><span style="font-family: 宋体;">3</span><span style="font-family: 微软雅黑;">位</span>

</td></tr><tr><td valign="center" width="410"><span style="font-family: 宋体;">startCardSe</span>

</td><td valign="center" width="81"><span style="font-family: 宋体;">string</span>

</td><td valign="center" width="146"><span style="font-family: 宋体;">是</span>

</td><td valign="center" width="271"></td><td valign="center" width="214"><span style="font-family: 微软雅黑;">起始激活卡券号段,含当前号段。（</span><span style="font-family: 宋体;">7</span><span style="font-family: 微软雅黑;">位）</span>

</td></tr><tr><td valign="center" width="410"><span style="font-family: 宋体;">endCardSe</span>

</td><td valign="top" width="81"><span style="font-family: 宋体;">string</span>

</td><td valign="top" width="146"><span style="font-family: 宋体;">是</span>

</td><td valign="center" width="271"></td><td valign="center" width="214"><span style="font-family: 微软雅黑;">终止激活卡券号段,含当前号段。（</span><span style="font-family: 宋体;">7</span><span style="font-family: 微软雅黑;">位）</span>

</td></tr><tr><td valign="center" width="410"><span style="font-family: 宋体;">number</span>

</td><td valign="top" width="81"><span style="font-family: 宋体;">int</span>

</td><td valign="top" width="146"><span style="font-family: 宋体;">是</span>

</td><td valign="center" width="271"></td><td valign="center" width="214"><span style="font-family: 微软雅黑;">激活数量</span>

</td></tr><tr><td valign="center" width="410"><span style="font-family: 宋体;">sellingPrice</span>

</td><td valign="top" width="81"><span style="font-family: 宋体;">int</span>

</td><td valign="top" width="146"><span style="font-family: 宋体;">是</span>

</td><td valign="center" width="271"></td><td valign="center" width="214"><span style="font-family: 宋体;">商品成本价</span> <span style="font-family: 宋体;">，单位：分（激活实体券时必传，若没有</span><span style="font-family: 宋体;">A,B账户则传sellingPrice=costPrice）。</span>

</td></tr><tr><td valign="center" width="410"><span style="font-family: 宋体;">costPrice</span>

</td><td valign="top" width="81"><span style="font-family: 宋体;">int</span>

</td><td valign="top" width="146"><span style="font-family: 宋体;">是</span>

</td><td valign="center" width="271"></td><td valign="center" width="214"><span style="font-family: 宋体;">商品售价。此字段不能大于</span><span style="font-family: 宋体;">sellingPrice，单位：分（激活实体券时必传，若没有A,B账户则传sellingPrice=costPrice）（折扣价</span>=成本价-售价<span style="font-family: 宋体;">）。</span>

</td></tr><tr><td valign="center" width="410"><span style="font-family: 宋体;">validStart</span>

</td><td valign="top" width="81"><span style="font-family: 宋体;">String</span>

</td><td valign="top" width="146"><span style="font-family: 宋体;">否</span>

</td><td valign="center" width="271"></td><td valign="center" width="214"><span style="font-family: 宋体;">有效期开始时间，格式：</span>yyyy<span style="font-family: 宋体;">-</span>MM<span style="font-family: 宋体;">-</span>dd HH<span style="font-family: 宋体;">:</span>mm<span style="font-family: 宋体;">:</span>ss<span style="font-family: 宋体;">（激活实体券时使用，激活时若</span><span style="font-family: 宋体;">validStart 和 validEnd 都不传，默认三年有效期。）</span>

</td></tr><tr><td valign="top" width="410"><span style="font-family: 宋体;">valid\_end</span>

</td><td valign="top" width="81"><span style="font-family: 宋体;">string</span>

</td><td valign="top" width="146"><span style="font-family: 宋体;">否</span>

</td><td valign="top" width="271"></td><td valign="center" width="214"><span style="font-family: 宋体;">有效期结束时间</span><span style="font-family: 宋体;">,格式：</span>yyyy<span style="font-family: 宋体;">-</span>MM<span style="font-family: 宋体;">-</span>dd HH<span style="font-family: 宋体;">:</span>mm<span style="font-family: 宋体;">:</span>ss<span style="font-family: 宋体;">（激活实体券时使用，激活时若</span><span style="font-family: 宋体;">validStart 和 validEnd 都不传，默认三年有效期。）</span>

</td></tr></tbody></table>

**请求报文举例**

```
{
	"ver": 2,
	"partnerId": 1504,
	"sign": "skip",
	"merchantId": 10001,
	"partnerOrderId": "2040132213w9181w0q77awwwd8",
	"type": 2,
    "bin": "7020",
    "startCardSe": "0000041",
    "endCardSe": "0000045",
    "sellingPrice": "10000",
    "costPrice": "8888",
    "number": 14
}
```

**返回参数，易百后台===&gt;中件间**

<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-t-1"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td valign="center" width="255">ver

</td><td valign="center" width="87">int

</td><td valign="center" width="88"><span style="font-family: 宋体;">是</span>

</td><td valign="center" width="229">2

</td><td valign="center" width="442"><span style="font-family: 宋体;">接口版本</span>

</td></tr><tr><td valign="top" width="255"><span style="font-family: 宋体;">statusCode</span>

</td><td valign="top" width="87"><span style="font-family: 宋体;">int</span>

</td><td valign="top" width="88"><span style="font-family: 宋体;">是</span>

</td><td valign="top" width="229"><span style="font-family: 宋体;">100：SUCCESS</span>

</td><td valign="top" width="442"><span style="font-family: 微软雅黑;">返回码：</span><span style="font-family: 宋体;">100</span><span style="font-family: 微软雅黑;">表示创建成功；</span>

 <span style="font-family: 宋体;">80</span><span style="font-family: 微软雅黑;">表示处理中；</span>

 <span style="font-family: 宋体;">81 </span><span style="font-family: 微软雅黑;">表示处理完成。</span>

</td></tr><tr><td valign="top" width="255"><span style="font-family: 宋体;">message</span>

</td><td valign="top" width="87"><span style="font-family: 宋体;">string</span>

</td><td valign="top" width="88"><span style="font-family: 宋体;">是</span>

</td><td valign="top" width="229"><span style="font-family: 宋体;">成功</span>

</td><td valign="top" width="442"><span style="font-family: 宋体;">状态码描述</span>

</td></tr><tr><td valign="top" width="255"><span style="font-family: 宋体;">createTime</span>

</td><td valign="top" width="87"><span style="font-family: 宋体;">string</span>

</td><td valign="top" width="88"><span style="font-family: 宋体;">否</span>

</td><td valign="top" width="229"></td><td valign="top" width="442"><span style="font-family: 宋体;">激活订单创建时间（返回</span><span style="font-family: 宋体;">100、80、81时，有值）格式：</span>yyyyMMddHHmmss

</td></tr><tr><td valign="center" width="255">s<span style="font-family: 宋体;">ign</span>

</td><td valign="center" width="87"><span style="font-family: 宋体;">string</span>

</td><td valign="center" width="88"><span style="font-family: 宋体;">是</span>

</td><td valign="center" width="229"></td><td valign="center" width="442"><span style="font-family: 宋体;">参考签名举例</span>

</td></tr><tr><td> </td><td> </td><td> </td><td> </td><td> </td></tr></tbody></table>

**返回报文举例**

```
{
    "createTime": "20200212100234",
    "message": "处理中",
    "sign": "EOMRl+jWgjGOTebWPRVqBDR1EPkyd/S7tsb/yEjvBoSfUZCEgVA6RNrjVEmIY15uJI9YV57tOZWy1FiVqJDH0lfEJnuk4DKpwcJMVCGXjQIH/Cd+PCibwBNknDWt9kaiB9JhxW8TrlBLYWq4ZyzffYtsF4qawyBgTLeUuPEOvoLZ2jA5OLtbSYVyI9g3OI4amcL25/GkRUw3ECmziAy9bTdVKmjV5FbWcyk45GM+K7/2a4/E6BihvVC2w6ge6xgDn0s5R9Ixaun5KhqcEJLHW/8vEAHMbx40uvsP91Aw9iiw5aZeGhpYoge89vAVTkC5boB8i+pgcpk0DqK4Jk25mA==",
    "statusCode": 80,
    "ver": 2
}

```