电子券包本处理类接口

激活前查询
接口用途 

 激活前查询是否可以激活 

 接口地址 

 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/activePreQuery 

 action 

 activePreQuery 

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

 字段 

 类型 

 是否必填 

 字段意义 

 备注 

 traceNo 

 String 

 是 

 收银机流水号 

 不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列 

 qrcode 

 String 

 是 

 二维码内容 

 券号code，或本号reelId，或者包号pkgId，或者箱号boxId，用,号隔开 

 businessType 

 Integer 

 是 

 业务类型 

 当businessType=12时为新逻辑支持箱的概念，返回的数据中包含箱的结构，该字段不传或者不等于12则为原来的逻辑不做任何变动，返回数据中不包含箱的结构 

 请求报文举例 

 {

 "traceNo": "99000009100010101732123",

 "qrcode": "R156A001-0000491-0505,R156A002-0000491-0505",

 "businessType": 12

}

 

 返回参数，易百后台===>中件间 

 字段 

 类型 

 是否必填 

 字段意义 

 备注 

 traceNo 

 String 

 是 

 收银机流水号 

 不允许重复 

 transDate 

 String 

 是 

 交易时间 

 格式为：yyyyMMddHHmmss 

 returnCode 

 String 

 是 

 返回码 

 P00表示待激活（可激活）；P01表示正在激活中（不可激活）；P02表示有部分券处于不可激活状态（不可激活）；P03表示已全部激活；P09表示该门店该城市不可激活 

 returnDesc 

 String 

 是 

 返回信息 

 交易结果描述或错误原因 

 voucherPkg 

 List< voucherPkg > 

 否 

 电子券包信息 

 返回电子券包信息 

 返回报文举例（请求中 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"

}

激活
接口用途 

 激活 

 接口地址 

 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/activeVoucher 

 action 

 activeVoucher 

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

 字段 

 类型 

 是否必填 

 字段意义 

 备注 

 traceNo 

 String 

 是 

 收银机流水号 

 不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列 

 qrcode 

 String 

 是 

 二维码内容 

 券号code，或本号reelId，或者包号pkgId，或者箱号boxId，用,号隔开 

 totalAmount 

 String 

 否 

 折后金额 

 激活券的折后金额，多个券则为总折后金额，单位：分 

 businessType 

 Integer 

 是 

 业务类型 

 当businessType=12时为新逻辑支持箱的概念，返回的数据中包含箱的结构，该字段不传或者不等于12则为原来的逻辑不做任何变动，返回数据中不包含箱的结构 

 请求报文举例 

 {

 "traceNo": "99000009100010101732123",

 "qrcode": "R156A001-0000491-0505,R156A002-0000491-0505",

 "totalAmount": "3000",

 "businessType": 12

}

 

 返回参数，易百后台===>中件间 

 字段 

 类型 

 是否必填 

 字段意义 

 备注 

 traceNo 

 String 

 是 

 收银机流水号 

 不允许重复 

 orderNo 

 String 

 是 

 本次激活操作订单号 

   

 transDate 

 String 

 是 

 交易时间 

 格式为：yyyyMMddHHmmss 

 returnCode 

 String 

 是 

 返回码 

 A00表示正在激活中（等待，做结果查询）；A02表示有部分券处于不可激活状态（未进行激活）；A03表示其他异常（未进行激活） 

 returnDesc 

 String 

 是 

 返回信息 

 交易结果描述或错误原因 

 voucherPkg 

 List< voucherPkg > 

 否 

 电子券包信息 

 返回电子券包信息 

 返回报文举例 

 {

 "traceNo": "99000009100010101732123",

 "orderNo": "99000009100010101732123",

 "transDate": "20161231120533",

 "returnCode": "00",

 "returnDesc": "SUCCESS"

}

