箱本包处理类接口


激活查询

接口用途

action

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

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

激活

接口用途

action

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

字段 类型 是否必填 字段意义 备注
traceNo String 收银机流水号 不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
qrcode String 二维码内容 券号code
totalAmount String 折后金额 激活券的折后金额,多个券则为总折后金额,单位:分
businessType Integer 业务类型 当businessType=12时为新逻辑支持箱的概念,返回的数据中包含箱的结构,该字段不传或者不等于12则为原来的逻辑不做任何变动,返回数据中不包含箱的结构
extendData JSONObject<activeInfo> 扩展信息 特殊场景填值需与易百技术沟通

请求报文举例

{
    "traceNo": "99000009100010101732123",
    "qrcode": "R156A001-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"
}

激活结果查询

接口用途

action

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

字段 类型 是否必填 字段意义 备注
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"
}

作废

接口用途

action

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

字段 类型 是否必填 字段意义 备注
traceNo String 收银机流水号 不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
qrcode String 二维码内容 券号code

请求报文举例

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

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

接口用途

action

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

字段 类型 是否必填 字段意义 备注
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"
}

B2B饮料券箱本激活

接口用途

action

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

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

请求报文举例

{
    "traceNo": "99000009100010101732123",
    "qrcode": "R156A001-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"
}

B2B饮料券箱本作废

接口用途

action

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

字段 类型 是否必填 字段意义 备注
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"
}

卡号段激活实体卡券(B2B定制)

接口用途

action

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

字段 类型 是否必填 字段意义 备注

ver

int

2

接口版本(固定参数值)

partnerId

int

1504

商户编号(固定参数值)

merchantId

string

10001(星巴克中国)

App商家在非码系统中的编号(固定参数值)

sign

string

 

参考签名举例

partnerOrderId

String

 

激活订单号,商户激活操作唯一,最大28位。(若第一次请求成功的订单号再次请求,则返回此订单号处理进度,与startCardSeendCardSe值无关)

type

int

 

激活对象类型(固定值实体券2)

bin

string

 

bin(实体券:7020)获取券码取前4

codeType

string

 

激活实体券时必填,3

startCardSe

string

 

起始激活卡券号段,含当前号段。(7位)

endCardSe

string

 

终止激活卡券号段,含当前号段。(7位)

number

int

 

激活数量

sellingPrice

int

 

商品成本价 ,单位:分(激活实体券时必传,若没有A,B账户则传sellingPrice=costPrice)。

costPrice

int

 

商品售价。此字段不能大于sellingPrice,单位:分(激活实体券时必传,若没有A,B账户则传sellingPrice=costPrice)(折扣价=成本价-售价)。

validStart

String

 

有效期开始时间,格式:yyyy-MM-dd HH:mm:ss(激活实体券时使用,激活时若validStart 和 validEnd 都不传,默认三年有效期。)

valid_end

string

 

有效期结束时间,格式:yyyy-MM-dd HH:mm:ss(激活实体券时使用,激活时若validStart 和 validEnd 都不传,默认三年有效期。)

请求报文举例

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

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

字段 类型 是否必填 字段意义 备注

ver

int

2

接口版本

statusCode

int

100:SUCCESS

返回码:100表示创建成功;

        80表示处理中;

        81 表示处理完成。

 

message

string

成功

状态码描述

createTime

string

 

激活订单创建时间(返回100、80、81时,有值)格式:yyyyMMddHHmmss

sign

string

 

参考签名举例

         

返回报文举例

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