# message通知
ebuyweb-message消费易百券系统v4.1标准通知,并将通知分发到外部。
易百券系统v4.1标准通知参见:通知 | e-Buy Docs
# 制码通知
## 基本信息
制码通知,易百将制码通知分发给渠道或者品牌,对接方需提供接口接收通知。
## 请求参数
### 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](https://book.e-buy.com/books/e-buy-41/page/a516a)
### 请求示例
```json
{
"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 | 否 |
| 响应消息 |
|
### 响应示例
```json
{"code":"EB_SUCCESS","message":"操作成功"}
```
注意:
响应码不为EB\_SUCCESS 或 EB\_FAIL 易百将会进行重试,请保证接口幂等性。
- {"code":"EB\_SUCCESS","message":"操作成功"} // 业务处理成功,不重试
- {"code":"EB\_FAIL","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 | 是 |
| 核销时间 |
|
### 请求示例
```json
{
"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 | 否 |
| 响应消息 |
|
### 响应示例
```json
{"code":"EB_SUCCESS","message":"操作成功"}
```
注意:
响应码不为EB\_SUCCESS 或 EB\_FAIL 易百将会进行重试,请保证接口幂等性。
- {"code":"EB\_SUCCESS","message":"操作成功"} // 业务处理成功,不重试
- {"code":"EB\_FAIL","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 | 否 |
| 核销时间 |
|
### 请求示例
```json
{
"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 | 否 |
| 响应消息 |
|
### 响应示例
```json
{"code":"EB_SUCCESS","message":"操作成功"}
```
注意:
响应码不为EB\_SUCCESS 或 EB\_FAIL 易百将会进行重试,请保证接口幂等性。
- {"code":"EB\_SUCCESS","message":"操作成功"} // 业务处理成功,不重试
- {"code":"EB\_FAIL","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 | 否 |
|
|
|
### 请求示例
```json
{
"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 | 否 |
| 响应消息 |
|
### 响应示例
```json
{"code":"EB_SUCCESS","message":"操作成功"}
```
注意:
响应码不为EB\_SUCCESS 或 EB\_FAIL 易百将会进行重试,请保证接口幂等性。
- {"code":"EB\_SUCCESS","message":"操作成功"} // 业务处理成功,不重试
- {"code":"EB\_FAIL","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 | 否 |
|
|
|
### 请求示例
```json
{
"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 | 否 |
| 响应消息 |
|
### 响应示例
```json
{"code":"EB_SUCCESS","message":"操作成功"}
```
注意:
响应码不为EB\_SUCCESS 或 EB\_FAIL 易百将会进行重试,请保证接口幂等性。
- {"code":"EB\_SUCCESS","message":"操作成功"} // 业务处理成功,不重试
- {"code":"EB\_FAIL","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 | 否 |
|
|
|
### 请求示例
```json
{
"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 | 否 |
| 响应消息 |
|
### 响应示例
```json
{"code":"EB_SUCCESS","message":"操作成功"}
```
注意:
响应码不为EB\_SUCCESS 或 EB\_FAIL 易百将会进行重试,请保证接口幂等性。
- {"code":"EB\_SUCCESS","message":"操作成功"} // 业务处理成功,不重试
- {"code":"EB\_FAIL","message":"操作失败"} // 业务处理失败,不重试
- 其他未知失败 // 重试