激活结果查询
接口用途 

 激活结果查询 

 接口地址 

 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/activeResultQuery 

 action 

 activeResultQuery 

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

 字段 

 类型 

 是否必填 

 字段意义 

 备注 

 traceNo 

 String 

 是 

 收银机流水号 

 不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列 

 originalTraceNo 

 String 

 是 

 激活操作订单号 

   

 businessType 

 Integer 

 是 

 业务类型 

 当businessType=12时为新逻辑支持箱的概念，返回的数据中包含箱的结构，该字段不传或者不等于12则为原来的逻辑不做任何变动，返回数据中不包含箱的结构 

 请求报文举例 

 {

 "traceNo": "99000009100010101732123",

 "originalTraceNo": "99000009100010101732129",

 "businessType": 12

}

 

 返回参数，易百后台===>中件间 

 字段 

 类型 

 是否必填 

 字段意义 

 备注 

 traceNo 

 String 

 是 

 收银机流水号 

 不允许重复 

 orderNo 

 String 

 是 

 原激活操作订单号 

   

 transDate 

 String 

 是 

 交易时间 

 格式为：yyyyMMddHHmmss 

 returnCode 

 String 

 是 

 返回码 

 R00表示激活成功；R01表示激活失败；R02表示找不到原订单 

 returnDesc 

 String 

 是 

 返回信息 

 交易结果描述或错误原因 

 voucherPkg 

 List< voucherPkg > 

 否 

 电子券包信息 

 返回电子券包信息 

 返回报文举例 

 {

 "traceNo": "99000009100010101732123",

 "orderNo": "99000009100010101732123",

 "transDate": "20161231120533",

 "returnCode": "00",

 "returnDesc": "SUCCESS"

}

作废
接口用途 

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

 接口地址 

 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/delVoucher 

 action 

 delVoucher 

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

 字段 

 类型 

 是否必填 

 字段意义 

 备注 

 traceNo 

 String 

 是 

 收银机流水号 

 不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列 

 qrcode 

 String 

 是 

 二维码内容 

 券号code 

 businessType 

 Integer 

 是 

 业务类型 

 当businessType=12时为新逻辑支持箱的概念，返回的数据中包含箱的结构，该字段不传或者不等于12则为原来的逻辑不做任何变动，返回数据中不包含箱的结构 

 请求报文举例 

 {

 "traceNo": "9900000910001010920150201",

 "qrcode": "10014030013500006013",

 "businessType": 12

}

 

 返回参数，易百后台===>中件间 

 字段 

 类型 

 是否必填 

 字段意义 

 备注 

 traceNo 

 String 

 是 

 收银机流水号 

 不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列 

 orderNo 

 String 

 是 

 本次作废操作订单号 

   

 transDate 

 String 

 是 

 交易时间 

 格式为：yyyyMMddHHmmss 

 returnCode 

 String 

 是 

 返回码 

 V00表示作废成功；V01表示作废失败；V03表示券号错误 

 returnDesc 

 String 

 是 

 返回信息 

 交易结果描述或错误原因 

 voucherPkg 

 List< voucherPkg > 

 否 

 电子券包信息 

 返回电子券包信息 

 返回报文举例 

 {

 "traceNo": "9900000910001011020150201",

 "orderNo": "99000009100010101732123",

 "transDate": "20161231120533",

 "returnCode": "00",

 "returnDesc": "SUCCESS"

}

核销信息以及城市范围查询
接口用途 

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

 接口地址 

 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/queryVerifyInfo 

 action 

 queryVerifyInfo 

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

 字段 

 类型 

 是否必填 

 字段意义 

 备注 

 traceNo 

 String 

 是 

 收银机流水号 

 不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列 

 qrcode 

 String 

 是 

 二维码内容 

 券号code 

 businessType 

 Integer 

 是 

 业务类型 

 当businessType=12时为新逻辑支持箱的概念，返回的数据中包含箱的结构，该字段不传或者不等于12则为原来的逻辑不做任何变动，返回数据中不包含箱的结构 

 请求报文举例 

 {

 "traceNo": "9900000910001010720150201",

 "qrcode": "10085748356738476396436",

 "businessType": 12

}

 

 返回参数，易百后台===>中件间 

 字段 

 类型 

 是否必填 

 字段意义 

 备注 

 traceNo 

 String 

 是 

 收银机流水号 

 不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列 

 transDate 

 String 

 是 

 交易时间 

 格式为：yyyyMMddHHmmss 

 returnCode 

 String 

 是 

 返回码 

 H00表示可核销；H01表示该券未激活；H02表示该券已核销；H03表示券号有误 

 returnDesc 

 String 

 是 

 返回信息 

 交易结果描述或错误原因 

 voucherPkg 

 List< voucherPkg > 

 否 

 电子券包信息 

 返回电子券包信息 

 返回报文举例 

 {

 "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"

}

