聚合核券

更新时间：2025-05-23 16:56:18

更新说明 时间 操作人
新增api接口 2022/9/21 林道银
新增外部券字段以及对象 2022/11/23 黄章鑫
升级聚合核券接口 2024/6/24 王志然

一、API接口

测试环境：http://test.lcsw.cn:8403/

生产环境：https://open-mkt.lcsw.cn/

核销接口

  • URL：coupon/open/use
  • Method：POST
  • ContentType: application/json

请求参数

参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号，新版本300
trace_no String 32 Y 请求流水号，不带“-”的uuid,商户侧需保证唯一性
merchant_no String 15 Y 扫呗商户号
terminal_id String 8 Y 终端号
coupon_no String ∞ Y 券码
channel_type String 3 Y 券通道类型：如
LC：利楚
DY：抖音
MT：美团
ALI：支付宝团购
MTDZ：美团到店综合
KS: 快手
order_amt String 11 N 订单金额（优惠前的金额，单位分）
count String 11 N 核销数量
key_sign String 32 Y 签名检验串,非空参数字典排序+令牌（终端令牌名称为access_token），32位md5加密转换

返回参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 响应码 01:成功 02:失败。响应码仅代表通信状态，不代表业务结果
return_msg String 128 Y 返回信息提示
key_sign String 32 Y 签名检验串,非空参数字典排序+令牌（终端令牌名称为access_token），32位md5加密转换
result_code String 2 N 业务结果 01:成功 02:失败
trace_no String 32 Y 原请求流水号
merchant_no String 15 Y 扫呗商户号
terminal_id String 8 Y 终端号
verify_warn_msg String 32 N 核销预警信息，result_code为01时若有值，表示用户用券次数达到了设置的优惠示警值
channel_type String 3 Y 券通道类型：如
LC：利楚
DY：抖音
MT：美团
ALI：支付宝团购
MTDZ：美团到店综合
tail_amount String - N 尾款金额，等于订单总金额减去券抵扣金额
coupon_no String - N 传入的券码，返回的是集合
coupon_use_no String - N 返回核销的券码 返回的是集合
verify_results String Y 核销券结果

verify_result

参数名称 类型 长度 必填 说明
result String 32 Y 验券结果码 0表示成功 非0表示失败
msg String 128 Y 验券结果说明
code String 15 Y 代表验券传入的code或encrypted_code
origin_code String 15 Y 代表抖音团购券的12位原始券码(抖音加密券码核销时)
channel_coupon_info JSONObject 2048 Y 渠道券详情
origin_channel_coupon_info JSONObject 2048 Y 渠道券详情(原始)

券核销撤销

  • URL：coupon/open/canceluse
  • Method：POST
  • ContentType: application/json

请求参数

参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号，新版本300
trace_no String 32 Y 请求流水号，不带“-”的uuid,商户侧需保证唯一性
merchant_no String 15 Y 扫呗商户号
terminal_id String 8 Y 终端号
coupon_no String ∞ O 券码(与merchant_trade_no字段二选一)
channel_type String 3 Y 券通道类型：如
LC：利楚
DY：抖音
MT：美团
ALI：支付宝团购
MTDZ：美团到店综合
KS: 快手
key_sign String 32 Y 签名检验串,非空参数字典排序+令牌（终端令牌名称为access_token），32位md5加密转换

返回参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 响应码 01:成功 02:失败。响应码仅代表通信状态，不代表业务结果
return_msg String 128 Y 返回信息提示
result_code String 2 N 业务结果 01:成功 02:失败
trace_no String 32 Y 原请求流水号
merchant_no String 15 Y 扫呗商户号
terminal_id String 8 Y 终端号
key_sign String 32 Y 签名检验串,非空参数字典排序+令牌（终端令牌名称为access_token），32位md5加密转换
channel_type String 3 Y 券通道类型：如
LC：利楚
DY：抖音
MT：美团
ALI：支付宝团购
MTDZ：美团到店综合

查询券列表接口

  • URL：coupon/open/querycoupon
  • Method：POST
  • ContentType: application/json

