制码通知
基本信息
核销制码通知,易百将核销制码通知分发给渠道或者品牌,对接方需提供接口接收通知。
请求参数
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 | ||
最大长度:8 | |||||
items | array | 是 | |||
| |
|||||
| |
string | ||||
| |
|||||
|__codeCount | number | 否 | |||
|__codeDetails | array | 否 | |||
|__code | string | ||||
| |
string | ||||
| |
string | ||||
| |
|||||
| |
string | ||||
| |
string | ||||
| |
string | ||||
| |
|||||
|__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 | ||||
| |
string | ||||
|__outerOrderId | string | 否 | |||
|__saleAppId | string | 否 | |||
|__saleChannelId | string | 否 |
参数请参考(原始参数均来自券系统4.1):制码通知 | e-Buy Docs
请求示例
{
"outerOrderId": "20591242205212698112000",
"userInfo": {
},
"channelInfoList": [
{
"transferUrl": "https://ups.starbucks.com.cn/***",
"notifyType": "Verify"MakeCode",
"whaleChannel": false,
"messageType": "ebuy"third",
"channelAppId": "402410046",
"serviceProvider": ""ebuywha102410120",
"action": "VerifyCodeNotify"MakeCodeNotify",
"channelName": "博时基金"星巴克GC",
"channelType": "saleChannel",
"channelVersion": "paas"brandChannel",
"channelId": "ebuywha402410046"674",
"ticketIds": [
10000300050071000000010882
]
}
],
"codeCount": 1,
"saleChannelId": 138,
"appId": "ebuy1d0c0a81a9a4"ebuywha102410120",
"verifyScene"saleAppId": "default"ebuywha102410120",
"orderRemark": "{\"trackingNo\":\"COU20210825001\"}",
"items": [
{
"userInfo"codeCount": 1,
"productId": 5249,
"brandSalePrice": -1,
"validStart": -62170185600000,
"activityName": "【星巴克GC】 星巴克电子券平台运维-2021第13期",
"returnMessage": "SUCCESS",
"thirdSendTicketId": "C0002204",
"productName": "大杯饮品电子券\t",
"ticketUseDescription": {
"useThreshold": "3400"
},
"cashierTransNo"activityId": "ttCN051001320241103002000"503152",
"code"returnCode": "10032880473026297020"00",
"fineGrainedLimit": {
"current": 1,
"limitMaxValue": 1,
"grainedKey"ecouponType": "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"exchangeCoupon",
"outerOrderItemId": "2410071450574725193200"20591242205212698112000",
"brandId": "1458",
"fundsChannel": {
"merchantRealAmount": 1500,
"benefitAmount": 0,
"merchantCustomBenefit"validEnd": -1,62170185600000,
"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"codeDetails": [
{
"rebateCode"code": "000"1004240520320002019=JN3kEB19",
"price": 1500,
"qty": 1,
"sku"statusDesc": "CNAFIBCAA"未激活",
"type"codeH5Url": "A"
}https://w.ebuy.io/lk/dtnGGoWZGf",
{
"rebateCode"codeMask": "000"100***EB19",
"price": 1300,
"qty": 1,
"sku"searchCode": "CNAABLCAA"1004240520320002019",
"type"status": "A"03",
"useTimes": 1
}
],
"ticketId": 1000000010882,
"1000030005007"ticketWhaleId": "519423_1000000010882",
"ticketName": "易百CoCo20元代金大杯饮品电子券"\t"
}
],
"uuid": "20241103-b00b98fc29544bae8597098e25c70ff7"20240520-78293a474547477f97f3f074ebbf8ba8",
"createDate": 17306002791741716206401876
}
响应
响应参数
参数名称 | 类型 | 必填 | 默认值 | 备注 | 其他信息 |
code | string | 是 | 响应码 | ||
message | string | 否 | 响应消息 |
响应示例
{"code":"EB_SUCCESS","message":"操作成功"}
注意:
响应码不为EB_SUCCESS 或 EB_FAIL 易百将会进行重试,请保证接口幂等性。
- {"code":"EB_SUCCESS","message":"操作成功"} // 业务处理成功,不重试
- {"code":"EB_FAIL","message":"操作失败"} // 业务处理失败,不重试
- 其他未知失败 // 重试