# 电子券包本处理类接口列表 # 激活前查询 #### **接口用途** - 激活前查询是否可以激活 #### **接口地址** - `https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/activePreQuery` #### **action** - activePreQuery **请求参数,中间件===>易百后台**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
onlineTidString线上对接使用的统一终端号对接前需提前和易百技术沟通
qrcodeString二维码内容券号code,或本号reelId,或者包号pkgId,或者箱号boxId,用,号隔开
businessTypeInteger业务类型当businessType=12时为新逻辑支持箱的概念,返回的数据中包含箱的结构,该字段不传或者不等于12则为原来的逻辑不做任何变动,返回数据中不包含箱的结构
**请求报文举例** ``` { "traceNo": "99000009100010101732123", "qrcode": "R156A001-0000491-0505,R156A002-0000491-0505", "businessType": 12 } ``` **返回参数,易百后台===>中件间**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
transDateString交易时间格式为:yyyyMMddHHmmss
returnCodeString返回码P00表示待激活(可激活);P01表示正在激活中(不可激活);P02表示有部分券处于不可激活状态(不可激活);P03表示已全部激活;P09表示该门店该城市不可激活
returnDescString返回信息交易结果描述或错误原因
voucherPkgList<[voucherPkg](https://book.e-buy.com/books/e-buy-B6z/page/854d9)>电子券包信息返回电子券包信息
orderRemarkString订单备注订单备注信息,除基本信息,也用于部分透传字段场景使用,如品牌核销渠道等。
**返回报文举例(请求中 businessType 值为 12 时)** ``` { "transDate": "20190107143930", "returnDesc": "success", "orderRemark": "天猫" "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", "orderRemark": "天猫" "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" } ``` # 激活 #### **接口用途** - 激活 #### **接口地址** - `https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/activeVoucher` #### **action** - activeVoucher **请求参数,中间件===>易百后台**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
onlineTidString线上对接使用的统一终端号对接前需提前和易百技术沟通
qrcodeString二维码内容券号code,或本号reelId,或者包号pkgId,或者箱号boxId,用,号隔开
totalAmountString折后金额激活券的折后金额,多个券则为总折后金额,单位:分
businessTypeInteger业务类型当businessType=12时为新逻辑支持箱的概念,返回的数据中包含箱的结构,该字段不传或者不等于12则为原来的逻辑不做任何变动,返回数据中不包含箱的结构
orderRemarkString订单备注订单备注信息,除基本信息,也用于部分透传字段场景使用,如品牌核销渠道等。
**请求报文举例** ``` { "traceNo": "99000009100010101732123", "qrcode": "R156A001-0000491-0505,R156A002-0000491-0505", "totalAmount": "3000", "businessType": 12, "orderRemark": "天猫" } ``` **返回参数,易百后台===>中件间**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
orderNoString本次激活操作订单号
transDateString交易时间格式为:yyyyMMddHHmmss
returnCodeString返回码A00表示正在激活中(等待,做结果查询);A02表示有部分券处于不可激活状态(未进行激活);A03表示其他异常(未进行激活)
returnDescString返回信息交易结果描述或错误原因
voucherPkgList<[voucherPkg](https://book.e-buy.com/books/e-buy-B6z/page/854d9)>电子券包信息返回电子券包信息
orderRemarkString订单备注订单备注信息,除基本信息,也用于部分透传字段场景使用,如品牌核销渠道等。
**返回报文举例** ``` { "traceNo": "99000009100010101732123", "orderNo": "99000009100010101732123", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "orderRemark": "天猫" } ``` # 激活结果查询 #### **接口用途** - 激活结果查询 #### **接口地址** - `https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/activeResultQuery` #### **action** - activeResultQuery **请求参数,中间件===>易百后台**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
onlineTidString线上对接使用的统一终端号对接前需提前和易百技术沟通
originalTraceNoString激活操作订单号
businessTypeInteger业务类型当businessType=12时为新逻辑支持箱的概念,返回的数据中包含箱的结构,该字段不传或者不等于12则为原来的逻辑不做任何变动,返回数据中不包含箱的结构
**请求报文举例** ``` { "traceNo": "99000009100010101732123", "originalTraceNo": "99000009100010101732129", "businessType": 12 } ``` **返回参数,易百后台===>中件间**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
orderNoString原激活操作订单号
transDateString交易时间格式为:yyyyMMddHHmmss
returnCodeString返回码R00表示激活成功;R01表示激活失败;R02表示找不到原订单
returnDescString返回信息交易结果描述或错误原因
voucherPkgList<[voucherPkg](https://book.e-buy.com/books/e-buy-B6z/page/854d9)>电子券包信息返回电子券包信息
orderRemarkString订单备注订单备注信息,除基本信息,也用于部分透传字段场景使用,如品牌核销渠道等。
**返回报文举例** ``` { "traceNo": "99000009100010101732123", "orderNo": "99000009100010101732123", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "orderRemark": "天猫" } ``` # 作废 #### **接口用途** - 作废,作废后的券不可激活 #### **接口地址** - `https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/delVoucher` #### **action** - delVoucher **请求参数,中间件===>易百后台**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
onlineTidString线上对接使用的统一终端号对接前需提前和易百技术沟通
qrcodeString二维码内容券号code,多个用,号隔开
businessTypeInteger业务类型当businessType=12时为新逻辑支持箱的概念,返回的数据中包含箱的结构,该字段不传或者不等于12则为原来的逻辑不做任何变动,返回数据中不包含箱的结构;当businessType=1001时为批量反激活;当businessType=1002时为批量作废。
orderRemarkString订单备注订单备注信息,除基本信息,也用于部分透传字段场景使用,如品牌核销渠道等。
**请求报文举例** ``` { "traceNo": "9900000910001010920150201", "qrcode": "10014030013500006013", "businessType": 12, "orderRemark": "天猫" } ``` **返回参数,易百后台===>中件间**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
orderNoString本次作废操作订单号
transDateString交易时间格式为:yyyyMMddHHmmss
returnCodeString返回码V00表示作废成功;V01表示作废失败;V03表示券号错误
returnDescString返回信息交易结果描述或错误原因
voucherPkgList<[voucherPkg](https://book.e-buy.com/books/e-buy-B6z/page/854d9)>电子券包信息返回电子券包信息
orderRemarkString订单备注订单备注信息,除基本信息,也用于部分透传字段场景使用,如品牌核销渠道等。
**返回报文举例** ``` { "traceNo": "9900000910001011020150201", "orderNo": "99000009100010101732123", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "orderRemark": "天猫" } ``` # 核销信息以及城市范围查询 #### **接口用途** - 核销信息以及城市范围查询 #### **接口地址** - `https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/queryVerifyInfo` #### **action** - queryVerifyInfo **请求参数,中间件===>易百后台**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
qrcodeString二维码内容券号code
businessTypeInteger业务类型当businessType=12时为新逻辑支持箱的概念,返回的数据中包含箱的结构,该字段不传或者不等于12则为原来的逻辑不做任何变动,返回数据中不包含箱的结构
**请求报文举例** ``` { "traceNo": "9900000910001010720150201", "qrcode": "10085748356738476396436", "businessType": 12 } ``` **返回参数,易百后台===>中件间**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
transDateString交易时间格式为:yyyyMMddHHmmss
returnCodeString返回码H00表示可核销;H01表示该券未激活;H02表示该券已核销;H03表示券号有误
returnDescString返回信息交易结果描述或错误原因
voucherPkgList<[voucherPkg](https://book.e-buy.com/books/e-buy-B6z/page/854d9)>电子券包信息返回电子券包信息
orderRemarkString订单备注订单备注信息,除基本信息,也用于部分透传字段场景使用,如品牌核销渠道等。
**返回报文举例** ``` { "transDate":"20190107143930", "returnDesc":"success", "orderRemark": "天猫", "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" } ```