请求参数说明
参数 | 描述 | 必填 | 示例值 | 类型 | 最大长度 |
action | 接口参数组 | 是 | object | ||
└action | 需要调用的接口名称 | 是 | co_check | string | |
get | GET参数组,本组参数需要参与签名 | 是 | object | ||
└no | 券号(no与coid二选一即可) | 否 | 281898619298 | number | |
└getlist | getlist=1返回用户所有券、 getlist=2合并colist模式 | 否 | 1 | number | |
└merge | 必须和getlist一起调用。merge=1,(券类型最多返回500并且券分组展示) | 否 | 1 | number | |
└coid | 券id(no与coid二选一即可) | 否 | 81417132 | number | |
└coPage | 优惠券分页查询( 不传则默认为1:单页固定500条) | 否 | 1 | number |
请求示例
{ "action": { "action": "co_check" }, "get": { "no": "281898619298", "coid": "81417132", "getlist": "1", "coPage": "1", "merge": "1" } }
响应参数说明
参数 | 描述 | 必填 | 示例值 | 类型 | 最大长度 |
status | 返回状态。接口成功时为1,出错为0 | 是 | 1 | number | |
info | 错误时会返回相应的错误信息 | 是 | ok | string | |
store | 券可用门店 | 否 | 果盘测试 | string | |
name | 优惠券名称 | 否 | 西瓜--单品券1 | string | |
coid | 券id | 否 | 26689861 | number | |
cono | 券号 | 否 | 281898619298 | number | |
vdate | 有效期 | 否 | 20190710~20190731 | string | |
cash | 金额(非0为金额券,0为实物券) | 否 | 0.00 | number | |
time | 券领用时间 | 否 | 2019-07-10 12:42:56 | string | |
price | 券金额(仅在券为团购券是有效。可用于线下处理券相应的实收和折扣部分逻辑) | 否 | 0.00 | number | |
requireamt | 满XX元可用,用于控制券的使用金额 | 否 | 0 | number | |
deid | 否 | 27694 | number | ||
subject | 备注 | 否 | 限量第5 | string | |
mbid | 平台id | 否 | 6740019 | number | |
accid | 会员卡id | 否 | 3812805 | number | |
type | 否 | 1 | number | ||
choose | 抵扣方式(单品券抵扣方式 0=按固定金额 1=按菜品金额比例) | 否 | 1 | number | |
chooseval | 抵扣比例或者金额 | 否 | 100 | number | |
entitylist | 菜品信息 | 否 | list | ||
└dgid | 菜品id | 否 | 4917938 | number | |
└name | 菜品名称 | 否 | 张飞酱牛肉 | string | |
└refid | 菜品外部编码 | 否 | 71008 | number | |
colist | 否 | list | |||
└store | 券可用门店 | 否 | 果盘测试 | string | |
└name | 券名称 | 否 | 西瓜--单品券1 | string | |
└coid | 券id | 否 | 26689866 | number | |
└cono | 券号 | 否 | 28*******723 | string | |
└vdate | 券有效期 | 否 | 20190710~20190731 | string | |
└cash | 金额(非0为金额券,0为实物券) | 否 | 0.00 | number | |
└time | 券领用时间 | 否 | 2019-07-10 12:43:01 | string | |
└price | 券金额(仅在券为团购券是有效。可用于线下处理券相应的实收和折扣部分逻辑) | 否 | 0.00 | number | |
└requireamt | 满XX元可用,用于控制券的使用金额 | 否 | 0 | number | |
└deid | 券类型id | 否 | 27694 | number | |
└info | 券说明 | 是 | 1111111111 | number | |
└subject | 摘要 | 否 | 限量第8 | string | |
└accid | 会员卡id | 否 | 3812805 | number | |
└type | 1:单品券 0:现金券 | 否 | 1 | number | |
└choose | 抵扣方式( 单品券抵扣方式 0=按固定金额 1=按菜品金额比例) | 否 | 1 | number | |
└chooseval | 抵扣比例或者金额 | 否 | 100 | number | |
└entitylist | 菜品信息 | 否 | list | ||
└└dgid | 菜品id | 否 | 4917938 | number | |
└└name | 券名称 | 否 | 张飞酱牛肉 | string | |
└└refid | 菜品外部编码 | 否 | 71008 | number | |
msid | 门店编号 | 否 | 6786 | number | |
tp | 使用类型:堂吃、外卖 、通用 | 否 | 通用 | string |
响应示例
{ "status": "1", "info": "ok", "store": "果盘测试", "name": "西瓜--单品券1", "coid": "26689861", "cono": "281898619298", "vdate": "20190710~20190731", "cash": "0.00", "time": "2019-07-10 12:42:56", "price": "0.00", "requireamt": "0", "deid": "27694", "subject": " 限量第5", "accid": "3812805", "mbid": "5759774", "type": "1", "choose": "1", "tp": "通用", "chooseval": "100", "entitylist": [ { "dgid": "4917938", "name": "张飞酱牛肉", "refid": "71008" } ], "colist": [ { "store": "果盘测试", "name": "西瓜--单品券1", "coid": "26689866", "cono": "28*******723", "vdate": "20190710~20190731", "cash": "0.00", "time": "2019-07-10 12:43:01", "price": "0.00", "requireamt": "0", "deid": "27694", "info": "1111111111", "subject": " 限量第8", "accid": "3812805", "type": "1", "choose": "1", "chooseval": "100", "entitylist": [ { "dgid": "4917938", "name": "张飞酱牛肉", "refid": "71008" } ] } ], "server_timestamp": 1562733881, "server_time": "2019-07-10 12:44:41", "server_name": "wx-task2.hz", "msid": "6786" }
未增加merge=1时返回
{
"status": "1",}
当getlist=2时
{
"status": "1",
"info": "ok",
"mbid": "5759774",
"accid": "9867588",
"colist": [
{
"store": "全部",
"name": "10元券",
"coid": "186300150261",
"cono": "18***********992",
"vdate": "20240604~20240604",
"cash": "10.00",
"time": "2024-06-04 17:46:21",
"price": "0.00",
"requireamt": "0",
"deid": "105061",
"info": "",
"subject": "",
"accid": "9867588",
"type": "0",
"tp": "通用",
"userScene": "全部"
},
{
"store": "全部",
"name": "10元券",
"coid": "186300150262",
"cono": "18***********830",
"vdate": "20240604~20240604",
"cash": "10.00",
"time": "2024-06-04 17:46:22",
"price": "0.00",
"requireamt": "0",
"deid": "105061",
"info": "",
"subject": "",
"accid": "9867588",
"type": "0",
"tp": "通用",
"userScene": "全部"
}
],
"server_timestamp": 1717494393,
"server_time": "2024-06-04 17:46:33",
"server_name": "nx-202.hz",
"duration": "340ms",
"env": "online",
"request_time": "17:46:32.743",
"msid": "20243"
}