制码通知

基本信息

制码通知，易百将制码通知分发给渠道或者品牌，对接方需提供接口接收通知。

请求参数

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":"操作失败"}  // 业务处理失败，不重试
  
• 其他未知失败   // 重试