请求参数

参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号，新版本300
channel_type String 3 Y 券通道类型：如
LC：利楚
DY：抖音
MT：美团
ALI：支付宝团购
MTDZ：美团到店综合
KS: 快手
merchant_no String 15 Y 商户号
terminal_id String 8 Y 终端号（系统机具编号）
coupon_no String ∞ Y 券码
trace_no String 32 Y 请求流水号
key_sign String 32 Y 签名串

返回参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 响应码 01:成功 02:失败。响应码仅代表通信状态，不代表业务结果
return_msg String 128 Y 返回信息提示
key_sign String 32 Y 签名检验串,非空参数字典排序+令牌（终端令牌名称为access_token），32位md5加密转换
result_code String 2 N 业务结果 01:成功 02:失败
trace_no String 32 Y 原请求流水号
merchant_no String 15 Y 扫呗商户号
terminal_id String 8 Y 终端号
coupon_infos String -- N 券信息,JSON字符串,需要转义, result_code为01时返回,
详情见下面：coupon_infos格式
coupon_infos:示例格式{}
参数名称 类型 长度 必填 说明
success String 2 Y 成功标志
message String 128 Y 返回信息提示
code String 32 Y 返回代码
data String -- N 详情见下面：data格式
data**:示例格式{}**
参数名称 类型 长度 必填 说明
channel_type String 3 Y 券通道类型：如
LC：利楚
DY：抖音
MT：美团
ALI：支付宝团购
MTDZ：美团到店综合
KS: 快手
coupon_no String 32 Y 券码
coupon_name String 9 Y 优惠券名称
apply_scope String 1 N 适用范围 0：全场 1：单品
coupon_type String 1 Y 券类型 0:满减券 1:折扣券 2:兑换券 3:停车券 4:团购券 5:优惠券 6:现金券。4、5只在channel_type为MALLCOO时存在
activity_no String 32 N 所属活动编号
stock_no String 32 N 所属券批次编号
get_time String 19 Y 领取时间 yyyy-MM-dd HH:mm:ss
use_status String 1 Y 状态 1.可用 2.已失效 3.已核销 4.已过期
out_trade_no String 32 N 核销关联订单号，use_status为3时返回
use_time String 19 N 核销时间 use_status为3时返回
discount_rule Object -- Y 优惠规则
use_rule Object O 券使用规则 (只有利楚券返回)
channel_coupon_info JSONObject N 外部券信息 如抖音券时有值
encrypted_code String Y 加密券码

优惠规则discount_rule字段如下
参数名称 类型 长度 必填 说明
discount_threshold String 11 Y 消费门槛（分)，0代表没门槛
discount_amt String 8 N 优惠金额（分）。coupon_type为0时必传
rebate String 3 N 折扣，1~100的整数（eg：70表示七折）。coupon_type为1时必传
discount_top String 8 Y 单笔优惠封顶金额，0代表不封顶
park_special_tag String 1 N 停车券特殊优惠标记 0.普通优惠 1.特殊优惠 coupon_type为3时必传
deduction_amt String 11 N 抵用金额(分) coupon_type为3时选传
deduction_time String 11 N 抵消时常(分钟) coupon_type为3时选传

券使用规则use_rule字段如下
参数名称 类型 长度 必填 说明
use_time_type String 1 Y 券可用时间类型 0:用户领券后N天内可用 1:固定可用时间段 2:规则日期可用
limit_days String 4 N 用户领券多少天内有效。use_time_type为0时必传
wait_days String 4 N 领取后N天开始生效,最大值90。use_time_type为0时非必传
use_start_time String 19 N 固定可用时间段开始时间 yyyy-MM-dd HH:mm:ss。use_time_type为1时必传
use_end_time String 19 N 固定可用时间段结束时间 yyyy-MM-dd HH:mm:ss。use_time_type为1时必传
days_period String 13 N 规则日期可用星期，1代表周日，2代表周一，以此类推，多个,分隔。示例值：1,2。use_time_type为2时传，为空代表没有可用时间
time_period String 11 N 规则日期可用时间段，格式：HH:mm-HH:mm。use_time_type为2时选传，days_period不为空时和days_period搭配使用，为空代表不限制。days_period为空该字段无意义。
use_note String 144 Y 使用需知

