参数名称 | 类型 | 是否必填 | 参数描述 | 备注 |
---|---|---|---|---|
api_key | String | 是 | 系统分配的ApiKey | |
api_target | String | 是 | 调用接口名称 | com_cmall_familyhas_api_ApiGetAvailableCoupon |
api_token | String | 是 | 用户授权码 | 已登陆用户授权码,64位16进制编码。 |
api_input | String | 是 | 输入参数 | 应用输入参数的JSON格式 |
参数名称 | 类型 | 必填 | 示例 | 参数描述 | 备注 |
---|---|---|---|---|---|
shouldPay | BigDecimal | 是 | 应付金额 | 应付金额大于限制金额时才可以使用优惠劵 | |
channelId | String | 否 | 123456 | 渠道编号 | 惠家有app:449747430001,wap商城:449747430002,微信商城:449747430003,PC:449747430004 |
paymentType | String | 否 | 449716200001 | 支付类型 | 在线支付:449716200001,货到付款:449716200002 |
goods | GoodsInfoForAdd[] | 否 | 商品列表 | 仅用于扩展 | |
isPurchase | Integer | 否 | 是否显示内购 | 默认值为0,显示内购活动传递1 | |
skuCodeEntitylist | GoodsInfoForAdd[] | 否 | 商品列表 | 仅用于扩展(兼容android3.7.4参数) | |
version | int | 否 | 版本号 | 仅用于扩展,无需传入 |
参数名称 | 类型 | 参数描述 | 备注 |
---|---|---|---|
disableCouponList | CouponInfo[] | 不可用优惠劵列表 | 优惠券未失效,但是不适合该订单 |
couponList | CouponInfo[] | 可用优惠劵列表 | 优惠券未失效,适合该订单的商品 |
disableCouponCount | int | 不可用优惠劵数量 | 不可用优惠劵数量 |
resultCode | int | 返回标记 | 如果返回标记1则为API调用成功 否则则是错误编号 |
couponCount | int | 可用优惠劵数量 | 可用优惠劵数量 |
resultMessage | String | 返回消息 | 返回的消息描述 |
参数名称 | 类型 | 参数描述 | 备注 |
---|---|---|---|
expireTime | long | 优惠劵到期时间戳 | 毫秒数 |
surplusMoney | BigDecimal | 剩余金额 | 剩余金额 |
count | int | 优惠券数量 | 优惠劵数量 |
bigOrderCode | String | 触发订单 | 生成此优惠券的大订单号 |
couponTypeCode | String | 优惠券类型编号 | 优惠券类型编号 |
endTime | String | 结束时间 | 结束时间 |
initialMoney | BigDecimal | 初始金额 | 初始金额 |
startTime | String | 开始时间 | 开始时间 |
systemTime | long | 系统时间戳 | 毫秒数 |
useLimit | String | 使用范围 | 使用范围 |
is_change | String | 是否允许找零 | 是否允许找零 |
activityCode | String | 活动编号 | 活动编号 |
is_multi_use | String | 是否可以叠加使用 | Y可以叠加使用 / N不可用叠加使用 |
status | int | 优惠劵状态 | 0:未使用;1:已使用;2:已过期 5:未激活 |
channelLimit | String | 是否限制平台 | 0:否,1是 |
couponCode | String | 优惠劵编号 | 优惠劵编号 |
actionType | String | 点击优惠券跳转类型 | 点击优惠券的跳转类型 目前只有跳转到详情页类型3.9.2 |
limitCondition | String | 限制条件 | 限制条件 |
limitMoney | BigDecimal | 最小限额 | 最小限额 |
limitExplain | String | 使用说明 | 使用说明 |
isSee | String | 是否已查看 | 0:否,1是 |
isShowDue | String | 是否显示快过期 | 1显示 0不显示 |
actionValue | String | 跳转值 | 点击优惠券的跳转值 目前只有一个商品的时候才会跳转到详情页3.9.2,4497471600280001:商品详情页,4497471600280002:wap页 |
deadline | String | 优惠劵过期提醒 | 还剩X天 |
moneyType | String | 优惠券金额类型 | 449748120001: 金额卷,449748120002: 折扣券 |
参数名称 | 类型 | 参数描述 | 备注 |
---|---|---|---|
area_code | String | 地区编号 | 可不填写,添加购物车不再需要区域编号 |
flg | String | 是否原价购买 | (0:否;1:是)针对商品参与活动但活动库存售罄的情况下,想要原价购买 |
pageSource | String | 页面来源 | |
tgzShowCode | String | 推广赚买家秀编号 | |
shareCode | String | 推广人编号 | |
sku_num | int | 商品数量 | 商品数量 |
isNCSpecial | String | 农场指定页下单标识 | 如果是农场指定页下单且赠送雨露则传 1 ,其他表示非指定 |
ifJJGFlag | String | 是否为加价购商品 0否 1是 | |
product_code | String | 商品编号 | 商品编号 |
tgzUserCode | String | 推广赚推广人编号 | |
chooseFlag | String | 是否选择 | 是否选择:1:是,0:否 |
buyOneFlag | String | 是否为顺手买一件商品 0否 1是 | |
sku_code | String | sku编号 | sku编号 |
integralDetailId | String | 积分商城活动ID | |
isPurchase | Integer | 是否显示内购 | 默认值为0,显示内购活动传递1 |
fxrcode | String | 分销人编号 |