帮助中心

1310-券库信息推送

2021-12-08

接口编号 1310

接口说明

  1. 券库信息推送;新增或修改券库时将券库信息推送给第三方,配合ChangeType使用(C是创建,B是修改,不支持修改的品牌,可忽略B的推送,反参true)

  2. 该调用由驿氪发起,同步回调支持错误重试3次;

  3. 调用方提供支持POST方式的接口地址;

  4. 不推送线上券库

  5. 线上退券(IsSingleCoupon、IsRemainValid、NewAddCouponValidDays)配合使用

  6. 线下退券(OfflineIsSingleCoupon、OfflineIsRemainValid、OfflineNewAddCouponValidDays)配合使用

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

  8. 商品券商品限制(GrpProConType=0、CouponProType、CouponProIsExclude、CouponPro)配合使用

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

  10. CouponProIsExclude:false包含时, 如果传了值就是按照传值清单进行限制,如果没有传值就是全部 门店/商品 可用

  11. 客户系统核销门店(ApplyIsExclude、CouponShop)配合使用,ApplyIsExclude等于false,全部门店可用,等于true,指定CouponShop门店可用

注:

     1>第三方成功处理需要返回{ "Status": true, "StatusCode": 200, ... },见返回结果示例;

     2>推送失败自动重试3次。

请求说明

  • HTTP请求方式:POST

  • 返回数据格式:JSON

  • 请求路径:callback(调用方提供支持POST方式的接口地址)

请求参数

指驿氪推送给第三方接口的数据格式

字段类型是否为空长度描述
CoupGrpIdint
券库Id
Codestring64外部的券编号(唯一编号)
TplNamestring32模板券库名
CouponNamestring32券名称
CouponPriceLimitdecimal
使用门槛
Guidestring1024使用说明
CouponTypestring2券类型DJ=品牌代金券ZK=品牌折扣券CX=品牌促销券LP=礼品券YQ=邀请券YY=异业券
OutSysstring
适用系统(不推送)
PromotionCodestring30促销编号
PromotionValidTypestring1有效类型(0= 固定时间段,1= 永久)
BegDatestring
有效开始日期(yyyy-MM-dd格式)
EndDatestring
有效结束日期(yyyy-MM-dd格式)
CouponValuedecimal
券面额
ValidityTypestring2有效期类型FV=永久有效(异业券不能永久有效)TS=固定时间段
ValidityDaysInt
有效期天数
IsCanGiveFriendbool
是否可以转赠
IsAllowMultipleCouponsbool
是否允许多张券
AllowMultipleCouponsint
可使用券数量(IsAllowMultipleCoupons=true生效)
LimitTypestring1门槛类型(已弃用)
IsAllowBuyMorebool
是否允许一个订单购买多个
AllowMaxBuyNumInt
允许一个订单最多购买多少商品
IsAllowPositivebool
是否仅允许正价商品使用
DiscountLimitInt
折扣限制(0~100)
IsDiscountLimitbool
是否折扣限制
PromotionTypeInt
促销类型1=打折、2=代金,3=其他
ApplyTypestring2(EZR线上商城)组织类型BD=全部用户,PQ=片区用户,GP=店群用户,SH=门店用户
ApplyIsExcludebool
(客户系统核销门店)true限制,false不限制
CouponShop[]
客户系统核销门店
CouponProIsExcludebool
true排除,false包含
CouponPro[]40适用商品
CouponProTypebool
商品券类型0=商品券,1= Sku券
UseSystemstring16券所使用系统,跟随券库创建,不填写,代表为供发放系统使用;EZR-MALL  代表仅供ezr商城券使用;EZR-ALL   代表通用券,所有客户系统可使用;其它系统值,咨询客户业务系统(例如:pos代表线下pos可使用)
IsFreePostInMallbool
true免邮
Subtitlestring36副标题
CouponRemarkstring64券描述
IsCouponDiscountAmountbool
是否控制折扣券折扣金额
CouponDiscountAmountdecimal
折扣券可用折扣金额
Platformint
0:ezr,1:兔展
CouponStatusint
状态 0=设计中  1=待审核 2=未通过 3=已生效  4=已禁用
IsProbool
是否支持到单品
ChangeTypestring1券库修改类型  C 新增  U 编辑
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,取值作为退券有效期
IsCompositedbool
多券库叠加使用(默认ture支持)
GrpProConTypeint
券库关联商品类型 0指定商品  1指定条件
ProBDTypeint
0全部品牌  1部分品牌
IsContainBDstring11包含  0排除
ProdBrandslist<string>
品牌Code
ProCateTypeint
0全部分类  1部分分类
IsContainCatestring11包含  0排除
ProdCateslist
分类Code
ExcludeProdslist<string>30排除的商品
RemoveProTypeint
0:不排除,1:排除sku,3:排除商品
IsProDiscountLimitbool
商品折扣限制(true有 false无)
ProDiscountLimitint
商品折扣限制
SpecialFieldInfoListList
券库自定义属性集合
AllowMinBuyNumint
允许一个订单最少购买多少商品
IsAllowBuyLessbool
是否限制一个订单最少购买商品数
PQConsumeCodeslist<string>

片区编码list
GPConsumeCodeslist<string>

店群编码list

ProdBrands数据结构


ProdBrandCodestring是否为空长度商品品牌CODE
ProdBrandNamestring64商品品牌名称

ProdCates数据结构

ProdCateCodestring是否为空长度商品分类CODE
ProdCateNamestring32商品分类名称

SpecialFieldInfoList数据结构


FieldCodestring设置的CODE
FieldValuestring可选值

请求参数示例代码(json对象)

{

"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,

“IsDiscountLimit”:true,

"PromotionType":0,

"ApplyType":"",

"ApplyIsExclude":false,

"CouponProType":1,

"CouponProIsExclude":false,

"CouponPro":[

    "3158000224",

    "3158000225"

],

 "IsFreePostInMall":true,

"IsSingleCoupon":false,

"IsRemainValid":0,

“IsComposited”:true,

"NewAddCouponValidDays":"0,

"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"}]

}

业务返回结果示例(json对象):

{

"Status": true,

"StatusCode": 200,

"Msg": "成功",

"Timestamp": "20150622093101",

"Sign": "6ECC9BF07C69E80F6D8552FF7B2E7A8FCA2CC80E",

"Result": 见业务返回结果示例,

}

 

 


6529