channel_coupon_info字段如下

抖音券：
参数名称 类型 长度 必填 说明
encrypted_code String N 加密券码
code String N 券码(未核销时不返回、已核销可撤销时不返回)
status Integer N 券的状态， 0表示初始状态，1 表示未使用，2表示已使用，3表示退款申请中（待审核），4表示退款成功，5表示退款失败，6表示退款中
expire_time String N 券码有效期 截至时间 时间戳 单位秒
original_amount Integer N 券原始金额 单位分
pay_amount Integer N 用户实付金额 单位分
merchant_ticket_amount Integer N 商家营销金额 单位分
payment_discount_amount Integer N 支付优惠金额 单位分
coupon_pay_amount Integer N 券实付金额(=用户实付金额+支付优惠金额，不包括平台优惠金额) 单位分
title String N 团购名称
groupon_type Integer N 团购类型(type=1团购券;type=2代金券)
market_price Integer N 团购市场价 单位分
list_market_amount Integer N 划线价，单位分
origin_list_market_amount Long N 原币种划线价
original_currency String N 原币种
platform_discount_amount Integer N 平台优惠金额， 单位分
third_sku_id String N 商家系统（第三方）商品id

查询门店商品信息

  • URL：coupon/open/queryproduct
  • Method：POST
  • ContentType: application/json

请求参数

参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号，新版本300
trace_no String 32 Y 请求流水号，不带“-”的uuid,商户侧需保证唯一性
merchant_no String 15 Y 扫呗商户号
terminal_id String 8 Y 终端号
channel_type String 5 Y 券通道类型：
DY：抖音
MTDZ：美团到店综合
KS: 快手
page_size String 10 Y 分页大小
page_num String 10 Y 页码
key_sign String 32 Y 签名检验串,非空参数字典排序+令牌（终端令牌名称为access_token），32位md5加密转换

返回参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 响应码 01:成功 02:失败。响应码仅代表通信状态，不代表业务结果
return_msg String 128 Y 返回信息提示
key_sign String 32 Y 签名检验串,非空参数字典排序+令牌（终端令牌名称为access_token），32位md5加密转换
result_code String 2 N 业务结果 01:成功 02:失败
trace_no String 32 Y 原请求流水号
merchant_no String 15 Y 扫呗商户号
terminal_id String 8 Y 终端号
channel_type String 3 Y 券通道类型：
DY：抖音
MTDZ：美团到店综合
KS: 快手
products String 1024 Y 商品列表，item是渠道原始数据

查询团购信息

  • URL：coupon/open/queryDeal
  • Method: POST
  • ContentType: application/json

请求参数

参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号，新版本300
trace_no String 32 Y 请求流水号，不带“-”的uuid,商户侧需保证唯一性
merchant_no String 15 Y 扫呗商户号
terminal_id String 8 Y 终端号
channel_type String 5 Y 券通道类型：
MTDZ：美团到店综合
page_size String 10 Y 分页大小
page_num String 10 Y 页码
source String 10 O 售卖平台。1-大众点评，2-美团。默认为1
key_sign String 32 Y 签名检验串,非空参数字典排序+令牌（终端令牌名称为access_token），32位md5加密转换

返回参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 响应码 01:成功 02:失败。响应码仅代表通信状态，不代表业务结果
return_msg String 128 Y 返回信息提示
key_sign String 32 Y 签名检验串,非空参数字典排序+令牌（终端令牌名称为access_token），32位md5加密转换
result_code String 2 N 业务结果 01:成功 02:失败
trace_no String 32 Y 原请求流水号
merchant_no String 15 Y 扫呗商户号
terminal_id String 8 Y 终端号
channel_type String 5 Y 券通道类型：
MTDZ：美团到店综合
deals String 1024 Y 套餐列表，item是渠道原始数据

© 利楚商服 2020 All rights reserved.