核销撤销通知

基本信息

接口名称：	核销撤销通知	状态：	已完成
接口路径：	POST /paas/micro/ecoupon/verifyVoidNotify	更新时间：	2022-05-10 03:00:19
Mock地址：	https://apimock.e-buychina.com/mock/617/paas/micro/ecoupon/verifyVoidNotify

请求参数

Headers:

参数名称	参数值	是否必填
Content-Type	application/json	是

Body:

参数名称	类型	必填	默认值	备注	其他信息
action	string	是		交易类型
appId	string	是		请求appid
content	object	是		返回报文
channelInfoList	array	否		通知渠道列表
action	string	是		通知action
channelAppId	string	是		通知渠道appId
channelId	string	是		通知渠道id
channelName	string	是		通知渠道名称
channelType	string	是		通知渠道类型
messageType	string	是		通知消息格式
notifyType	string	是		通知消息类型
ticketIds	array	是		券批次活动id
transferUrl	string	否		通知渠道三方地址
notifyParam	object	否		通知报文
appId	string	否		请求appid
createDate	number	否		通知时间
items	array	否
brandTicketId	string	否		品牌id
code	string	否		券码
originalRequestId	string	否		券码核销请求uuid
outerOrderId	string	否		外部制码订单号
outerOrderItemId	string	否		外部制码子订单号
ticketId	string	否		券批次id
ticketName	string	否		券批次名称
verifyDate	number	否		核销时间	Mock：@timestamp
uuid	string	否		请求uuid
lang	string	否
timestamp	number	是		返回时间戳	Mock：@timestamp
uuid	string	是		请求uuid

返回数据

参数名称

类型

必填

默认值

备注

其他信息

备注

变更历史

