接口说明
券库信息推送;新增或修改券库时将券库信息推送给第三方,配合ChangeType使用(C是创建,B是修改,不支持修改的品牌,可忽略B的推送,反参true)
该调用由驿氪发起,同步回调支持错误重试3次;
调用方提供支持POST方式的接口地址;
不推送线上券库
线上退券(IsSingleCoupon、IsRemainValid、NewAddCouponValidDays)配合使用
线下退券(OfflineIsSingleCoupon、OfflineIsRemainValid、OfflineNewAddCouponValidDays)配合使用
SpecialFieldInfoList是集合对象,存放自定义券库属性
商品券商品限制(GrpProConType=0、CouponProType、CouponProIsExclude、CouponPro)配合使用
品类券(GrpProConType=1、ProBDType、IsContainBD、ProdBrandCodes、ProCateType、IsContainCate、ProdCateCodes)配合使用,结合(CouponProType、CouponPro)指定排除商品,(ExcludeProds、RemoveProType)表示分类下的商品
CouponProIsExclude:false包含时, 如果传了值就是按照传值清单进行限制,如果没有传值就是全部 门店/商品 可用
客户系统核销门店(ApplyIsExclude、CouponShop)配合使用,ApplyIsExclude等于false,全部门店可用,等于true,指定CouponShop门店可用
注:
1>第三方成功处理需要返回{ "Status": true, "StatusCode": 200, ... },见返回结果示例;
2>推送失败自动重试3次。
请求说明
HTTP请求方式:POST
返回数据格式:JSON
请求路径:callback(调用方提供支持POST方式的接口地址)
请求参数
指驿氪推送给第三方接口的数据格式
字段 | 类型 | 是否为空 | 长度 | 描述 |
---|---|---|---|---|
CoupGrpId | int | 否 | 券库Id | |
Code | string | 是 | 64 | 外部的券编号(唯一编号) |
TplName | string | 否 | 32 | 模板券库名 |
CouponName | string | 否 | 32 | 券名称 |
CouponPriceLimit | decimal | 是 | 使用门槛 | |
Guide | string | 否 | 1024 | 使用说明 |
CouponType | string | 否 | 2 | 券类型DJ=品牌代金券ZK=品牌折扣券CX=品牌促销券LP=礼品券YQ=邀请券YY=异业券 |
OutSys | string | 是 | 适用系统(不推送) | |
PromotionCode | string | 是 | 30 | 促销编号 |
PromotionValidType | string | 否 | 1 | 有效类型(0= 固定时间段,1= 永久) |
BegDate | string | 是 | 有效开始日期(yyyy-MM-dd格式) | |
EndDate | string | 是 | 有效结束日期(yyyy-MM-dd格式) | |
CouponValue | decimal | 否 | 券面额 | |
ValidityType | string | 是 | 2 | 有效期类型FV=永久有效(异业券不能永久有效)TS=固定时间段 |
ValidityDays | Int | 否 | 有效期天数 | |
IsCanGiveFriend | bool | 否 | 是否可以转赠 | |
IsAllowMultipleCoupons | bool | 否 | 是否允许多张券 | |
AllowMultipleCoupons | int | 否 | 可使用券数量(IsAllowMultipleCoupons=true生效) | |
LimitType | string | 是 | 1 | 门槛类型(已弃用) |
IsAllowBuyMore | bool | 否 | 是否允许一个订单购买多个 | |
AllowMaxBuyNum | Int | 是 | 允许一个订单最多购买多少商品 | |
IsAllowPositive | bool | 否 | 是否仅允许正价商品使用 | |
DiscountLimit | Int | 否 | 折扣限制(0~100) | |
IsDiscountLimit | bool | 否 | 是否折扣限制 | |
PromotionType | Int | 是 | 促销类型1=打折、2=代金,3=其他 | |
ApplyType | string | 否 | 2 | (EZR线上商城)组织类型BD=全部用户,PQ=片区用户,GP=店群用户,SH=门店用户 |
ApplyIsExclude | bool | 否 | (客户系统核销门店)true限制,false不限制 | |
CouponShop | [] | 是 | 客户系统核销门店 | |
CouponProIsExclude | bool | 否 | true排除,false包含 | |
CouponPro | [] | 是 | 40 | 适用商品 |
CouponProType | bool | 是 | 商品券类型0=商品券,1= Sku券 | |
UseSystem | string | 否 | 16 | 券所使用系统,跟随券库创建,不填写,代表为供发放系统使用;EZR-MALL 代表仅供ezr商城券使用;EZR-ALL 代表通用券,所有客户系统可使用;其它系统值,咨询客户业务系统(例如:pos代表线下pos可使用) |
IsFreePostInMall | bool | 否 | true免邮 | |
Subtitle | string | 是 | 36 | 副标题 |
CouponRemark | string | 是 | 64 | 券描述 |
IsCouponDiscountAmount | bool | 否 | 是否控制折扣券折扣金额 | |
CouponDiscountAmount | decimal | 是 | 折扣券可用折扣金额 | |
Platform | int | 是 | 0:ezr,1:兔展 | |
CouponStatus | int | 否 | 状态 0=设计中 1=待审核 2=未通过 3=已生效 4=已禁用 | |
IsPro | bool | 否 | 是否支持到单品 | |
ChangeType | string | 否 | 1 | 券库修改类型 C 新增 U 编辑 |
IsSingleCoupon | bool | 否 | 线上退券(false不支持,true支持,仅在UseSystem为EZR-MALL有效) | |
IsRemainValid | int | 否 | 退还原券有效期 1保持原有效期 2自补发后X天有效(0-90天有效,0代表当天) | |
NewAddCouponValidDays | int | 是 | IsRemainValid=2,取值作为退券有效期 | |
OfflineIsSingleCoupon | bool | 否 | 线下退券(true支持,false不支持) | |
OfflineIsRemainValid | int | 否 | 退还原券有效期 1保持原有效期 2自补发后X天有效(0-90天有效,0代表当天) | |
OfflineNewAddCouponValidDays | int | 是 | OfflineIsRemainValid=2,取值作为退券有效期 | |
IsComposited | bool | 否 | 多券库叠加使用(默认ture支持) | |
GrpProConType | int | 否 | 券库关联商品类型 0指定商品 1指定条件 | |
ProBDType | int | 否 | 0全部品牌 1部分品牌 | |
IsContainBD | string | 否 | 1 | 1包含 0排除 |
ProdBrands | list<string> | 是 | 品牌Code | |
ProCateType | int | 否 | 0全部分类 1部分分类 | |
IsContainCate | string | 否 | 1 | 1包含 0排除 |
ProdCates | list | 是 | 分类Code | |
ExcludeProds | list<string> | 是 | 30 | 排除的商品 |
RemoveProType | int | 否 | 0:不排除,1:排除sku,3:排除商品 | |
IsProDiscountLimit | bool | 否 | 商品折扣限制(true有 false无) | |
ProDiscountLimit | int | 是 | 商品折扣限制 | |
SpecialFieldInfoList | List | 是 | 券库自定义属性集合 | |
AllowMinBuyNum | int | 否 | 允许一个订单最少购买多少商品 | |
IsAllowBuyLess | bool | 否 | 是否限制一个订单最少购买商品数 | |
PQConsumeCodes | list<string> | 片区编码list | ||
GPConsumeCodes | list<string> |
ProdBrands数据结构
ProdBrandCode | string | 是否为空 | 长度 | 商品品牌CODE |
---|---|---|---|---|
ProdBrandName | string | 否 | 64 | 商品品牌名称 |
ProdCates数据结构
ProdCateCode | string | 是否为空 | 长度 | 商品分类CODE |
---|---|---|---|---|
ProdCateName | string | 否 | 32 | 商品分类名称 |
SpecialFieldInfoList数据结构
FieldCode | string | 设置的CODE |
---|---|---|
FieldValue | string | 可选值 |
请求参数示例代码(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": 见业务返回结果示例,
}