[[TOC]]

= 礼品/优惠券 =

礼品和优惠券属于同一个实体，通过[http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#礼品 $gift]中的type字段来区分
== 自设定礼品 ==

> /app/trial/cache/setupGift.do 

**说明**

> 弃用该接口，请使用 [http://trac.pc.com.cn/pc_best/wiki/app2.0/05_gift#礼品列表 礼品列表] 接口

----------

== 礼品/优惠券列表 ==

> 线上：[http://best.pconline.com.cn/app/gift/cache/listGift.do?pageNo=1&pageSize=2&type=3&mallId=0&recommendToAppIndex=-1&recommendToAppSunplaza=-1 /app/gift/cache/listGift.do]

**说明**

> 分页获取礼品列表，传入type为礼品的类型进行查找

**提交方式**

> GET

**是否需要登录**

> 否

**缓存方式**

> 接口缓存

**缓存时间**

> 300秒

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||pageNo||页数||int||1||是||
||pageSize||页面大小||int||10||是||
||type||礼品类型： 1 礼品卡   2 实物礼品  3 优惠券||int||1||否||
||mallId||电商id，0表示查找所有||int||0||否||
||recommendToAppIndex||是否推荐到App首页，1是 0 否 -1 无限制||int||-1||否||
||recommendToAppSunplaza||是否推荐到App广场，1是 0 否 -1 无限制||int||-1||否||

**返回**

{{{#!java
result {
	status: 1
	pageNo： 1
	pageSize： 20,
	total: 100,
	pageTotal: 5,
	msg: '请求成功',
	data: [$gift]
}
}}}

[http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#礼品 $gift]

----------

== 我的礼品/优惠券列表 ==

> 线上：[http://best.pconline.com.cn/app/my/gift/listMyGiftExchange.do?pageNo=1&pageSize=10&status=1&type=3&common_session_id=56D39281DCC5AA42DC3D98B1A2E48B9A /app/my/gift/listMyGiftExchange.do]

**说明**

> 获取我的礼品列表，type=3的时候表示优惠券，包括未失效和已失效的

**提交方式**

> GET

**是否需要登录**

> 是

**缓存方式**

> 无

**缓存时间**

> -

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||pageNo||页数||int||1||是||
||pageSize||页面大小||int||10||是||
||type||1 礼品卡  2 实物礼品   3 优惠券||int||3||是||
||status||状态：2 已过期，1 未过期||String||""||是||
||common_session_id||-||String||""||是||

**返回**

{{{#!java
result {
	status: 1
	pageNo： 1
	pageSize： 20,
	total: 100,
	pageTotal: 5,
	msg: '请求成功',
	data: [$giftExchange]
}
}}}

[http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#兑换记录 $giftExchange]

----------

== 礼品/优惠券信息 ==

> 线上：[http://best.pconline.com.cn/app/gift/getGiftInfo.do?giftId=231&fontSize=14 /app/gift/getGiftInfo.do]

**说明**

> 返回渲染成wap页面

**提交方式**

> GET

**是否需要登录**

> 否

**缓存方式**

> 无

**缓存时间**

> -

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||giftId||礼品id||int||0||是||
||fontSize||wap页面字号||int||14||是||

**返回**

{{{#!java
result: {
	status: 1
	msg: '请求成功',
	data: {
            gift: $gift,
            giftDesc: $giftDesc,
            fontSize: 14
        }
}}}

[http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#礼品 $gift]

[http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#礼物描述 $giftDesc]

----------

== 领取优惠券接口 ==

> 线上：[http://best.pconline.com.cn/app/my/gift/exchangeCoupon.do?giftId=244&common_session_id=56D39281DCC5AA42DC3D98B1A2E48B9A /app/my/gift/exchangeCoupon.do]

**说明**

> 兑换优惠券接口，是否登录，是否已领完，是否已失效，金币，积分是否不足

**提交方式**

> POST

**是否需要登录**

> 是

**缓存方式**

> 无

**缓存时间**

> -

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||giftId||礼品Id，注意这里传入礼品的giftId而不是优惠券的couponId||int||0||是||
||common_session_id||-||String||""||是||

**返回**

{{{#!java
resul {
	status: 1,
	msg: '请求成功',
        data: {
            status:1,  // 1 兑换成功  -1  请刷新页面重试  -2 该优惠券无效   -3 该优惠券已过期  -4 兑换出错，请稍后再试。 -5 优惠券领取次数超过限制!  -6 金币或积分不足!  -7 该优惠券无效或已全部被兑换!  -8 兑换失败！
            desc:"领取成功！"//信息提示
            cardNum: 123,  // 优惠券码
            giftStatus: 1,  // 礼品状态：0 禁用  1  正常
            cardPassword: 123456,  // 优惠券密码
            mallUrl: http://a.b.c,  // 优惠券所属的电商首页
            gold:1,  // 用户当前的金币
            score: 2  // 用户当前的积分
        }
}
}}}

----------

== 热门优惠券列表 ==

> 线上：[http://best.pconline.com.cn/app/gift/cache/listHotCoupon.do?giftId=0&limit=4 /app/gift/cache/listHotCoupon.do]

**说明**

> 获取热门优惠券

**提交方式**

> GET

**是否需要登录**

> 否

**缓存方式**

> 接口缓存

**缓存时间**

> 300秒

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||giftId||需要过滤的优惠券，不传表示不进行过滤||int||0||否||
||limit||获取条数||int||10||否||

**返回**

{{{#!java
result: {
	status: 1,
	msg: '请求成功',
	limit: 10,
	data: [$gift]    
}
}}}

[http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#优惠券 $giftCoupon]

----------


== 我的礼品/优惠兑换记录 ==

> 线上：[http://best.pconline.com.cn/app/my/gift/getMyGiftExchangeInfo.do?pageNo=1&pageSize=10&status=1&type=3&common_session_id=56D39281DCC5AA42DC3D98B1A2E48B9A /app/my/gift/getMyGiftExchangeInfo.do]

**说明**

> 获取某用户某个礼品兑换记录

**提交方式**

> GET

**是否需要登录**

> 是

**缓存方式**

> 无

**缓存时间**

> -

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||exchangeId||123||int||0||是||
||common_session_id||-||String||""||是||

**返回**

{{{#!java
result {
	status: 1
	msg: '请求成功',
	data: $giftExchange
}
}}}

[http://trac.pc.com.cn/pc_best/wiki/app2.0/object_properties#兑换记录 $giftExchange]

---------


== 兑换礼品接口（礼品卡或实物礼品） ==

> 线上：[http://best.pconline.com.cn/app/my/gift/exchangeGift.do?giftId=244&common_session_id=56D39281DCC5AA42DC3D98B1A2E48B9A /app/my/gift/exchangeGift.do]

**说明**

> 兑换礼品卡或实物礼品接口，是否登录，是否已领完，是否已失效，金币，积分是否不足

**提交方式**

> POST

**是否需要登录**

> 是

**缓存方式**

> 无

**缓存时间**

> -

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||giftId||礼品Id||int||0||是||
||name||收货人姓名||String||""||实物礼品兑换必填||
||phone||收货人电话||String||""||实物礼品兑换必填||
||address||收货人地址||String||""||实物礼品兑换必填||
||email||收货人邮箱||String||""||实物礼品兑换必填||
||common_session_id||-||String||""||是||

**返回**

{{{#!java
resul {
	status: 1,
	msg: '请求成功',
        data: {
            status:1,              // 具体含义对照下面状态表
            msg:"领取成功！"       //信息提示
            cardNum: 123,          // 优惠券码
            giftStatus: 1,         // 礼品状态：0 禁用  1  正常
            cardPassword: 123456,  // 优惠券密码
            mallUrl: http://a.b.c, // 优惠券所属的电商首页
            gold:1,                // 用户当前的金币
            score: 2               // 用户当前的积分
        }
}
}}}
**data.ststus含义**

||= status =||= msg =||
||1||兑换成功！||
||-2||礼品不存在！||
||-3||礼品不存在！||
||-9||礼品领取次数超过限制！||
||-10||您的金币，积分或者钻石不足！||
||-4||邮箱地址不正确！||
||-5||收货人名称不正确！||
||-6||收货地址不正确！||
||-7||电话不正确！||