变更日期	变更内容
2022-05-09	{"path":"\/verifyVoidNotify","params":[]} {"path":"\/verifyVoidNotify","params":[]} [{"required":"1","name":"Content-Type","value":"application\/json"}] [{"required":"1","name":"Content-Type","value":"application\/json"}] {"req_body_type":"json"}{"req_body_type":"json"} {"res_body_type":"json"}{"res_body_type":"json"} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"number","description":"交易成功与否","mock":{"mock":"@now(\'yyyyMMddHHmmss\')-@string(\'lower\',32)"}},"appId":{"type":"string","description":"请求AppId","mock":{"mock":"@natural"}},"success":{"type":"boolean","description":"交易成功与否"},"action":{"type":"string","default":"","minLength":1,"maxLength":50,"description":"交易类型","mock":{"mock":"makeEcoupon"}},"timestamp":{"type":"number","description":"返回时间戳","mock":{"mock":"@timestamp"},"minimum":1,"exclusiveMinimum":true,"maximum":800,"exclusiveMaximum":true},"errorCode":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误码","mock":{"mock":"@word"}},"errorMessage":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误描述","mock":{"mock":"@csentence"}},"signType":{"type":"string","default":"","minLength":0,"maxLength":20,"description":"签名类型","mock":{"mock":"sha256"}},"sign":{"type":"string","default":"","minLength":0,"maxLength":500,"description":"签名值","mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"requestId":{"type":"string","default":"","minLength":1,"pattern":"","maxLength":64,"description":"核销请求流水号"},"originalRequestId":{"type":"string","minLength":1,"maxLength":80},"code":{"type":"number","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"description":"串码号"},"saleChannelId":{"type":"string","description":"取码方id","maxLength":80,"minLength":1},"outerOrderId":{"type":"string","description":"制码订单号","maxLength":80,"minLength":1},"outerOrderItemId":{"type":"string","description":"制码子订单号","maxLength":80,"minLength":1},"verifyDate":{"type":"string","description":"核销时间","maxLength":80,"minLength":1},"ticketId":{"type":"string","description":"批次号","maxLength":80,"minLength":1},"ticketName":{"type":"string","description":"批次名称","maxLength":80,"minLength":1},"brandId":{"type":"string","description":"品牌id","maxLength":80,"minLength":1},"thirdSendTicketId":{"type":"string","description":"第三方制码批次号","maxLength":80,"minLength":1},"brandTicketId":{"type":"string","description":"品牌方批次号","maxLength":80,"minLength":1},"originalCashierTransNo":{"type":"string","description":"原交易收银机流水号","maxLength":80,"minLength":1},"orderRemark":{"type":"string","description":"订单备注信息","maxLength":80,"minLength":1},"userInfo":{"type":"object","properties":{"mobile":{"type":"string","description":"手机号","minLength":1,"maxLength":80},"thirdPlatformType":{"type":"string","description":"第三方平台类型","minLength":1,"maxLength":80},"thirdUserId":{"type":"string","description":"第三方用户id","minLength":1,"maxLength":80}},"mock":{"mock":"@string"}}},"required":["requestId","code","brandId","ticketName","verifyDate","outerOrderItemId","outerOrderId","saleChannelId","originalRequestId","ticketId"],"description":"返回报文"}},"required":["action","timestamp","uuid","errorCode","errorMessage","content","success","appId"],"description":"ROOT"} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"action":{"type":"string","description":"交易类型"},"appId":{"type":"string","description":"请求appid"},"content":{"type":"object","properties":{"channelInfoList":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","description":"通知action"},"channelAppId":{"type":"string","description":"通知渠道appId"},"channelId":{"type":"string","description":"通知渠道id"},"channelName":{"type":"string","description":"通知渠道名称"},"channelType":{"type":"string","description":"通知渠道类型"},"messageType":{"type":"string","description":"通知消息格式"},"notifyType":{"type":"string","description":"通知消息类型"},"ticketIds":{"type":"array","items":{"type":"number"},"description":"券批次活动id"},"transferUrl":{"type":"string","description":"通知渠道三方地址"}},"required":["action","channelId","channelType","channelAppId","channelName","messageType","notifyType","ticketIds"]},"description":"通知渠道列表"},"notifyParam":{"type":"object","properties":{"appId":{"type":"string","description":"请求appid"},"createDate":{"type":"number","description":"通知时间"},"items":{"type":"array","items":{"type":"object","properties":{"brandTicketId":{"type":"string","description":"品牌id"},"code":{"type":"string","description":"券码"},"originalRequestId":{"type":"string","description":"券码核销请求uuid"},"outerOrderId":{"type":"string","description":"外部制码订单号"},"outerOrderItemId":{"type":"string","description":"外部制码子订单号"},"ticketId":{"type":"string","description":"券批次id"},"ticketName":{"type":"string","description":"券批次名称"},"verifyDate":{"type":"number","description":"核销时间","mock":{"mock":"@timestamp"}}}}},"uuid":{"type":"string","description":"请求uuid"}},"description":"通知报文"}},"description":"返回报文"},"lang":{"type":"string"},"timestamp":{"type":"number","description":"返回时间戳","mock":{"mock":"@timestamp"}},"uuid":{"type":"string","description":"请求uuid"}},"required":["action","appId","content","timestamp","uuid"]} {"type":"object","title":"empty object","properties":{}} {"type":"object","title":"empty object","properties":{}}
2021-10-15	{"path":"\/verifyVoidNotify","params":[]} {"path":"\/verifyVoidNotify","params":[]} [{"required":"1","name":"Content-Type","value":"application\/json"}] [{"required":"1","name":"Content-Type","value":"application\/json"}] {"req_body_type":"json"}{"req_body_type":"json"} {"res_body_type":"json"}{"res_body_type":"json"} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"number","description":"交易成功与否","mock":{"mock":"@now(\'yyyyMMddHHmmss\')-@string(\'lower\',32)"}},"appId":{"type":"string","description":"请求AppId","mock":{"mock":"@natural"}},"success":{"type":"boolean","description":"交易成功与否"},"action":{"type":"string","default":"","minLength":1,"maxLength":50,"description":"交易类型","mock":{"mock":"makeEcoupon"}},"timestamp":{"type":"number","description":"返回时间戳","mock":{"mock":"@timestamp"}},"errorCode":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误码","mock":{"mock":"@word"}},"errorMessage":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误描述","mock":{"mock":"@csentence"}},"signType":{"type":"string","default":"","minLength":0,"maxLength":20,"description":"签名类型","mock":{"mock":"sha256"}},"sign":{"type":"string","default":"","minLength":0,"maxLength":500,"description":"签名值","mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"requestId":{"type":"string","default":"","minLength":1,"pattern":"","maxLength":64,"description":"核销请求流水号"},"originalRequestId":{"type":"string"},"code":{"type":"number","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"description":"串码号"},"saleChannelId":{"type":"string","description":"取码方id"},"outerOrderId":{"type":"string","description":"制码订单号"},"outerOrderItemId":{"type":"string","description":"制码子订单号"},"verifyDate":{"type":"string","description":"核销时间"},"ticketId":{"type":"string","description":"批次号"},"ticketName":{"type":"string","description":"批次名称"},"brandId":{"type":"string","description":"品牌id"},"thirdSendTicketId":{"type":"string","description":"第三方制码批次号"},"brandTicketId":{"type":"string","description":"品牌方批次号"},"originalCashierTransNo":{"type":"string","description":"原交易收银机流水号"},"orderRemark":{"type":"string","description":"订单备注信息"},"userInfo":{"type":"object","properties":{"mobile":{"type":"string","description":"手机号"},"thirdPlatformType":{"type":"string","description":"第三方平台类型"},"thirdUserId":{"type":"string","description":"第三方用户id"}},"mock":{"mock":"@string"}}},"required":["requestId","code","brandId","ticketName","verifyDate","outerOrderItemId","outerOrderId","saleChannelId","originalRequestId","ticketId"],"description":"返回报文"}},"required":["action","timestamp","uuid","errorCode","errorMessage","content","success","appId"],"description":"ROOT"} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"number","description":"交易成功与否","mock":{"mock":"@now(\'yyyyMMddHHmmss\')-@string(\'lower\',32)"}},"appId":{"type":"string","description":"请求AppId","mock":{"mock":"@natural"}},"success":{"type":"boolean","description":"交易成功与否"},"action":{"type":"string","default":"","minLength":1,"maxLength":50,"description":"交易类型","mock":{"mock":"makeEcoupon"}},"timestamp":{"type":"number","description":"返回时间戳","mock":{"mock":"@timestamp"},"minimum":1,"exclusiveMinimum":true,"maximum":800,"exclusiveMaximum":true},"errorCode":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误码","mock":{"mock":"@word"}},"errorMessage":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误描述","mock":{"mock":"@csentence"}},"signType":{"type":"string","default":"","minLength":0,"maxLength":20,"description":"签名类型","mock":{"mock":"sha256"}},"sign":{"type":"string","default":"","minLength":0,"maxLength":500,"description":"签名值","mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"requestId":{"type":"string","default":"","minLength":1,"pattern":"","maxLength":64,"description":"核销请求流水号"},"originalRequestId":{"type":"string","minLength":1,"maxLength":80},"code":{"type":"number","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"description":"串码号"},"saleChannelId":{"type":"string","description":"取码方id","maxLength":80,"minLength":1},"outerOrderId":{"type":"string","description":"制码订单号","maxLength":80,"minLength":1},"outerOrderItemId":{"type":"string","description":"制码子订单号","maxLength":80,"minLength":1},"verifyDate":{"type":"string","description":"核销时间","maxLength":80,"minLength":1},"ticketId":{"type":"string","description":"批次号","maxLength":80,"minLength":1},"ticketName":{"type":"string","description":"批次名称","maxLength":80,"minLength":1},"brandId":{"type":"string","description":"品牌id","maxLength":80,"minLength":1},"thirdSendTicketId":{"type":"string","description":"第三方制码批次号","maxLength":80,"minLength":1},"brandTicketId":{"type":"string","description":"品牌方批次号","maxLength":80,"minLength":1},"originalCashierTransNo":{"type":"string","description":"原交易收银机流水号","maxLength":80,"minLength":1},"orderRemark":{"type":"string","description":"订单备注信息","maxLength":80,"minLength":1},"userInfo":{"type":"object","properties":{"mobile":{"type":"string","description":"手机号","minLength":1,"maxLength":80},"thirdPlatformType":{"type":"string","description":"第三方平台类型","minLength":1,"maxLength":80},"thirdUserId":{"type":"string","description":"第三方用户id","minLength":1,"maxLength":80}},"mock":{"mock":"@string"}}},"required":["requestId","code","brandId","ticketName","verifyDate","outerOrderItemId","outerOrderId","saleChannelId","originalRequestId","ticketId"],"description":"返回报文"}},"required":["action","timestamp","uuid","errorCode","errorMessage","content","success","appId"],"description":"ROOT"} {} {"type":"object","title":"empty object","properties":{}}
2021-08-26	{"path":"\/verifyVoidNotify","params":[]} {"path":"\/verifyVoidNotify","params":[]} [{"required":"1","name":"Content-Type","value":"application\/json"}] [{"required":"1","name":"Content-Type","value":"application\/json"}] {"req_body_type":"raw"}{"req_body_type":"json"} {"res_body_type":"json"}{"res_body_type":"json"} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"number","description":"交易成功与否","mock":{"mock":"@now(\'yyyyMMddHHmmss\')-@string(\'lower\',32)"}},"appId":{"type":"string","description":"请求AppId","mock":{"mock":"@natural"}},"success":{"type":"boolean","description":"交易成功与否"},"action":{"type":"string","default":"","minLength":1,"maxLength":50,"description":"交易类型","mock":{"mock":"makeEcoupon"}},"timestamp":{"type":"number","description":"返回时间戳","mock":{"mock":"@timestamp"}},"errorCode":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误码","mock":{"mock":"@word"}},"errorMessage":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误描述","mock":{"mock":"@csentence"}},"signType":{"type":"string","default":"","minLength":0,"maxLength":20,"description":"签名类型","mock":{"mock":"sha256"}},"sign":{"type":"string","default":"","minLength":0,"maxLength":500,"description":"签名值","mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"verifyRequestId":{"type":"string","default":"","minLength":1,"pattern":"","maxLength":64,"description":"核销请求流水号"},"code":{"type":"number","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"description":"串码号"},"saleChannelId":{"type":"string","description":"取码方id"},"outerOrderId":{"type":"string","description":"制码订单号"},"outerOrderItemId":{"type":"string","description":"制码子订单号"},"verifyCount":{"type":"string","description":"核销次数"},"verifyType":{"type":"string","description":"核销类型"},"shopName":{"type":"string","description":"门店号"},"manageCompany":{"type":"string","description":"管理公司id"},"ticketName":{"type":"string","description":"批次名称"},"brandId":{"type":"string","description":"品牌id"},"thirdSendTicketId":{"type":"string","description":"第三方制码批次号"},"brandTicketId":{"type":"string","description":"品牌方批次号"},"field_68":{"type":"string","description":"收音机流水号"},"field_67":{"type":"string","description":"订单备注信息"},"userInfo":{"type":"object","properties":{"mobile":{"type":"string","description":"手机号"},"thirdPlatformType":{"type":"string","description":"第三方平台类型"},"thirdUserId":{"type":"string","description":"第三方用户id"}},"mock":{"mock":"@string"}}},"required":["verifyRequestId","code","brandId","ticketName","verifyType","verifyCount","outerOrderItemId","outerOrderId","saleChannelId"],"description":"返回报文"}},"required":["action","timestamp","uuid","errorCode","errorMessage","content","success","appId"],"description":"ROOT"} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"number","description":"交易成功与否","mock":{"mock":"@now(\'yyyyMMddHHmmss\')-@string(\'lower\',32)"}},"appId":{"type":"string","description":"请求AppId","mock":{"mock":"@natural"}},"success":{"type":"boolean","description":"交易成功与否"},"action":{"type":"string","default":"","minLength":1,"maxLength":50,"description":"交易类型","mock":{"mock":"makeEcoupon"}},"timestamp":{"type":"number","description":"返回时间戳","mock":{"mock":"@timestamp"}},"errorCode":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误码","mock":{"mock":"@word"}},"errorMessage":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误描述","mock":{"mock":"@csentence"}},"signType":{"type":"string","default":"","minLength":0,"maxLength":20,"description":"签名类型","mock":{"mock":"sha256"}},"sign":{"type":"string","default":"","minLength":0,"maxLength":500,"description":"签名值","mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"requestId":{"type":"string","default":"","minLength":1,"pattern":"","maxLength":64,"description":"核销请求流水号"},"originalRequestId":{"type":"string"},"code":{"type":"number","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"description":"串码号"},"saleChannelId":{"type":"string","description":"取码方id"},"outerOrderId":{"type":"string","description":"制码订单号"},"outerOrderItemId":{"type":"string","description":"制码子订单号"},"verifyDate":{"type":"string","description":"核销时间"},"ticketId":{"type":"string","description":"批次号"},"ticketName":{"type":"string","description":"批次名称"},"brandId":{"type":"string","description":"品牌id"},"thirdSendTicketId":{"type":"string","description":"第三方制码批次号"},"brandTicketId":{"type":"string","description":"品牌方批次号"},"originalCashierTransNo":{"type":"string","description":"原交易收银机流水号"},"orderRemark":{"type":"string","description":"订单备注信息"},"userInfo":{"type":"object","properties":{"mobile":{"type":"string","description":"手机号"},"thirdPlatformType":{"type":"string","description":"第三方平台类型"},"thirdUserId":{"type":"string","description":"第三方用户id"}},"mock":{"mock":"@string"}}},"required":["requestId","code","brandId","ticketName","verifyDate","outerOrderItemId","outerOrderId","saleChannelId","originalRequestId","ticketId"],"description":"返回报文"}},"required":["action","timestamp","uuid","errorCode","errorMessage","content","success","appId"],"description":"ROOT"} {} {}
2021-08-26	{"path":"\/verifyVoidNotify","params":[]} {"path":"\/verifyVoidNotify","params":[]} [{"required":"1","name":"Content-Type","value":"application\/json"}] [{"required":"1","name":"Content-Type","value":"application\/json"}] {"req_body_type":"json"}{"req_body_type":"raw"} {"res_body_type":"json"}{"res_body_type":"json"} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"number","description":"交易成功与否","mock":{"mock":"@now(\'yyyyMMddHHmmss\')-@string(\'lower\',32)"}},"appId":{"type":"string","description":"请求AppId","mock":{"mock":"@natural"}},"success":{"type":"boolean","description":"交易成功与否"},"action":{"type":"string","default":"","minLength":1,"maxLength":50,"description":"交易类型","mock":{"mock":"makeEcoupon"}},"timestamp":{"type":"number","description":"返回时间戳","mock":{"mock":"@timestamp"}},"errorCode":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误码","mock":{"mock":"@word"}},"errorMessage":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误描述","mock":{"mock":"@csentence"}},"signType":{"type":"string","default":"","minLength":0,"maxLength":20,"description":"签名类型","mock":{"mock":"sha256"}},"sign":{"type":"string","default":"","minLength":0,"maxLength":500,"description":"签名值","mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"outerOrderId":{"type":"string","default":"","minLength":1,"pattern":"","mock":{"mock":"@string"},"description":"制码订单号","maxLength":64},"codeQuantity":{"type":"number","mock":{"mock":"@natural"},"description":"制码总数量","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true},"items":{"type":"array","items":{"type":"object","properties":{"outerOrderItemId":{"type":"string","mock":{"mock":"@string"},"description":"制码子订单号","minLength":10,"maxLength":64},"ticketId":{"type":"number","description":"批次号"},"ticketName":{"type":"string","mock":{"mock":"@string"},"description":"批次名称","minLength":1,"maxLength":100},"brandTicketId":{"type":"string","mock":{"mock":"@string"},"description":"品牌方批次号","minLength":1,"maxLength":100},"thirdSendTicketId":{"type":"string","mock":{"mock":"@string"},"description":"第三制码方批次号","minLength":1,"maxLength":100},"validStart":{"type":"string","mock":{"mock":"@now(\'yyyyMMddHHmmss\')-@string(\'lower\',32)"},"minLength":14,"maxLength":14,"description":"码有效期开始时间"},"valieEnd":{"type":"string","mock":{"mock":"@now(\'yyyyMMddHHmmss\')-@string(\'lower\',32)"},"minLength":14,"maxLength":14,"description":"码有效期结束时间"},"ticketUseDescription":{"type":"object","properties":{"ticketPicture":{"type":"string","description":"券图片链接","minLength":11,"maxLength":100},"useThreshold":{"type":"number","description":"优惠门槛","minimum":1,"exclusiveMinimum":true,"maximum":20,"exclusiveMaximum":true},"discountDescription":{"type":"string","description":"优惠说明","minLength":1,"maxLength":50},"useDescription":{"type":"string","description":"使用说明","minLength":1,"maxLength":50},"useRule":{"type":"string","description":"使用规则","minLength":1,"maxLength":50}},"description":"券使用说明"},"codeDetail":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","mock":{"mock":"@string"},"description":"串码号","minLength":1,"maxLength":64},"password":{"type":"string","mock":{"mock":"@string"},"description":"认证密码","minLength":1,"maxLength":64},"codeH5Url":{"type":"string","mock":{"mock":"@string"},"description":"活动页面连接","minLength":1,"maxLength":64},"codePicUrl":{"type":"string","mock":{"mock":"@string"},"description":"二维码图片连接","minLength":1,"maxLength":64},"useTimes":{"type":"integer","mock":{"mock":"@natural"},"description":"串码可使用次数","minimum":0,"exclusiveMinimum":true,"maximum":99999,"exclusiveMaximum":true},"status":{"type":"string","mock":{"mock":"@string"},"description":"串码状态","minLength":2,"maxLength":2},"statusDesc":{"type":"string","mock":{"mock":"@string"},"description":"状态描述","minLength":1,"maxLength":10}},"required":["code","statusDesc","status","useTimes"]},"description":"串码详情"}},"required":["outerOrderItemId","ticketId","ticketName","codeDetail","brandTicketId","thirdSendTicketId"]}}},"required":["outerOrderId","items","codeQuantity"],"description":"返回报文"}},"required":["action","timestamp","uuid","errorCode","errorMessage","content","success","appId"],"description":"ROOT"} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"number","description":"交易成功与否","mock":{"mock":"@now(\'yyyyMMddHHmmss\')-@string(\'lower\',32)"}},"appId":{"type":"string","description":"请求AppId","mock":{"mock":"@natural"}},"success":{"type":"boolean","description":"交易成功与否"},"action":{"type":"string","default":"","minLength":1,"maxLength":50,"description":"交易类型","mock":{"mock":"makeEcoupon"}},"timestamp":{"type":"number","description":"返回时间戳","mock":{"mock":"@timestamp"}},"errorCode":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误码","mock":{"mock":"@word"}},"errorMessage":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误描述","mock":{"mock":"@csentence"}},"signType":{"type":"string","default":"","minLength":0,"maxLength":20,"description":"签名类型","mock":{"mock":"sha256"}},"sign":{"type":"string","default":"","minLength":0,"maxLength":500,"description":"签名值","mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"verifyRequestId":{"type":"string","default":"","minLength":1,"pattern":"","maxLength":64,"description":"核销请求流水号"},"code":{"type":"number","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true,"description":"串码号"},"saleChannelId":{"type":"string","description":"取码方id"},"outerOrderId":{"type":"string","description":"制码订单号"},"outerOrderItemId":{"type":"string","description":"制码子订单号"},"verifyCount":{"type":"string","description":"核销次数"},"verifyType":{"type":"string","description":"核销类型"},"shopName":{"type":"string","description":"门店号"},"manageCompany":{"type":"string","description":"管理公司id"},"ticketName":{"type":"string","description":"批次名称"},"brandId":{"type":"string","description":"品牌id"},"thirdSendTicketId":{"type":"string","description":"第三方制码批次号"},"brandTicketId":{"type":"string","description":"品牌方批次号"},"field_68":{"type":"string","description":"收音机流水号"},"field_67":{"type":"string","description":"订单备注信息"},"userInfo":{"type":"object","properties":{"mobile":{"type":"string","description":"手机号"},"thirdPlatformType":{"type":"string","description":"第三方平台类型"},"thirdUserId":{"type":"string","description":"第三方用户id"}},"mock":{"mock":"@string"}}},"required":["verifyRequestId","code","brandId","ticketName","verifyType","verifyCount","outerOrderItemId","outerOrderId","saleChannelId"],"description":"返回报文"}},"required":["action","timestamp","uuid","errorCode","errorMessage","content","success","appId"],"description":"ROOT"} {} {}
2021-08-26	{"path":"\/verifyVoidNotify","params":[]} {"path":"\/verifyVoidNotify","params":[]} [] [{"required":"1","name":"Content-Type","value":"application\/json"}] {"req_body_type":"raw"}{"req_body_type":"json"} {"res_body_type":"json"}{"res_body_type":"json"} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"number","description":"交易成功与否","mock":{"mock":"@now(\'yyyyMMddHHmmss\')-@string(\'lower\',32)"}},"appId":{"type":"string","description":"请求AppId","mock":{"mock":"@natural"}},"success":{"type":"boolean","description":"交易成功与否"},"action":{"type":"string","default":"","minLength":1,"maxLength":50,"description":"交易类型","mock":{"mock":"makeEcoupon"}},"timestamp":{"type":"number","description":"返回时间戳","mock":{"mock":"@timestamp"}},"errorCode":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误码","mock":{"mock":"@word"}},"errorMessage":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误描述","mock":{"mock":"@csentence"}},"signType":{"type":"string","default":"","minLength":0,"maxLength":20,"description":"签名类型","mock":{"mock":"sha256"}},"sign":{"type":"string","default":"","minLength":0,"maxLength":500,"description":"签名值","mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"outerOrderId":{"type":"string","default":"","minLength":1,"pattern":"","mock":{"mock":"@string"},"description":"制码订单号","maxLength":64},"codeQuantity":{"type":"number","mock":{"mock":"@natural"},"description":"制码总数量","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true},"items":{"type":"array","items":{"type":"object","properties":{"outerOrderItemId":{"type":"string","mock":{"mock":"@string"},"description":"制码子订单号","minLength":10,"maxLength":64},"ticketId":{"type":"number","description":"批次号"},"ticketName":{"type":"string","mock":{"mock":"@string"},"description":"批次名称","minLength":1,"maxLength":100},"brandTicketId":{"type":"string","mock":{"mock":"@string"},"description":"品牌方批次号","minLength":1,"maxLength":100},"thirdSendTicketId":{"type":"string","mock":{"mock":"@string"},"description":"第三制码方批次号","minLength":1,"maxLength":100},"validStart":{"type":"string","mock":{"mock":"@now(\'yyyyMMddHHmmss\')-@string(\'lower\',32)"},"minLength":14,"maxLength":14,"description":"码有效期开始时间"},"valieEnd":{"type":"string","mock":{"mock":"@now(\'yyyyMMddHHmmss\')-@string(\'lower\',32)"},"minLength":14,"maxLength":14,"description":"码有效期结束时间"},"ticketUseDescription":{"type":"object","properties":{"ticketPicture":{"type":"string","description":"券图片链接","minLength":11,"maxLength":100},"useThreshold":{"type":"number","description":"优惠门槛","minimum":1,"exclusiveMinimum":true,"maximum":20,"exclusiveMaximum":true},"discountDescription":{"type":"string","description":"优惠说明","minLength":1,"maxLength":50},"useDescription":{"type":"string","description":"使用说明","minLength":1,"maxLength":50},"useRule":{"type":"string","description":"使用规则","minLength":1,"maxLength":50}},"description":"券使用说明"},"codeDetail":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","mock":{"mock":"@string"},"description":"串码号","minLength":1,"maxLength":64},"password":{"type":"string","mock":{"mock":"@string"},"description":"认证密码","minLength":1,"maxLength":64},"codeH5Url":{"type":"string","mock":{"mock":"@string"},"description":"活动页面连接","minLength":1,"maxLength":64},"codePicUrl":{"type":"string","mock":{"mock":"@string"},"description":"二维码图片连接","minLength":1,"maxLength":64},"useTimes":{"type":"integer","mock":{"mock":"@natural"},"description":"串码可使用次数","minimum":0,"exclusiveMinimum":true,"maximum":99999,"exclusiveMaximum":true},"status":{"type":"string","mock":{"mock":"@string"},"description":"串码状态","minLength":2,"maxLength":2},"statusDesc":{"type":"string","mock":{"mock":"@string"},"description":"状态描述","minLength":1,"maxLength":10}},"required":["code","statusDesc","status","useTimes"]},"description":"串码详情"}},"required":["outerOrderItemId","ticketId","ticketName","codeDetail","brandTicketId","thirdSendTicketId"]}}},"required":["outerOrderId","items","codeQuantity"],"description":"返回报文"}},"required":["action","timestamp","uuid","errorCode","errorMessage","content","success","appId"],"description":"ROOT"} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"number","description":"交易成功与否","mock":{"mock":"@now(\'yyyyMMddHHmmss\')-@string(\'lower\',32)"}},"appId":{"type":"string","description":"请求AppId","mock":{"mock":"@natural"}},"success":{"type":"boolean","description":"交易成功与否"},"action":{"type":"string","default":"","minLength":1,"maxLength":50,"description":"交易类型","mock":{"mock":"makeEcoupon"}},"timestamp":{"type":"number","description":"返回时间戳","mock":{"mock":"@timestamp"}},"errorCode":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误码","mock":{"mock":"@word"}},"errorMessage":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误描述","mock":{"mock":"@csentence"}},"signType":{"type":"string","default":"","minLength":0,"maxLength":20,"description":"签名类型","mock":{"mock":"sha256"}},"sign":{"type":"string","default":"","minLength":0,"maxLength":500,"description":"签名值","mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"outerOrderId":{"type":"string","default":"","minLength":1,"pattern":"","mock":{"mock":"@string"},"description":"制码订单号","maxLength":64},"codeQuantity":{"type":"number","mock":{"mock":"@natural"},"description":"制码总数量","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true},"items":{"type":"array","items":{"type":"object","properties":{"outerOrderItemId":{"type":"string","mock":{"mock":"@string"},"description":"制码子订单号","minLength":10,"maxLength":64},"ticketId":{"type":"number","description":"批次号"},"ticketName":{"type":"string","mock":{"mock":"@string"},"description":"批次名称","minLength":1,"maxLength":100},"brandTicketId":{"type":"string","mock":{"mock":"@string"},"description":"品牌方批次号","minLength":1,"maxLength":100},"thirdSendTicketId":{"type":"string","mock":{"mock":"@string"},"description":"第三制码方批次号","minLength":1,"maxLength":100},"validStart":{"type":"string","mock":{"mock":"@now(\'yyyyMMddHHmmss\')-@string(\'lower\',32)"},"minLength":14,"maxLength":14,"description":"码有效期开始时间"},"valieEnd":{"type":"string","mock":{"mock":"@now(\'yyyyMMddHHmmss\')-@string(\'lower\',32)"},"minLength":14,"maxLength":14,"description":"码有效期结束时间"},"ticketUseDescription":{"type":"object","properties":{"ticketPicture":{"type":"string","description":"券图片链接","minLength":11,"maxLength":100},"useThreshold":{"type":"number","description":"优惠门槛","minimum":1,"exclusiveMinimum":true,"maximum":20,"exclusiveMaximum":true},"discountDescription":{"type":"string","description":"优惠说明","minLength":1,"maxLength":50},"useDescription":{"type":"string","description":"使用说明","minLength":1,"maxLength":50},"useRule":{"type":"string","description":"使用规则","minLength":1,"maxLength":50}},"description":"券使用说明"},"codeDetail":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","mock":{"mock":"@string"},"description":"串码号","minLength":1,"maxLength":64},"password":{"type":"string","mock":{"mock":"@string"},"description":"认证密码","minLength":1,"maxLength":64},"codeH5Url":{"type":"string","mock":{"mock":"@string"},"description":"活动页面连接","minLength":1,"maxLength":64},"codePicUrl":{"type":"string","mock":{"mock":"@string"},"description":"二维码图片连接","minLength":1,"maxLength":64},"useTimes":{"type":"integer","mock":{"mock":"@natural"},"description":"串码可使用次数","minimum":0,"exclusiveMinimum":true,"maximum":99999,"exclusiveMaximum":true},"status":{"type":"string","mock":{"mock":"@string"},"description":"串码状态","minLength":2,"maxLength":2},"statusDesc":{"type":"string","mock":{"mock":"@string"},"description":"状态描述","minLength":1,"maxLength":10}},"required":["code","statusDesc","status","useTimes"]},"description":"串码详情"}},"required":["outerOrderItemId","ticketId","ticketName","codeDetail","brandTicketId","thirdSendTicketId"]}}},"required":["outerOrderId","items","codeQuantity"],"description":"返回报文"}},"required":["action","timestamp","uuid","errorCode","errorMessage","content","success","appId"],"description":"ROOT"} {} {}
2021-08-26	{"path":"\/verifyCancelNotify","params":[]} {"path":"\/verifyVoidNotify","params":[]} [] [] {}{"req_body_type":"raw"} {"res_body_type":"json"}{"res_body_type":"json"} {} {"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"number","description":"交易成功与否","mock":{"mock":"@now(\'yyyyMMddHHmmss\')-@string(\'lower\',32)"}},"appId":{"type":"string","description":"请求AppId","mock":{"mock":"@natural"}},"success":{"type":"boolean","description":"交易成功与否"},"action":{"type":"string","default":"","minLength":1,"maxLength":50,"description":"交易类型","mock":{"mock":"makeEcoupon"}},"timestamp":{"type":"number","description":"返回时间戳","mock":{"mock":"@timestamp"}},"errorCode":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误码","mock":{"mock":"@word"}},"errorMessage":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误描述","mock":{"mock":"@csentence"}},"signType":{"type":"string","default":"","minLength":0,"maxLength":20,"description":"签名类型","mock":{"mock":"sha256"}},"sign":{"type":"string","default":"","minLength":0,"maxLength":500,"description":"签名值","mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"outerOrderId":{"type":"string","default":"","minLength":1,"pattern":"","mock":{"mock":"@string"},"description":"制码订单号","maxLength":64},"codeQuantity":{"type":"number","mock":{"mock":"@natural"},"description":"制码总数量","minimum":1,"exclusiveMinimum":true,"maximum":50,"exclusiveMaximum":true},"items":{"type":"array","items":{"type":"object","properties":{"outerOrderItemId":{"type":"string","mock":{"mock":"@string"},"description":"制码子订单号","minLength":10,"maxLength":64},"ticketId":{"type":"number","description":"批次号"},"ticketName":{"type":"string","mock":{"mock":"@string"},"description":"批次名称","minLength":1,"maxLength":100},"brandTicketId":{"type":"string","mock":{"mock":"@string"},"description":"品牌方批次号","minLength":1,"maxLength":100},"thirdSendTicketId":{"type":"string","mock":{"mock":"@string"},"description":"第三制码方批次号","minLength":1,"maxLength":100},"validStart":{"type":"string","mock":{"mock":"@now(\'yyyyMMddHHmmss\')-@string(\'lower\',32)"},"minLength":14,"maxLength":14,"description":"码有效期开始时间"},"valieEnd":{"type":"string","mock":{"mock":"@now(\'yyyyMMddHHmmss\')-@string(\'lower\',32)"},"minLength":14,"maxLength":14,"description":"码有效期结束时间"},"ticketUseDescription":{"type":"object","properties":{"ticketPicture":{"type":"string","description":"券图片链接","minLength":11,"maxLength":100},"useThreshold":{"type":"number","description":"优惠门槛","minimum":1,"exclusiveMinimum":true,"maximum":20,"exclusiveMaximum":true},"discountDescription":{"type":"string","description":"优惠说明","minLength":1,"maxLength":50},"useDescription":{"type":"string","description":"使用说明","minLength":1,"maxLength":50},"useRule":{"type":"string","description":"使用规则","minLength":1,"maxLength":50}},"description":"券使用说明"},"codeDetail":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","mock":{"mock":"@string"},"description":"串码号","minLength":1,"maxLength":64},"password":{"type":"string","mock":{"mock":"@string"},"description":"认证密码","minLength":1,"maxLength":64},"codeH5Url":{"type":"string","mock":{"mock":"@string"},"description":"活动页面连接","minLength":1,"maxLength":64},"codePicUrl":{"type":"string","mock":{"mock":"@string"},"description":"二维码图片连接","minLength":1,"maxLength":64},"useTimes":{"type":"integer","mock":{"mock":"@natural"},"description":"串码可使用次数","minimum":0,"exclusiveMinimum":true,"maximum":99999,"exclusiveMaximum":true},"status":{"type":"string","mock":{"mock":"@string"},"description":"串码状态","minLength":2,"maxLength":2},"statusDesc":{"type":"string","mock":{"mock":"@string"},"description":"状态描述","minLength":1,"maxLength":10}},"required":["code","statusDesc","status","useTimes"]},"description":"串码详情"}},"required":["outerOrderItemId","ticketId","ticketName","codeDetail","brandTicketId","thirdSendTicketId"]}}},"required":["outerOrderId","items","codeQuantity"],"description":"返回报文"}},"required":["action","timestamp","uuid","errorCode","errorMessage","content","success","appId"],"description":"ROOT"} {} {}

api-id=32902

文档修订记录

接入事项

签名相关

相关名词解释

对接demo

单码制码

异步批量制码

制码撤销

串码状态更新

串码明细更新

批量同步激活券码

批量同步取消激活券码

批量同步券码状态更新

单码串码激活

电子券核销查询接口

查询码明细

查询码状态

制码查询

查询券批次相关信息

查询批次库存

电子券核销接口

电子券核销撤销接口

三方单码核销通知

三方单码核销撤销通知

三方码批量核销通知接口

三方码批量核销撤销通知接口

制码通知

制码撤销通知

更新码状态通知

核销通知

核销撤销通知

批量异步制码通知

批次变更通知

批量激活通知下发报文

批量取消激活通知下发报文

创建券产品

prod同步stg数据

变更券产品

券产品详情查询

创建批次

批次编辑

批次详情查询

创建销售渠道

编辑销售渠道

查询销售渠道

批次变更通知接口

销售批次列表查询

创建产品预取任务

查询预取任务结果

查询预取产品库存

API响应码汇总

核销通知

核销撤销通知

外部订单周期区间查询

外部订单明细查询

单码接口

批量发码

券码查询

券码作废

制码查询

制码通知

核销通知

核销撤销通知

券码状态变更通知

批量激活通知

批量取消激活通知

通知渠道信息

核销撤销通知

基本信息

请求参数

Headers:

Body:

返回数据

备注

变更历史

No Comments