箱本激活
接口用途 

 激活 

 接口地址 

 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/reelActiveVoucher 

 action 

 activeVoucher 

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

 字段 

 类型 

 是否必填 

 字段意义 

 备注 

 traceNo 

 String 

 是 

 收银机流水号 

 不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列 

 qrcode 

 String 

 是 

 二维码内容 

 券号code，或本号reelId，或者包号pkgId，或者箱号boxId，用,号隔开 

 totalAmount 

 String 

 否 

 折后金额 

 激活券的折后金额，多个券则为总折后金额，单位：分 

 businessType 

 Integer 

 是 

 业务类型 

 当businessType=12时为新逻辑支持箱的概念，返回的数据中包含箱的结构，该字段不传或者不等于12则为原来的逻辑不做任何变动，返回数据中不包含箱的结构 

 请求报文举例 

 {

 "traceNo": "99000009100010101732123",

 "qrcode": "R156A001-0000491-0505,R156A002-0000491-0505",

 "totalAmount": "3000",

 "businessType": 12

}

 

 返回参数，易百后台===>中件间 

 字段 

 类型 

 是否必填 

 字段意义 

 备注 

 traceNo 

 String 

 是 

 收银机流水号 

 不允许重复 

 orderNo 

 String 

 是 

 本次激活操作订单号 

   

 transDate 

 String 

 是 

 交易时间 

 格式为：yyyyMMddHHmmss 

 returnCode 

 String 

 是 

 返回码 

 A00表示正在激活中（等待，做结果查询）；A02表示有部分券处于不可激活状态（未进行激活）；A03表示其他异常（未进行激活） 

 returnDesc 

 String 

 是 

 返回信息 

 交易结果描述或错误原因 

 voucherPkg 

 List< voucherPkg > 

 否 

 电子券包信息 

 返回电子券包信息 

 返回报文举例 

 {

 "traceNo": "99000009100010101732123",

 "orderNo": "99000009100010101732123",

 "transDate": "20161231120533",

 "returnCode": "00",

 "returnDesc": "SUCCESS"

}

箱本作废
接口用途 

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

 接口地址 

 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/reelDelVoucher 

 action 

 delVoucher 

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

 字段 

 类型 

 是否必填 

 字段意义 

 备注 

 traceNo 

 String 

 是 

 收银机流水号 

 不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列 

 qrcode 

 String 

 是 

 二维码内容 

 券号code 

 businessType 

 Integer 

 是 

 业务类型 

 当businessType=12时为新逻辑支持箱的概念，返回的数据中包含箱的结构，该字段不传或者不等于12则为原来的逻辑不做任何变动，返回数据中不包含箱的结构 

 请求报文举例 

 {

 "traceNo": "9900000910001010920150201",

 "qrcode": "10014030013500006013",

 "businessType": 12

}

 

 返回参数，易百后台===>中件间 

 字段 

 类型 

 是否必填 

 字段意义 

 备注 

 traceNo 

 String 

 是 

 收银机流水号 

 不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列 

 orderNo 

 String 

 是 

 本次作废操作订单号 

   

 transDate 

 String 

 是 

 交易时间 

 格式为：yyyyMMddHHmmss 

 returnCode 

 String 

 是 

 返回码 

 V00表示作废成功；V01表示作废失败；V03表示券号错误 

 returnDesc 

 String 

 是 

 返回信息 

 交易结果描述或错误原因 

 voucherPkg 

 List< voucherPkg > 

 否 

 电子券包信息 

 返回电子券包信息 

 返回报文举例 

 {

 "traceNo": "9900000910001011020150201",

 "orderNo": "99000009100010101732123",

 "transDate": "20161231120533",

 "returnCode": "00",

 "returnDesc": "SUCCESS"

}