e-Buy 电子券4.1
- 接入说明
- 交易
- 查询
- 核销
- 通知
- 运营
- 创建券产品
- prod同步stg数据
- 变更券产品
- 券产品详情查询
- 创建批次
- 批次编辑
- 批次详情查询
- 创建销售渠道
- 编辑销售渠道
- 查询销售渠道
- 批次变更通知接口
- 销售批次列表查询
- 创建产品预取任务
- 查询预取任务结果
- 查询预取产品库存
- 数据字典
- 码商通知下发
- 码商业务接口
- message通知
- 业务参数对象
接入说明
接入说明
文档修订记录
接入说明
接入事项
对接环境相关参数
uat环境地址
https://dev-paas-gateway.e-buy.com
pro环境地址
找对应运营人员提供
相关密钥
找对应运营人员开通 paas租户接入账户（appId、appSecret），还请妥善保管避免
接入说明
签名相关
交互方式为HTTPS协议，提交方式为POST，字符集为:UTF-8
算法为 SHA-256，字符集为:UTF-8，将请求体byte转为16进制，获取签名串
参与签名完整字符串拼接如：
action=makeCode&appId=ebuydfc6fd99ee14&content={"item":{"makeFundsChannel":{"benefitAmount":0,"channelBenefit":0,"discountAmount":0,"merchantBenefit":0,"merchantCustomBenefit":-1,"merchantCustomRealAmount":-1,"merchantRealAmount":0,"totalAmount":0,"userRealAmount":0},"outerOrderItemId":"1655535941106124","ticketId":1000000010947},"outerOrderId":"1655535941106124"}&lang=zh-CN&signType=sha256×tamp=1655609300931&uuid=20220619-c9b8735302214183a599e8d4fdaa81d9&i79zzmh1vwkdhefmwp7yh2h11w4094m3
appSecret 需要申请开通对应的租户app获取，demo中为 【i79zzmh1vwkdhefmwp7yh2h11w4094m3】
注意参与签名字符串需要拼接&密钥,参与生成签名
请求demo
{
"action": "makeCode",
"appId": "ebuydfc6fd99ee14",
"content": "{\"item\":{\"makeFundsChannel\":{\"benefitAmount\":0,\"channelBenefit\":0,\"discountAmount\":0,\"merchantBenefit\":0,\"merchantCustomBenefit\":-1,\"merchantCustomRealAmount\":-1,\"merchantRealAmount\":0,\"totalAmount\":0,\"userRealAmount\":0},\"outerOrderItemId\":\"1655535941106124\",\"ticketId\":1000000010947},\"outerOrderId\":\"1655535941106124\"}",
"headers": {
"paas-version": "1.1.0"
},
"lang": "zh-CN",
"sign": "b306f50243ecbd78ba454043cd4e6f63fc5e88d1cdf2dfb5aa7b503aec8ae3ee",
"signType": "sha256",
"timestamp": 1655609300931,
"uuid": "20220619-c9b8735302214183a599e8d4fdaa81d9"
}
请求响应demo
{
"action": "makeCode",
"errorCode": "50",
"errorMessage": "业务处理错误,单个制码销售渠道信息[ebuydfc6fd99ee14]为空",
"sign": "2073ee120e7d396d227fdddcd64f1ce3e186c106af6c968c83b6a7b1e7ba1dcb",
"signType": "sha256",
"success": false,
"timestamp": 1655607812062,
"uuid": "20220619-e18fc85ee1fb43efb0b7077fe3a80274"
}
相关说明
- lang 语言默认zh-CN
- uuid 请求序列号，需要保证本系统唯一,格式要求(yyyymmdd-32位随机串)
- appId 通过运营人员开通paas租户权限获取
- action 业务请求接口路径
- headers 默认 {"paas-version": "1.1.0"}
- signType 签名算法名 默认sha256
- timestamp 当前系统请求时间戳
- sign 请求报文签名字符串
- content 具体业务请求体,签名前需将请求体转为字符串，参与签名获取签名字符串
接入说明
相关名词解释
接入说明
对接demo
package com.ebuytech.paas.micro.eocupon.sdk.test;
import com.alibaba.fastjson.JSON;
import com.ebuytech.paas.micro.ecoupon.sdk.client.DefaultPaasClient;
import com.ebuytech.paas.micro.ecoupon.sdk.constant.ApiInterface;
import com.ebuytech.paas.micro.ecoupon.sdk.exception.SDKException;
import com.ebuytech.paas.micro.ecoupon.sdk.model.AuthConfig;
import com.ebuytech.paas.micro.ecoupon.sdk.model.bo.FundsChannelBO;
import com.ebuytech.paas.micro.ecoupon.sdk.model.req.PaasRequest;
import com.ebuytech.paas.micro.ecoupon.sdk.model.req.make.MakeCodeRequest;
import com.ebuytech.paas.micro.ecoupon.sdk.model.req.make.MakeCodeRequestItem;
import com.ebuytech.paas.micro.ecoupon.sdk.model.res.PaasResponse;
import lombok.extern.slf4j.Slf4j;
import org.junit.Test;
import org.springframework.boot.test.context.SpringBootTest;
import java.math.BigDecimal;
/**
* <pre>
* 同步制码
* </pre>
*
* @author jysemel
* @version 2022/7/11 15:20
*/
@Slf4j
@SpringBootTest
public class EcouponMakeCodeTest {
public static DefaultPaasClient defaultPaasClient = new DefaultPaasClient("https://dev-paas-gateway.e-buy.com");
@Test
public void makeCodeTest() throws SDKException {
AuthConfig authConfig = new AuthConfig();
authConfig.setAppId("ebuy439fec8ce941");
authConfig.setAppSecret("dc548cadfbb8aa92c57a2944a3d38ea8");
//请求体
MakeCodeRequest makeCodeRequest = new MakeCodeRequest();
makeCodeRequest.setOuterOrderId("UbZh2QVL");
//制码订单
MakeCodeRequestItem requestItem = new MakeCodeRequestItem();
requestItem.setOuterOrderItemId("UbZh2QVL");
requestItem.setCodeCount(1);
requestItem.setTicketId(1031000000014283L);
//制码资金渠道
FundsChannelBO fundsChannelBO = new FundsChannelBO();
fundsChannelBO.setTotalAmount(new BigDecimal(89));
// fundsChannelBO.setUserRealAmount(new BigDecimal(89));
requestItem.setMakeFundsChannel(fundsChannelBO);
makeCodeRequest.setItem(requestItem);
PaasRequest request = new PaasRequest();
// request.getHeaders().put("paas-darklaunch", "DarkLaunch");
request.setContent(JSON.toJSONString(makeCodeRequest));
PaasResponse response = defaultPaasClient.execute(request, ApiInterface.makeCode.getApiUrl(), authConfig);
log.info("----{}", JSON.toJSONString(request));
log.info("----{}", JSON.toJSONString(response));
}
}
交易
交易
单码制码
[yapi_interface]29767[/yapi_interface]
交易
异步批量制码
[yapi_interface]29847[/yapi_interface]
交易
制码撤销
[yapi_interface]29842[/yapi_interface]
交易
串码状态更新
[yapi_interface]29892[/yapi_interface]
交易
串码明细更新
[yapi_interface]29897[/yapi_interface]
交易
批量同步激活券码
[yapi_interface]35535[/yapi_interface]
交易
批量同步取消激活券码
[yapi_interface]35550[/yapi_interface]
交易
批量同步券码状态更新
[yapi_interface]36402[/yapi_interface]
交易
单码串码激活
[yapi_interface]32382[/yapi_interface]
查询
查询
电子券核销查询接口
[yapi_interface]34137[/yapi_interface]
查询
查询码明细
[yapi_interface]32867[/yapi_interface]
查询
查询码状态
[yapi_interface]32862[/yapi_interface]
查询
制码查询
[yapi_interface]29082[/yapi_interface]
查询
查询券批次相关信息
[yapi_interface]35532[/yapi_interface]
查询
查询批次库存
[yapi_interface]37212[/yapi_interface]
核销
核销
电子券核销接口
[yapi_interface]32027[/yapi_interface]
核销
电子券核销撤销接口
[yapi_interface]32177[/yapi_interface]
核销
三方单码核销通知
[yapi_interface]35552[/yapi_interface]
核销
三方单码核销撤销通知
[yapi_interface]35553[/yapi_interface]
核销
三方码批量核销通知接口
[yapi_interface]37518[/yapi_interface]
核销
三方码批量核销撤销通知接口
[yapi_interface]37524[/yapi_interface]
通知
根据三方需求由券平台主动发起通知第三方平台
通知
制码通知
[yapi_interface]32877[/yapi_interface]
通知
制码撤销通知
[yapi_interface]32882[/yapi_interface]
通知
更新码状态通知
[yapi_interface]32887[/yapi_interface]
通知
核销通知
[yapi_interface]32897[/yapi_interface]
通知
核销撤销通知
[yapi_interface]32902[/yapi_interface]
通知
批量异步制码通知
[yapi_interface]35513[/yapi_interface]
通知
批次变更通知
接口用途
用于批次变更通知
接口说明
批次变更通知后将数据发送到mq，ebuyweb-gateway来接收mq消息
mq信息
exchange：ex-micro-ecoupon-admin
路由键：rk-micro-ecoupon-admin.ecouponTicketNotice
队列名称：qu-micro-ecoupon-admin.ecouponTicketNotice
发送报文
| 字段 | 类型 | 字段意义 |
|---|---|---|
| ticketName | String | 批次名称 |
| ticketType | String | 批次类型 |
| ticketStatus | String | 批次状态 |
| productId | String | 产品ID |
| saleChannelId | String | 取码方ID |
| saleChannelInfo | JSONObject | 取码方配置 |
| codeCount | int | 可制码总数量 |
| brandSalePrice | bigDecimal | 商户销售价格 |
| ticketValidStart | Date | 批次有效期开始时间 |
| ticketValidEnd | Date | 批次有效期开始时间 |
| codeValidStart | Date | 券码有效期开始时间 |
| codeValidEnd | Date | 券码有效期开始时间 |
| codeValidDays | int | 串码相对有效天数 |
| ticketUseDescription | String | 批次使用描述 |
| ticketConfig | JSONObject | 批次配置 |
| paymentParam | JSONObject | 收银参数 |
| tenancyId | Long | 租户ID |
| tenancyName | String | 租户名称 |
| brandId | Long | 品牌ID |
| brandName | String | 品牌名称 |
返回报文实例
{
"appId": "ebuy1674d4f2ca58",
"brandId": 1158,
"brandName": "汉堡王",
"brandSalePrice": -1,
"codeCount": -1,
"codeValidDays": 30,
"commissionDate": 0,
"createBy": "script",
"createDate": 1660551434000,
"notifyChannelId": 1620,
"paymentParam": {
"needBarcode": false,
"makeNotify2UserTemplate": "尊敬的e-Buy贵宾，凭串号%code%可在汉堡王门店(机场店除外)使用兑换%product_name%1杯，共可使用%total%次。即日起至%validdate%内兑换有效。详询4008211400",
"paymentParam": "{\"discountCode\":\"127|%merchant_benefit%\",\"tenderCode\":\"637|%user_real_money%\",\"goods\":[{\"quantity\":\"1\",\"goodsId\":\"40135\",\"price\":\"8\",\"goodsCategory\":\"\",\"goodsName\":\"【抖音北海风味华夫筒】北海道风味华夫筒*2\"}]}",
"verifyNotify2UserTemplate": "您本次已成功兑换%product_name%1杯，还剩%remain%杯可兑换。如有疑问请详询4008211400",
"needReturnBuyGoods": false,
"printTemplate": "00|兑换产品:抖音北海风味华夫筒 X 1|",
"returnBuyProduct": "N",
"onlyAllowOneVerify": "N",
"verifyNotifyConf": "00",
"makeNotifyConf": "00",
"thirdCodeMap": "",
"voidNotifyConf": "00",
"smsMakeNotifySrc": "10691046036",
"isOverIncome": "1",
"smsVerifyNotifySrc": "10691046036"
},
"productId": 2170,
"saleChannelId": 56,
"saleChannelInfo": {
"productSource": "易百小E",
"saleChannelName": "抖音",
"activity": "【汉堡王】 汉堡王抖音活动-2021第3期",
"saleChannelId": 56,
"thirdpartySourceId": "503006"
},
"saleTenancyName": "汉堡王",
"status": "0",
"tenancyId": 22,
"tenancyName": "汉堡王",
"ticketBindInfo": {
"brandTicketId": "",
"ebuyTicketName": "抖音北海风味华夫筒[抖音汉堡王取码]",
"ebuyTicketId": "518898_1000000010538",
"thirdSendTicketId": "",
"messageTemplate": ""
},
"ticketConfig": {
"waringPerson": [
],
"needDynamicCode": false,
"supportNextDayCancel": "N",
"waringVal": "",
"needFilterGoodsDetail": "Y",
"needShortLink": false,
"needThirdQrcode": false,
"needUploadGov": false,
"supportSameDayCancel": "N"
},
"ticketName": "抖音北海风味华夫筒2",
"ticketStatus": "0",
"ticketValidEnd": 1735660799000,
"ticketValidStart": 1630425600000,
"ticketWhaleId": "518898_1000000010538",
"updateBy": "解元浩",
"updateDate": 1660894052878,
"uuid": "20220819-d32Da3DEeEcc4b44CB2ea1DfabBBBBC1"
}
通知
批量激活通知下发报文
[yapi_interface]35923[/yapi_interface]
通知
批量取消激活通知下发报文
[yapi_interface]35925[/yapi_interface]
运营
运营
创建券产品
[yapi_interface]36408[/yapi_interface]
运营
prod同步stg数据
[yapi_interface]36594[/yapi_interface]
运营
变更券产品
[yapi_interface]36474[/yapi_interface]
运营
券产品详情查询
[yapi_interface]36426[/yapi_interface]
运营
创建批次
[yapi_interface]36432[/yapi_interface]
运营
批次编辑
[yapi_interface]36468[/yapi_interface]
运营
批次详情查询
[yapi_interface]36444[/yapi_interface]
运营
创建销售渠道
[yapi_interface]36450[/yapi_interface]
运营
编辑销售渠道
[yapi_interface]36456[/yapi_interface]
运营
查询销售渠道
[yapi_interface]36462[/yapi_interface]
运营
批次变更通知接口
[yapi_interface]36342[/yapi_interface]
运营
销售批次列表查询
[yapi_interface]36396[/yapi_interface]
运营
创建产品预取任务
[yapi_interface]37392[/yapi_interface]
运营
查询预取任务结果
[yapi_interface]37398[/yapi_interface]
运营
查询预取产品库存
[yapi_interface]37404[/yapi_interface]
数据字典
数据字典
API响应码汇总
| 场景 | 响应码 | 响应码描述 |
|---|---|---|
| 通用 | ||
| 90 | 同步错误 | |
| 91 | 请求流水号重复 | |
| 92 | 报文参数遗漏 | |
| 93 | 制码规则错误 | |
| 95 | 制码失败 | |
| 96 | 系统故障 | |
| 97 | 报文错误 | |
| 98 | MAC校验失败 | |
| 99 | 系统繁忙 | |
| 券码相关 | ||
| 00 | 操作成功 | |
| 01 | 处理失败 | |
| 02 | 本操作不被支持 | |
| 03 | 系统处理中 | |
| 04 | 参数配置错误 | |
| 05 | 制码订单不存在 | |
| 06 | 活动产品状态异常 | |
| 07 | 无操作权限 | |
| 09 | 提取预制码失败 | |
| 10 | 码不存在 | |
| 11 | 微信通知失败 | |
| 12 | 串码无可使用次数 | |
| 13 | 码参数配置错误 | |
| 14 | 通知成功 | |
| 15 | 码当前状态不可使用 | |
| 16 | 非对账时间 | |
| 17 | 串码生成失败 | |
| 18 | 串码生成失败 | |
| 19 | 重复的流水号 | |
| 1A | 码BIN不存在 | |
| 1B | 码BIN重复 | |
| 1C | 码BIN分组不存在 | |
| 1D | 解析动态码失败 | |
| 1E | 订单不存在 | |
| 1G | 订单不存在 | |
| 1F | 执行码兑换操作失败 | |
| 1H | 第三方码券状态不正确，券无效 | |
| 50 | 券不存在 | |
| 51 | 券参数配置错误 | |
| 52 | 券绑定失败 | |
| 30 | 券模版不存在 | |
| 31 | 使用时间或日期有限制 | |
| 32 | 券模板配置错误 | |
| 33 | 该券不能用于兑换 | |
| 40 | 活动不存在 | |
| 41 | 活动参数配置错误 | |
| 49 | POS终端不存在 | |
| 50 | 取码方不存在 | |
| 51 | 制码方不存在 | |
| 52 | 对接方不存在 | |
| 54 | 对接方不存在 | |
| 53 | 取码方不匹配 | |
| 55 | 品牌不存在 | |
| 核销相关 | ||
| A1 | 券类型在使用黑名单中 | |
| A2 | 未达到消费门槛 | |
| A3 | 不支持溢收 | |
| A4 | 第三方核销转发失败 | |
| B7 | 不可重复优惠 | |
| C1 | 商户门店号信息有误 | |
| C2 | 商户无权限 | |
| T1 | 调用第三方系统未收到返回 | |
| T2 | 调用第三方返回报文格式错误 | |
| T3 | 第三方实时核销失败 | |
| T4 | 第三方实时核销撤销失败 | |
| 00 | 固定 电子凭证未使用,初始状态，可使用 | |
| 01 | 固定 电子凭证已使用，码已核销 | |
| 03 | 固定 电子凭证未激活 | |
| 06 | 固定 过期 | |
| 07 | 固定 使用时间还没开始 | |
| 08 | 固定 不能退款 | |
| 09 | 固定 电子凭证不存在 | |
| 20 | 交易不能撤销 | |
| 21 | 电子凭证不可用 | |
| 22 | 请求参数错误 | |
| 23 | 商户不存在 | |
| 24 | 制码订单不存在 | |
| 25 | 找不到原始交易 | |
| 26 | 商户无效 | |
| 27 | 劵和品牌不一致 | |
| 32 | 请求中间状态，请查询交易结果 | |
| 33 | 配置错误 | |
| 34 | 劵配置错误，组合劵单品牌存在多个劵 | |
| 35 | 没有匹配的劵 | |
| 36 | 码核销，码表更新失败，查看码表的码是否正确配置 | |
| 37 | 码已撤销 | |
| 38 | 核销撤销失败 | |
| 39 | 限制规则执行失败 | |
| 40 | 一笔订单只能用一张劵 | |
| 91 | 执行失败 | |
| 99 | 数据库异常 |
码商通知下发
码商通知下发
码商通知下发
核销通知
[yapi_interface]35552[/yapi_interface]
码商通知下发
核销撤销通知
[yapi_interface]35553[/yapi_interface]
码商通知下发
外部订单周期区间查询
[yapi_interface]35926[/yapi_interface]
码商通知下发
外部订单明细查询
[yapi_interface]35927[/yapi_interface]
码商业务接口
码商业务接口
单码接口
[yapi_interface]36263[/yapi_interface]
码商业务接口
批量发码
[yapi_interface]36267[/yapi_interface]
码商业务接口
券码查询
[yapi_interface]35604[/yapi_interface]
码商业务接口
券码作废
[yapi_interface]36265[/yapi_interface]
码商业务接口
制码查询
[yapi_interface]36268[/yapi_interface]
message通知
ebuyweb-message消费易百券系统v4.1标准通知，并将通知分发到外部。
易百券系统v4.1标准通知参见：通知 | e-Buy Docs
message通知
制码通知
基本信息
制码通知，易百将制码通知分发给渠道或者品牌，对接方需提供接口接收通知。
请求参数
Headers
| 参数名称 | 参数值 | 是否必填 |
| Content-Type | application/json | 是 |
Body
| 参数名称 | 类型 | 必填 | 默认值 | 备注 | 其他信息 |
| channelInfoList | array | 是 | 通知渠道列表 | ||
| |__action | string | 是 | VerifyCodeNotify | 通知action | 最大长度：24 最小长度：1 |
| |__channelAppId | string | 是 | ebuy19915d0498cf | 通知渠道appId | 最大长度：24 最小长度：1 |
| |__channelId | string | 是 | ebuywha102410004 | 通知渠道id | 最大长度：24 最小长度：1 |
| |__channelName | string | 是 | 易百演示 | 通知渠道名称 | 最大长度：16 最小长度：1 |
| |__channelType | string | 是 | saleChannel | 通知渠道类型 | 最大长度：12 最小长度：1 |
| |__messageType | string | 是 | ebuy | 通知消息格式 | 最大长度：12 最小长度：1 |
| |__notifyType | string | 是 | Verify | 通知消息类型 | 最大长度：12 最小长度：1 |
| |__ticketIds | array | 是 | 券批次活动id | ||
| |__transferUrl | string | 否 | 通知渠道三方地址 | 最大长度：255 最小长度：1 |
|
| appId | string | 是 | 核销请求appid | ||
| codeCount | number | 否 | |||
| createDate | number | 否 | 最大长度：8 | ||
| items | array | 是 | |||
| |__activityId | string | 否 | |||
| |__activityName | string | 否 | |||
| |__brandSalePrice | number | 否 | |||
| |__codeCount | number | 否 | |||
| |__codeDetails | array | 否 | |||
| |__code | string | 否 | 券码 | ||
| |__codeH5Url | string | 否 | 券码链接 | ||
| |__codeMask | string | 否 | |||
| |__codePicUrl | string | 否 | |||
| |__searchCode | string | 否 | |||
| |__status | string | 否 | |||
| |__statusDesc | string | 否 | |||
| |__useTimes | number | 否 | |||
| |__ticketId | string | 否 | 券批次id | ||
| |__ticketName | string | 否 | 券批次名称 | ||
| |__ecouponType | string | 否 | |||
| |__outerOrderItemId | string | 否 | |||
| |__productId | number | 否 | |||
| |__productName | string | 否 | |||
| |__returnCode | string | 否 | |||
| |__returnMessage | string | 否 | |||
| |__ticketWhaleId | string | 否 | |||
| |__validEnd | number | 否 | |||
| |__validStart | number | 否 | |||
| |__userInfo | object | 否 | 制码用户信息 | ||
| |__mobile | string | 否 | 制码上送用户手机号 | ||
| |__thirdUserId | string | 否 | 制码上送用户id | ||
| |__thirdPlatformType | string | 否 | 上送平台类型 | ||
| |__uuid | string | 否 | |||
| |__orderRemark | string | 否 | |||
| |__outerOrderId | string | 否 | |||
| |__saleAppId | string | 否 | |||
| |__saleChannelId | string | 否 |
参数请参考（原始参数均来自券系统4.1）：制码通知 | e-Buy Docs
请求示例
{
"outerOrderId": "20591242205212698112000",
"userInfo": {
},
"channelInfoList": [
{
"transferUrl": "https://ups.starbucks.com.cn/***",
"notifyType": "MakeCode",
"whaleChannel": false,
"messageType": "third",
"channelAppId": "ebuywha102410120",
"action": "MakeCodeNotify",
"channelName": "星巴克GC",
"channelType": "brandChannel",
"channelId": "674",
"ticketIds": [
1000000010882
]
}
],
"codeCount": 1,
"saleChannelId": 138,
"appId": "ebuywha102410120",
"saleAppId": "ebuywha102410120",
"orderRemark": "{\"trackingNo\":\"COU20210825001\"}",
"items": [
{
"codeCount": 1,
"productId": 5249,
"brandSalePrice": -1,
"validStart": -62170185600000,
"activityName": "【星巴克GC】 星巴克电子券平台运维-2021第13期",
"returnMessage": "SUCCESS",
"thirdSendTicketId": "C0002204",
"productName": "大杯饮品电子券\t",
"ticketUseDescription": {
"useThreshold": "3400"
},
"activityId": "503152",
"returnCode": "00",
"ecouponType": "exchangeCoupon",
"outerOrderItemId": "20591242205212698112000",
"validEnd": -62170185600000,
"codeDetails": [
{
"code": "1004240520320002019=JN3kEB19",
"statusDesc": "未激活",
"codeH5Url": "https://w.ebuy.io/lk/dtnGGoWZGf",
"codeMask": "100***EB19",
"searchCode": "1004240520320002019",
"status": "03",
"useTimes": 1
}
],
"ticketId": 1000000010882,
"ticketWhaleId": "519423_1000000010882",
"ticketName": "大杯饮品电子券\t"
}
],
"uuid": "20240520-78293a474547477f97f3f074ebbf8ba8",
"createDate": 1716206401876
}响应
响应参数
| 参数名称 | 类型 | 必填 | 默认值 | 备注 | 其他信息 |
| code | string | 是 | 响应码 | ||
| message | string | 否 | 响应消息 |
响应示例
{"code":"EB_SUCCESS","message":"操作成功"}注意：
响应码不为EB_SUCCESS 或 EB_FAIL 易百将会进行重试，请保证接口幂等性。
- {"code":"EB_SUCCESS","message":"操作成功"} // 业务处理成功，不重试
- {"code":"EB_FAIL","message":"操作失败"} // 业务处理失败，不重试
- 其他未知失败 // 重试
message通知
核销通知
基本信息
核销通知，易百将核销通知分发给渠道或者品牌，对接方需提供接口接收通知。
请求参数
Headers
| 参数名称 | 参数值 | 是否必填 |
| Content-Type | application/json | 是 |
Body
| 参数名称 | 类型 | 必填 | 默认值 | 备注 | 其他信息 |
| channelInfoList | array | 是 | 通知渠道列表 | ||
| |__action | string | 是 | VerifyCodeNotify | 通知action | 最大长度：24 最小长度：1 |
| |__channelAppId | string | 是 | ebuy19915d0498cf | 通知渠道appId | 最大长度：24 最小长度：1 |
| |__channelId | string | 是 | ebuywha102410004 | 通知渠道id | 最大长度：24 最小长度：1 |
| |__channelName | string | 是 | 易百演示 | 通知渠道名称 | 最大长度：16 最小长度：1 |
| |__channelType | string | 是 | saleChannel | 通知渠道类型 | 最大长度：12 最小长度：1 |
| |__messageType | string | 是 | ebuy | 通知消息格式 | 最大长度：12 最小长度：1 |
| |__notifyType | string | 是 | Verify | 通知消息类型 | 最大长度：12 最小长度：1 |
| |__ticketIds | array | 是 | 券批次活动id | ||
| |__transferUrl | string | 否 | 通知渠道三方地址 | 最大长度：255 最小长度：1 |
|
| appId | string | 是 | 核销请求appid | ||
| uuid | string | 是 | 20220509-b485a27c80914357912b029a8a8f5f9b | 核销请求uuid | 最大长度：40 最小长度：1 |
| verifyScene | string | 是 | online | 核销场景 | 最大长度：8 |
| items | array | 是 | |||
| |__brandId | number | 是 | 4339 | 品牌id | |
| |__brandTicketId | string | 是 | 品牌活动产品id | ||
| |__cashierTransNo | string | 是 | 收银机流水号 | ||
| |__code | string | 是 | 核销券码 | ||
| |__outerOrderId | string | 是 | 外部制码订单号 | ||
| |__outerOrderItemId | string | 是 | 外部制码子订单号 | ||
| |__storeInfo | object | 是 | 核销上送门店信息 | ||
| |__cityId | string | 是 | 城市id | ||
| |__cityName | string | 是 | 城市名称 | ||
| |__companyId | string | 是 | 公司id | ||
| |__companyName | string | 是 | 工司名称 | ||
| |__shopName | string | 是 | 门店名称 | ||
| |__shopNo | string | 是 | 门店编号 | ||
| |__terminalId | string | 是 | 核销终端id | ||
| |__ticketId | string | 是 | 券批次id | ||
| |__ticketName | string | 是 | 券批次名称 | ||
| |__userInfo | object | 是 | 制码用户信息 | ||
| |__mobile | string | 是 | 制码上送用户手机号 | ||
| |__thirdUserId | string | 是 | 制码上送用户id | ||
| |__thirdPlatformType | string | 是 | 上送平台类型 | ||
| |__uuid | string | 是 | |||
| |__verifyTime | string | 是 | 核销时间 |
请求示例
{
"channelInfoList": [
{
"notifyType": "Verify",
"whaleChannel": false,
"messageType": "ebuy",
"channelAppId": "402410046",
"serviceProvider": "",
"action": "VerifyCodeNotify",
"channelName": "博时基金",
"channelType": "saleChannel",
"channelVersion": "paas",
"channelId": "ebuywha402410046",
"ticketIds": [
1000030005007
]
}
],
"appId": "ebuy1d0c0a81a9a4",
"verifyScene": "default",
"items": [
{
"userInfo": {
},
"cashierTransNo": "ttCN051001320241103002000",
"code": "10032880473026297020",
"fineGrainedLimit": {
"current": 1,
"limitMaxValue": 1,
"grainedKey": "total"
},
"brandTicketId": "",
"remainUseTimes": 0,
"returnCashParam": "{\"paymentParam\":\"{\\\"discountCode\\\":\\\"bankCoupon\\\"}\",\"identifierMap\":\"\"}",
"printData": "00|兑换产品:CoCo都可20元代金券 X 1|",
"redeemSerialNum": 1,
"verifyTime": 1730600279144,
"uuid": "20241103-b00b98fc29544bae8597098e25c70ff7",
"outerOrderId": "2410071450574725193200",
"verifyId": "d0085990ca8c4225a8189780d129d7b7",
"outerOrderItemId": "2410071450574725193200",
"brandId": "1458",
"fundsChannel": {
"merchantRealAmount": 1500,
"benefitAmount": 0,
"merchantCustomBenefit": -1,
"totalAmount": 2800,
"merchantCustomRealAmount": -1,
"channelBenefit": 0,
"merchantBenefit": 0,
"discountAmount": 2000,
"channelCustomBenefit": -1,
"userRealAmount": 0
},
"totalUseTimes": 1,
"storeInfo": {
"companyId": "171882",
"cityName": "连云港",
"merchantId": "860051827866564",
"companyName": "连云港创高餐饮管理有限公司巨龙南路店",
"shopName": "CoCo都可连云港巨龙南路店",
"cityId": "299",
"terminalId": "27866564",
"shopNo": "CN0510013",
"swift": "0"
},
"requestGoods": [
{
"rebateCode": "000",
"price": 1500,
"qty": 1,
"sku": "CNAFIBCAA",
"type": "A"
},
{
"rebateCode": "000",
"price": 1300,
"qty": 1,
"sku": "CNAABLCAA",
"type": "A"
}
],
"ticketId": "1000030005007",
"ticketName": "易百CoCo20元代金券"
}
],
"uuid": "20241103-b00b98fc29544bae8597098e25c70ff7",
"createDate": 1730600279174
}响应
响应参数
| 参数名称 | 类型 | 必填 | 默认值 | 备注 | 其他信息 |
| code | string | 是 | 响应码 | ||
| message | string | 否 | 响应消息 |
响应示例
{"code":"EB_SUCCESS","message":"操作成功"}注意：
响应码不为EB_SUCCESS 或 EB_FAIL 易百将会进行重试，请保证接口幂等性。
- {"code":"EB_SUCCESS","message":"操作成功"} // 业务处理成功，不重试
- {"code":"EB_FAIL","message":"操作失败"} // 业务处理失败，不重试
- 其他未知失败 // 重试
message通知
核销撤销通知
基本信息
核销撤销通知，易百将核销撤销通知分发给渠道或者品牌，对接方需提供接口接收通知。
请求参数
Headers
| 参数名称 | 参数值 | 是否必填 |
| Content-Type | application/json | 是 |
Body
| 参数名称 | 类型 | 必填 | 默认值 | 备注 | 其他信息 |
| channelInfoList | array | 是 | 通知渠道列表 | ||
| |__action | string | 是 | VerifyCodeNotify | 通知action | 最大长度：24 最小长度：1 |
| |__channelAppId | string | 是 | ebuy19915d0498cf | 通知渠道appId | 最大长度：24 最小长度：1 |
| |__channelId | string | 是 | ebuywha102410004 | 通知渠道id | 最大长度：24 最小长度：1 |
| |__channelName | string | 是 | 易百演示 | 通知渠道名称 | 最大长度：16 最小长度：1 |
| |__channelType | string | 是 | saleChannel | 通知渠道类型 | 最大长度：12 最小长度：1 |
| |__messageType | string | 是 | ebuy | 通知消息格式 | 最大长度：12 最小长度：1 |
| |__notifyType | string | 是 | Verify | 通知消息类型 | 最大长度：12 最小长度：1 |
| |__ticketIds | array | 是 | 券批次活动id | ||
| |__transferUrl | string | 否 | 通知渠道三方地址 | 最大长度：255 最小长度：1 |
|
| appId | string | 否 | 请求appid | ||
| uuid | string | 是 | 20220509-b485a27c80914357912b029a8a8f5f9b | 请求uuid | 最大长度：40 最小长度：1 |
| createDate | number | 否 | 通知时间 | ||
| items | array | 否 | |||
| |__brandTicketId | string | 否 | 品牌活动产品id | ||
| |__code | string | 否 | 券码 | ||
| |__originalRequestId | string | 否 | 券码核销请求uuid | ||
| |__outerOrderId | string | 否 | 外部制码订单号 | ||
| |__outerOrderItemId | string | 否 | 外部制码子订单号 | ||
| |__ticketId | string | 否 | 券批次id | ||
| |__ticketName | string | 否 | 券批次名称 | ||
| |__verifyDate | number | 否 | 核销时间 |
请求示例
{
"uuid": "20240517-ce26ddc2839e49afb004976179b3c299",
"appId": "ebuy1d0c0a81a9a4",
"items": [
{
"code": "1004231231260035262=7sU8TPTD",
"ticketId": "1000000010748",
"verifyId": "36d61fc75def4228bdc1bd4505fd5fcd",
"codeCount": 1,
"ticketName": "星巴克中杯饮品券",
"verifyDate": 1715942792000,
"fundsChannel": "{\"benefitAmount\":0,\"channelBenefit\":0,\"discountAmount\":0.00,\"merchantBenefit\":0,\"merchantCustomBenefit\":-1,\"merchantCustomRealAmount\":-1,\"merchantRealAmount\":0,\"totalAmount\":0,\"userRealAmount\":0}",
"outerOrderId": "20521190871607460888576",
"brandTicketId": "",
"outerOrderItemId": "20521190871607460888576",
"thisCodeQuantity": 1,
"originalRequestId": "36d61fc75def4228bdc1bd4505fd5fcd",
"thirdSendTicketId": "C0002157",
"originalCashierTransNo": "52622405178100030544"
}
],
"createDate": 1715942820438,
"channelInfoList": [
{
"action": "VerifyCodeNotify",
"channelId": "674",
"ticketIds": [
1000000010748
],
"notifyType": "VerifyVoid",
"channelName": "星巴克GC",
"channelType": "brandChannel",
"messageType": "third",
"transferUrl": "https://ups.starbucks.com.cn/notifyOnlineLifecycle/cardCoupon/v1/notify/2009",
"channelAppId": "ebuywha102410114",
"whaleChannel": false
}
]
}响应
响应参数
| 参数名称 | 类型 | 必填 | 默认值 | 备注 | 其他信息 |
| code | string | 是 | 响应码 | ||
| message | string | 否 | 响应消息 |
响应示例
{"code":"EB_SUCCESS","message":"操作成功"}注意：
响应码不为EB_SUCCESS 或 EB_FAIL 易百将会进行重试，请保证接口幂等性。
- {"code":"EB_SUCCESS","message":"操作成功"} // 业务处理成功，不重试
- {"code":"EB_FAIL","message":"操作失败"} // 业务处理失败，不重试
- 其他未知失败 // 重试
message通知
券码状态变更通知
基本信息
券码状态变更通知，易百将券码状态变更通知分发给渠道或者品牌，对接方需提供接口接收通知。
请求参数
Headers
| 参数名称 | 参数值 | 是否必填 |
| Content-Type | application/json | 是 |
Body
| 参数名称 | 类型 | 必填 | 默认值 | 备注 | 其他信息 |
| channelInfoList | array | 是 | 通知渠道列表 | ||
| |__action | string | 是 | VerifyCodeNotify | 通知action | 最大长度：24 最小长度：1 |
| |__channelAppId | string | 是 | ebuy19915d0498cf | 通知渠道appId | 最大长度：24 最小长度：1 |
| |__channelId | string | 是 | ebuywha102410004 | 通知渠道id | 最大长度：24 最小长度：1 |
| |__channelName | string | 是 | 易百演示 | 通知渠道名称 | 最大长度：16 最小长度：1 |
| |__channelType | string | 是 | saleChannel | 通知渠道类型 | 最大长度：12 最小长度：1 |
| |__messageType | string | 是 | ebuy | 通知消息格式 | 最大长度：12 最小长度：1 |
| |__notifyType | string | 是 | Verify | 通知消息类型 | 最大长度：12 最小长度：1 |
| |__ticketIds | array | 是 | 券批次活动id | ||
| |__transferUrl | string | 否 | 通知渠道三方地址 | 最大长度：255 最小长度：1 |
|
| uuid | string | 是 | 20220509-b485a27c80914357912b029a8a8f5f9b | 请求uuid | 最大长度：40 最小长度：1 |
| operationType | string | 否 | |||
| items | array | 否 | |||
| |__code | string | 否 | 券码 | ||
| |__notifyRequestId | string | 否 | 券码核销请求uuid | ||
| |__operationType | string | 否 | 操作类型 | ||
| |__saleChannelId | string | 否 | 销售渠道ID | ||
| |__saleChannelItemId | string | 否 | |||
| |__saleChannelOrderId | string | 否 | 销售渠道订单ID | ||
| |__ticketId | string | 否 | 券批次id | ||
| |__updateDate | string | 否 | |||
| |__updateTime | number | 否 |
请求示例
{
"channelInfoList": [
{
"transferUrl": "https://ups.starbucks.com.cn/notifyOnlineLifecycle/cardCoupon/v1/notify/2009",
"notifyType": "UpdateCodeStatus",
"whaleChannel": false,
"messageType": "third",
"channelAppId": "ebuywha102420017",
"action": "UpdateCodeStatusNotify",
"channelName": "星巴克GC",
"channelType": "brandChannel",
"channelId": "674",
"ticketIds": [
1000030006084
]
},
{
"notifyType": "UpdateCodeStatus",
"whaleChannel": false,
"messageType": "ebuy",
"channelAppId": "102420017",
"serviceProvider": "esb",
"action": "UpdateCodeStatusNotify",
"channelName": "抖音本地生活",
"channelType": "saleChannel",
"channelVersion": "paas",
"channelId": "ebuywha102420017",
"ticketIds": [
1000030006084
]
}
],
"operationType": "invalid",
"items": [
{
"saleChannelOrderId": "20971301257990133272576",
"updateDate": "20241103",
"code": "1004241030700305059=WUhbyTaP",
"notifyRequestId": "UpdateCodeStatusNotify-20241103-4605c6dbef01463baaec87bbc845db47",
"saleChannelId": 130,
"operationType": "invalid",
"updateTime": "20241103195644",
"ecouponTicket": {
"updateDate": 1730184382000,
"saleChannelId": 130,
"saleTenancyName": "星巴克GC",
"codeValidDays": -1,
"hasTest": "1",
"uuid": "20241029-E2DbfA4EBA344eaEC1Bd1D2ededC1FDC",
"ticketValidEnd": 4102415999000,
"tenancyName": "星巴克GC",
"updateBy": "周佳明",
"appId": "ebuy50a485403880",
"commissionDate": 0,
"authorityConfig": {
"createBy": "周佳明"
},
"ticketWhaleId": "677460_1000030006084",
"createDate": 1729670367000,
"ticketBindInfo": {
"ebuyTicketName": "星巴克太妃榛果系列中杯双杯券DY",
"ebuyTicketId": "677460",
"thirdSendTicketId": ""
},
"brandName": "星巴克GC",
"paymentParam": {
"needBarcode": false,
"makeNotify2UserTemplate": "",
"paymentParam": "{}",
"verifyNotify2UserTemplate": "",
"printTemplate": "00|兑换产品:星巴克太妃榛果系列中杯双杯券DY X 1|",
"needReturnBuyGoods": false,
"returnBuyProduct": "N",
"statementCustomer": "易百支付",
"projectProductQuotationId": 9842832,
"verifyNotifyConf": "00",
"onlyAllowOneVerify": "N",
"makeNotifyConf": "00",
"thirdCodeMap": "",
"voidNotifyConf": "00",
"statementPrice": "0",
"smsMakeNotifySrc": "",
"statementCustomerId": "8",
"isOverIncome": "0",
"smsVerifyNotifySrc": ""
},
"codeValidEnd": 1732550399000,
"codeCount": -1,
"productId": 9988,
"brandSalePrice": -1,
"saleTenancyId": 49,
"ticketType": "exchangeCoupon",
"ticketUseDescription": {
"useDescription": "",
"discountDescription": ""
},
"createBy": "周佳明",
"tenancyId": 49,
"codeValidStart": 1729612800000,
"ticketConfig": {
"codeRandomType": "string",
"waringPerson": [
],
"needDynamicCode": false,
"defaultRuleGoodsList": "[]",
"supportNextDayCancel": "N",
"codeRandom": 8,
"codePrefix": "",
"stepPrice": "N",
"needThirdQrcode": false,
"needUploadGov": false,
"logoUrl": "",
"notifyType": "standard",
"needEbuyWallet": "N",
"waringVal": "",
"transparentGoodsDetail": "N",
"merchantCustomRealAmount": "Y",
"needFilterGoodsDetail": "Y",
"needShortLink": false,
"logoType": "1",
"codeSuffix": "=",
"supportSameDayCancel": "Y"
},
"brandId": 674,
"ticketStatus": "0",
"saleChannelInfo": {
"productSource": "",
"saleChannelName": "抖音本地生活",
"activity": "星巴克-易百券系统运维-LX82022000164",
"saleChannelId": 130,
"thirdpartySourceId": "610850"
},
"ticketValidStart": 1729612800000,
"remarks": "COU20241022004-04",
"ticketId": 1000030006084,
"status": "0",
"ticketName": "星巴克太妃榛果系列中杯双杯券DY"
},
"saleChannelItemId": "20971301257990133272576",
"ticketId": 1000030006084
}
],
"uuid": "20241103-4605c6dbef01463baaec87bbc845db47"
}响应
响应参数
| 参数名称 | 类型 | 必填 | 默认值 | 备注 | 其他信息 |
| code | string | 是 | 响应码 | ||
| message | string | 否 | 响应消息 |
响应示例
{"code":"EB_SUCCESS","message":"操作成功"}注意：
响应码不为EB_SUCCESS 或 EB_FAIL 易百将会进行重试，请保证接口幂等性。
- {"code":"EB_SUCCESS","message":"操作成功"} // 业务处理成功，不重试
- {"code":"EB_FAIL","message":"操作失败"} // 业务处理失败，不重试
- 其他未知失败 // 重试
message通知
批量激活通知
基本信息
批量激活通知，易百将批量激活通知分发给渠道或者品牌，对接方需提供接口接收通知。
请求参数
Headers
| 参数名称 | 参数值 | 是否必填 |
| Content-Type | application/json | 是 |
Body
| 参数名称 | 类型 | 必填 | 默认值 | 备注 | 其他信息 |
| channelInfoList | array | 是 | 通知渠道列表 | ||
| |__action | string | 是 | VerifyCodeNotify | 通知action | 最大长度：24 最小长度：1 |
| |__channelAppId | string | 是 | ebuy19915d0498cf | 通知渠道appId | 最大长度：24 最小长度：1 |
| |__channelId | string | 是 | ebuywha102410004 | 通知渠道id | 最大长度：24 最小长度：1 |
| |__channelName | string | 是 | 易百演示 | 通知渠道名称 | 最大长度：16 最小长度：1 |
| |__channelType | string | 是 | saleChannel | 通知渠道类型 | 最大长度：12 最小长度：1 |
| |__messageType | string | 是 | ebuy | 通知消息格式 | 最大长度：12 最小长度：1 |
| |__notifyType | string | 是 | Verify | 通知消息类型 | 最大长度：12 最小长度：1 |
| |__ticketIds | array | 是 | 券批次活动id | ||
| |__transferUrl | string | 否 | 通知渠道三方地址 | 最大长度：255 最小长度：1 |
|
| uuid | string | 是 | 20220509-b485a27c80914357912b029a8a8f5f9b | 请求uuid | 最大长度：40 最小长度：1 |
| operationType | string | 否 | |||
| items | array | 否 | |||
| |__code | string | 否 | 券码 | ||
| |__notifyRequestId | string | 否 | 券码核销请求uuid | ||
| |__operationType | string | 否 | 操作类型 | ||
| |__saleChannelId | string | 否 | 销售渠道ID | ||
| |__saleChannelItemId | string | 否 | 销售渠道子订单ID | ||
| |__saleChannelOrderId | string | 否 | 销售渠道订单ID | ||
| |__ticketId | string | 否 | 券批次id | ||
| |__updateDate | string | 否 | |||
| |__updateTime | number | 否 |
请求示例
{
"channelInfoList": [
{
"action": "UpdateCodeStatusNotify",
"channelId": "671",
"ticketIds": [
1000030002158
],
"notifyType": "UpdateCodeStatus",
"channelName": "歌帝梵",
"channelType": "brandChannel",
"transferUrl": "none",
"channelAppId": "ebuy0197933d568c",
"whaleChannel": false
}
],
"uuid": "20230722-d64fa1b6de634f3580f17e3105612ceb",
"items": [
{
"code": "R23900110032813492114610230",
"ticketId": 1000030002158,
"updateDate": "20230630",
"updateTime": "20230630112126",
"activateInfo": {
"optShopNo": "1007",
"optShopName": "歌帝梵上海五角场万达店"
},
"ecouponTicket": {
"uuid": "20230630-0ce6404162754e2ea686e01c17c11d67",
"appId": "ebuy0197933d568c",
"status": "0",
"brandId": 671,
"hasTest": "1",
"createBy": "歌帝梵",
"ticketId": 1000030002158,
"updateBy": "纪永",
"brandName": "歌帝梵",
"codeCount": -1,
"productId": 4625,
"tenancyId": 28,
"createDate": 1688093861000,
"ticketName": "鎏金明悦礼盒",
"ticketType": "orderVoucher",
"updateDate": 1688106752000,
"tenancyName": "歌帝梵",
"codeValidEnd": 1786291199000,
"paymentParam": {
"needBarcode": false,
"makeNotifyConf": "00",
"voidNotifyConf": "00",
"needReturnBuyGoods": true
},
"ticketConfig": {
"codePrefix": "R239001",
"notifyType": "standard",
"needShortLink": true,
"needUploadGov": false,
"needDynamicCode": false,
"needThirdQrcode": false,
"supportNextDayCancel": "Y",
"needFilterGoodsDetail": "Y",
"checkActivityProductRepeat": false
},
"codeValidDays": -1,
"saleChannelId": 94,
"saleTenancyId": 28,
"ticketWhaleId": "622935_1000030002158",
"codeValidStart": 1691596800000,
"commissionDate": 0,
"ticketBindInfo": {
"ebuyTicketId": "622935"
},
"ticketValidEnd": 1696089599000,
"saleChannelInfo": {
"activity": "鎏金明悦礼盒",
"saleChannelId": 94,
"saleChannelName": "歌帝梵"
},
"saleTenancyName": "歌帝梵",
"ticketValidStart": 1685548800000
},
"operationType": "activate",
"saleChannelId": 94,
"notifyRequestId": "batchActivateCodeNotify-20230722-d64fa1b6de634f3580f17e3105612ceb",
"saleChannelItemId": "o23063011204485539127",
"saleChannelOrderId": "o23063011204483833158"
}
],
"operationType": "activate"
}响应
响应参数
| 参数名称 | 类型 | 必填 | 默认值 | 备注 | 其他信息 |
| code | string | 是 | 响应码 | ||
| message | string | 否 | 响应消息 |
响应示例
{"code":"EB_SUCCESS","message":"操作成功"}注意：
响应码不为EB_SUCCESS 或 EB_FAIL 易百将会进行重试，请保证接口幂等性。
- {"code":"EB_SUCCESS","message":"操作成功"} // 业务处理成功，不重试
- {"code":"EB_FAIL","message":"操作失败"} // 业务处理失败，不重试
- 其他未知失败 // 重试
message通知
批量取消激活通知
基本信息
批量取消激活通知，易百将批量取消激活通知分发给渠道或者品牌，对接方需提供接口接收通知。
请求参数
Headers
| 参数名称 | 参数值 | 是否必填 |
| Content-Type | application/json | 是 |
Body
| 参数名称 | 类型 | 必填 | 默认值 | 备注 | 其他信息 |
| channelInfoList | array | 是 | 通知渠道列表 | ||
| |__action | string | 是 | VerifyCodeNotify | 通知action | 最大长度：24 最小长度：1 |
| |__channelAppId | string | 是 | ebuy19915d0498cf | 通知渠道appId | 最大长度：24 最小长度：1 |
| |__channelId | string | 是 | ebuywha102410004 | 通知渠道id | 最大长度：24 最小长度：1 |
| |__channelName | string | 是 | 易百演示 | 通知渠道名称 | 最大长度：16 最小长度：1 |
| |__channelType | string | 是 | saleChannel | 通知渠道类型 | 最大长度：12 最小长度：1 |
| |__messageType | string | 是 | ebuy | 通知消息格式 | 最大长度：12 最小长度：1 |
| |__notifyType | string | 是 | Verify | 通知消息类型 | 最大长度：12 最小长度：1 |
| |__ticketIds | array | 是 | 券批次活动id | ||
| |__transferUrl | string | 否 | 通知渠道三方地址 | 最大长度：255 最小长度：1 |
|
| uuid | string | 是 | 20220509-b485a27c80914357912b029a8a8f5f9b | 请求uuid | 最大长度：40 最小长度：1 |
| operationType | string | 否 | |||
| items | array | 否 | |||
| |__code | string | 否 | 券码 | ||
| |__notifyRequestId | string | 否 | 券码核销请求uuid | ||
| |__operationType | string | 否 | 操作类型 | ||
| |__saleChannelId | string | 否 | 销售渠道ID | ||
| |__saleChannelItemId | string | 否 | 销售渠道子订单ID | ||
| |__saleChannelOrderId | string | 否 | 销售渠道订单ID | ||
| |__ticketId | string | 否 | 券批次id | ||
| |__updateDate | string | 否 | |||
| |__updateTime | number | 否 |
请求示例
{
"channelInfoList": [
{
"action": "UpdateCodeStatusNotify",
"channelId": "671",
"ticketIds": [
1000030002160
],
"notifyType": "UpdateCodeStatus",
"channelName": "歌帝梵",
"channelType": "brandChannel",
"transferUrl": "none",
"channelAppId": "ebuy0197933d568c",
"whaleChannel": false
}
],
"uuid": "20230724-95e72fb721dc4d42891ff9bf951a0d61",
"items": [
{
"code": "R23900310032813490810348736",
"ticketId": 1000030002160,
"updateDate": "20230724",
"updateTime": "20230724202516",
"ecouponTicket": {
"uuid": "20230630-64908b2c33344cb3b0750e92abd93486",
"appId": "ebuy0197933d568c",
"status": "0",
"brandId": 671,
"hasTest": "1",
"createBy": "歌帝梵",
"ticketId": 1000030002160,
"updateBy": "纪永",
"brandName": "歌帝梵",
"codeCount": -1,
"productId": 4627,
"tenancyId": 28,
"createDate": 1688093997000,
"ticketName": "奢金非梵礼盒",
"ticketType": "orderVoucher",
"updateDate": 1688106698000,
"tenancyName": "歌帝梵",
"codeValidEnd": 1786291199000,
"paymentParam": {
"needBarcode": false,
"makeNotifyConf": "00",
"voidNotifyConf": "00",
"needReturnBuyGoods": true
},
"ticketConfig": {
"codePrefix": "R239003",
"notifyType": "standard",
"needShortLink": true,
"needUploadGov": false,
"needDynamicCode": false,
"needThirdQrcode": false,
"supportNextDayCancel": "Y",
"needFilterGoodsDetail": "Y",
"checkActivityProductRepeat": false
},
"codeValidDays": -1,
"saleChannelId": 94,
"saleTenancyId": 28,
"ticketWhaleId": "622945_1000030002160",
"codeValidStart": 1689955200000,
"commissionDate": 0,
"ticketBindInfo": {
"ebuyTicketId": "622945"
},
"ticketValidEnd": 1696089599000,
"saleChannelInfo": {
"activity": "奢金团员礼盒",
"saleChannelId": 94,
"saleChannelName": "歌帝梵"
},
"saleTenancyName": "歌帝梵",
"ticketValidStart": 1685548800000
},
"operationType": "unActivate",
"saleChannelId": 94,
"notifyRequestId": "batchUnActivateCodeNotify-20230724-95e72fb721dc4d42891ff9bf951a0d61",
"saleChannelItemId": "o23063011081480119088",
"saleChannelOrderId": "o23063011081476782265"
}
],
"operationType": "unActivate"
}响应
响应参数
| 参数名称 | 类型 | 必填 | 默认值 | 备注 | 其他信息 |
| code | string | 是 | 响应码 | ||
| message | string | 否 | 响应消息 |
响应示例
{"code":"EB_SUCCESS","message":"操作成功"}注意：
响应码不为EB_SUCCESS 或 EB_FAIL 易百将会进行重试，请保证接口幂等性。
- {"code":"EB_SUCCESS","message":"操作成功"} // 业务处理成功，不重试
- {"code":"EB_FAIL","message":"操作失败"} // 业务处理失败，不重试
- 其他未知失败 // 重试
业务参数对象
业务参数对象
通知渠道信息
通知渠道信息
| 字段 | 类型 | 是否必填 | 字段意义 | 备注 |
| action | string |
必须
|
VerifyCodeNotify
|
通知action |
| channelAppId | string |
必须
|
ebuy19915d0498cf
|
通知渠道appId |
| channelId | string |
必须
|
ebuywha102410004
|
通知渠道id |
| channelName | string |
必须
|
易百演示
|
通知渠道名称 |
| channelType | string |
必须
|
saleChannel
|
通知渠道类型 |
| messageType | string |
必须
|
ebuy
|
通知消息格式 |
| notifyType | string |
必须
|
Verify
|
通知消息类型 |
| ticketIds | string [] |
必须
|
券批次活动id | |
| transferUrl | string |
非必须
|
通知渠道三方地址 |