帮助中心
进入EZR

1311-券库信息查询

2021-12-08

接口编号 1311

接口说明

  1. 第三方根据券码[CouponNo]或者券库ID[CoupGrpId]调用接口查询券库信息

  2. 线上退券（IsSingleCoupon、IsRemainValid、NewAddCouponValidDays）配合使用

  3. 线下退券（OfflineIsSingleCoupon、OfflineIsRemainValid、OfflineNewAddCouponValidDays）配合使用

  4. SpecialFieldInfoList是集合对象，存放自定义券库属性

  5. 商品券商品限制（GrpProConType=0、CouponProType、CouponProIsExclude、CouponPro）配合使用

  6. 品类券（GrpProConType=1、ProBDType、IsContainBD、ProdBrandCodes、ProCateType、IsContainCate、ProdCateCodes）配合使用，结合（CouponProType、CouponPro）指定排除商品，（ExcludeProds、RemoveProType）表示分类下的商品

  7. CouponProIsExclude：false包含时， 如果传了值就是按照传值清单进行限制，如果没有传值就是全部 商品 可用

  8. 客户系统核销门店（ApplyIsExclude、CouponShop）配合使用，ApplyIsExclude等于false，全部门店可用，等于true，指定CouponShop门店可用

请求说明

  • HTTP请求方式：POST

  • 返回数据格式：JSON

  • 请求路径：api/ccoup/CoupGrpQuery

请求参数


字段类型是否必填长度描述
CoupGrpIdstring否
券库ID
CouponNostring否40券号码


备注：券库ID/券号码必填一个

请求参数示例代码（json对象）

{"CoupGrpId":"1074465", "CouponNo":"DJQ00001"}

返回参数


字段类型是否为空长度描述
CoupGrpIdint否
券库Id
Codestring是64外部的券编号（唯一编号）
Subtitlestring是36标题
TplNamestring否32模板券库名
CouponNamestring否32券名称
CouponPriceLimitdecimal是
使用门槛
Guidestring否1024使用说明
CouponTypestring否2券类型DJ=品牌代金券ZK=品牌折扣券CX=品牌促销券LP=礼品券YQ=邀请券YY=异业券
PromotionCodestring是30促销编号
PromotionValidTypeInt否
有效类型（0= 固定时间段,1= 永久）
BegDatestring否
有效开始日期(yyyy-MM-dd格式)
EndDatestring否
有效结束日期(yyyy-MM-dd格式)
CouponValuedecimal否
券面额
ValidityTypestring是2有效期类型FV=永久有效（异业券不能永久有效）TS=固定时间段
ValidityDaysInt是
有效期天数
IsCanGiveFriendbool否
是否可以转赠
IsAllowMultipleCouponsbool否
是否允许多张券
AllowMultipleCouponsint是
可使用券数量
LimitTypestring是1门槛类型(已弃用)
IsAllowBuyMorebool否
是否允许一个订单购买多个
AllowMaxBuyNumInt是
允许一个订单最多购买多少商品
IsAllowPositivebool否
是否仅允许正价商品使用
DiscountLimitInt是
折扣限制（0~100）
IsDiscountLimitbool否
是否折扣限制
PromotionTypeInt否
促销类型1=打折、2=代金，3=其他
ApplyTypestring否2(EZR线上核销)组织类型BD=全部用户，PQ=片区用户，GP=店群用户，SH=门店用户
ApplyIsExcludebool否
(客户系统核销门店)true限制，false不限制
CouponShop[]否
客户系统核销门店
CouponProTypeInt否
商品券类型0=商品券,1= Sku券,2=品类券
CouponProIsExcludebool否
true排除，false包含（ CouponPro不为空时必填）配合CouponProType使用
OnlineApplyIsExcludebool否
(线上商城核销门店)true限制，false不限制
UseSystemstring是16适用系统
CouponPro[]是
适用商品
GrpProConTypeint否
券库关联商品类型 0指定商品  1指定条件
ProBDTypeint否
0全部品牌  1部分品牌
IsContainBDstring否11包含  0排除
ProdBrandslist是
品牌Code
ProCateTypeint否10全部分类  1部分分类
IsContainCatestring否11包含  0排除
ProdCateslist是
分类Code
ExcludeProdslist<string>是
排除的商品/sku
RemoveProTypeint否
0:不排除,1:排除sku,3:排除商品
IsSingleCouponbool否
线上退券(false不支持,true支持，仅在UseSystem为EZR-MALL有效)
IsRemainValidint是
退还原券有效期 1保持原有效期 2自补发后X天有效（0-90天有效，0代表当天）
NewAddCouponValidDaysint是
IsRemainValid=2，取值作为退券有效期
OfflineIsSingleCouponbool否
线下退券（true支持，false不支持）
OfflineIsRemainValidint是
退还原券有效期 1保持原有效期 2自补发后X天有效（0-90天有效，0代表当天）
OfflineNewAddCouponValidDaysint是
OfflineIsRemainValid=2，取值作为退券有效期
IsProDiscountLimitbool否
商品折扣限制(true有 false无)
ProDiscountLimitint是
商品折扣限制
SpecialFieldInfoListList是
券库自定义属性集合
AllowMinBuyNumint否
允许一个订单最少购买多少商品
IsAllowBuyLessbool否
是否限制一个订单最少购买商品数
PQConsumeCodeslist<string>

片区编码list
GPConsumeCodeslist<string>

店群编码list


ProdBrands数据结构


ProdBrandCodestring长度商品品牌CODE
ProdBrandNamestring16商品品牌名称


ProdCates数据结构


ProdCateCodestring长度商品分类CODE
ProdCateNamestring32商品分类名称


SpecialFieldInfoList数据结构


FieldCodestring设置的CODE
FieldValuestring可选值


系统级返回结果示例（json）

{"Status":true,"StatusCode":200,"Msg":"成功","Timestamp":"20150622093101","Sign":"6ECC9BF07C69E80F6D8552FF7B2E7A8FCA2CC80E","Result":{   "CoupGrpId":1074465,   "TplName":null,   "CouponName":"价值10元代金券",   "Code":null,   "Subtitle":null,   "CouponPriceLimit":1000,   "CouponRemark":null,   "Guide":"价值10元代金券",   "CouponType":"DJ",   "OutSys":null,   "UseSystem":"EZR-ALL",   "PromotionCode":0,   "PromotionValidType":"0",   "BegDate":"",   "EndDate":"",   "CouponValue":"200.00",   "ValidityType":null,   "ValidityDays":0,   "IsCanGiveFriend":false,   "IsAllowMultipleCoupons":true,   "LimitType":null,   "IsAllowBuyMore":false,   "AllowMaxBuyNum":0,   "IsAllowPositive":true,   "DiscountLimit":50,   "PromotionType":0,   "ApplyType":"",   "ApplyIsExclude":false,   "CouponProType":1,   "CouponProIsExclude":false,   "CouponPro":[       "3158000224",       "3158000225"   ],   "CouponShop":[       "100001",       "100002"   ],   "GrpProConType":0,   "ProBDType":0,   "IsContainBD":"0",   "ProdBrands":[       {           "ProdBrandCode":"Code01",           "ProdBrandName":"Name01"       }   ],   "ProCateType":0,   "IsContainCate":"0",   "ProdCates":[       {           "ProdCateCode":"Code01",           "ProdCateName":"Name01"       }   ],   "ExcludeProds":[   ],   "RemoveProType":0,   "AllowMinBuyNum":10,   "IsAllowBuyLess":true,   "SpecialFieldInfoList":[{"FieldCode":"code1","FieldValue":"value1"}]}}



4801