org.oxerr.youzan.service

Class CouponService

java.lang.Object

org.oxerr.youzan.service.CouponService

public class CouponService
extends Object

优惠券优惠码接口.

Field Summary

Fields

Modifier and Type	Field and Description
protected KdtApiClient	client
protected static com.fasterxml.jackson.core.type.TypeReference<Response<CouponConsume>>	COUPON_CONSUME_RESPONSE_TYPE_REF
protected static com.fasterxml.jackson.core.type.TypeReference<Response<Coupon>>	COUPON_RESPONSE_TYPE_REF
protected static com.fasterxml.jackson.core.type.TypeReference<Response<Coupons>>	COUPONS_RESPONSE_TYPE_REF
protected static com.fasterxml.jackson.core.type.TypeReference<Response<Item>>	ITEM_RESPONSE_TYPE_REF
protected static com.fasterxml.jackson.core.type.TypeReference<Response<Items>>	ITEMS_RESPONSE_TYPE_REF
protected com.fasterxml.jackson.databind.ObjectMapper	mapper
protected static com.fasterxml.jackson.core.type.TypeReference<Response<SelfFetchTrade>>	SELF_FETCH_TRADE_RESPONSE_TYPE_REF
protected static com.fasterxml.jackson.core.type.TypeReference<Response<Shop>>	SHOP_RESPONSE_TYPE_REF
protected static com.fasterxml.jackson.core.type.TypeReference<Response<Sku>>	SKU_RESPONSE_TYPE_REF
protected static com.fasterxml.jackson.core.type.TypeReference<Response<Skus>>	SKUS_RESPONSE_TYPE_REF
protected static com.fasterxml.jackson.core.type.TypeReference<Response<Success>>	SUCCESS_RESPONSE_TYPE_REF
protected static com.fasterxml.jackson.core.type.TypeReference<Response<TimelimitedDiscounts>>	TIMELIMITED_DISCOUNTS_RESPONSE_TYPE_REF
protected static com.fasterxml.jackson.core.type.TypeReference<Response<Trade>>	TRADE_RESPONSE_TYPE_REF
protected static com.fasterxml.jackson.core.type.TypeReference<Response<Trades>>	TRADES_RESPONSE_TYPE_REF
protected static com.fasterxml.jackson.core.type.TypeReference<Response<Verifylogs>>	VERIFYLOGS_RESPONSE_TYPE_REF

Constructor Summary

Constructors

Constructor and Description
CouponService(KdtApiClient client)

Method Summary

Modifier and Type	Method and Description
UmpCoupon[]	getAllUnfinishedCoupons(String fields) 获取所有未结束的优惠列表（包含未开始的、进行中的）.
CouponConsume	getCouponConsume(String code) 根据核销码获取优惠券/优惠码.
TimelimitedDiscounts	getTimelimitedDiscounts(Integer pageSize, Long pageNo) 获取限时折扣的商品和折扣信息.
UmpPromotionVerifylog[]	getVerifylogs(String type, Integer pageSize, Long pageNo) 获取优惠券/优惠码核销记录.
protected <T> T	readValue(String method, Map<String,String> params, com.fasterxml.jackson.core.type.TypeReference valueTypeRef)
Coupon	takeCoupon(String weixinOpenId, Long fansId, Long couponGroupId) 微信粉丝领取优惠券优惠码.
boolean	verifyCouponConsume(String code) 核销优惠券/优惠码.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUCCESS_RESPONSE_TYPE_REF

protected static final com.fasterxml.jackson.core.type.TypeReference<Response<Success>> SUCCESS_RESPONSE_TYPE_REF

ITEM_RESPONSE_TYPE_REF

protected static final com.fasterxml.jackson.core.type.TypeReference<Response<Item>> ITEM_RESPONSE_TYPE_REF

ITEMS_RESPONSE_TYPE_REF

protected static final com.fasterxml.jackson.core.type.TypeReference<Response<Items>> ITEMS_RESPONSE_TYPE_REF

SKU_RESPONSE_TYPE_REF

protected static final com.fasterxml.jackson.core.type.TypeReference<Response<Sku>> SKU_RESPONSE_TYPE_REF

SKUS_RESPONSE_TYPE_REF

protected static final com.fasterxml.jackson.core.type.TypeReference<Response<Skus>> SKUS_RESPONSE_TYPE_REF

SHOP_RESPONSE_TYPE_REF

protected static final com.fasterxml.jackson.core.type.TypeReference<Response<Shop>> SHOP_RESPONSE_TYPE_REF

TRADE_RESPONSE_TYPE_REF

protected static final com.fasterxml.jackson.core.type.TypeReference<Response<Trade>> TRADE_RESPONSE_TYPE_REF

TRADES_RESPONSE_TYPE_REF

protected static final com.fasterxml.jackson.core.type.TypeReference<Response<Trades>> TRADES_RESPONSE_TYPE_REF

SELF_FETCH_TRADE_RESPONSE_TYPE_REF

protected static final com.fasterxml.jackson.core.type.TypeReference<Response<SelfFetchTrade>> SELF_FETCH_TRADE_RESPONSE_TYPE_REF

COUPONS_RESPONSE_TYPE_REF

protected static final com.fasterxml.jackson.core.type.TypeReference<Response<Coupons>> COUPONS_RESPONSE_TYPE_REF

COUPON_CONSUME_RESPONSE_TYPE_REF

protected static final com.fasterxml.jackson.core.type.TypeReference<Response<CouponConsume>> COUPON_CONSUME_RESPONSE_TYPE_REF

VERIFYLOGS_RESPONSE_TYPE_REF

protected static final com.fasterxml.jackson.core.type.TypeReference<Response<Verifylogs>> VERIFYLOGS_RESPONSE_TYPE_REF

COUPON_RESPONSE_TYPE_REF

protected static final com.fasterxml.jackson.core.type.TypeReference<Response<Coupon>> COUPON_RESPONSE_TYPE_REF

TIMELIMITED_DISCOUNTS_RESPONSE_TYPE_REF

protected static final com.fasterxml.jackson.core.type.TypeReference<Response<TimelimitedDiscounts>> TIMELIMITED_DISCOUNTS_RESPONSE_TYPE_REF

client

protected final KdtApiClient client

mapper

protected final com.fasterxml.jackson.databind.ObjectMapper mapper

Constructor Detail

CouponService

public CouponService(KdtApiClient client)

Method Detail

getAllUnfinishedCoupons

public UmpCoupon[] getAllUnfinishedCoupons(@Nullable
                                           String fields)
                                    throws IOException,
                                           YouzanException

获取所有未结束的优惠列表（包含未开始的、进行中的）.

Parameters:

fields - 需要返回的优惠对象字段。可选值：优惠结构体中所有字段均可返回；多个字段用“,”分隔。如果为空则返回所有

Returns:

所有未结束的优惠列表（包含未开始的、进行中的）

Throws:

IOException - indicates I/O exception.

YouzanException - indicates Youzan business exception.

getCouponConsume

public CouponConsume getCouponConsume(@Nonnull
                                      String code)
                               throws IOException,
                                      YouzanException

根据核销码获取优惠券/优惠码.

Parameters:

code - 核销码

Returns:

优惠券/优惠码

Throws:

IOException - indicates I/O exception.

YouzanException - indicates Youzan business exception.

verifyCouponConsume

public boolean verifyCouponConsume(@Nonnull
                                   String code)
                            throws IOException,
                                   YouzanException

核销优惠券/优惠码.

Parameters:

code - 核销码

Returns:

核销结果

Throws:

IOException - indicates I/O exception.

YouzanException - indicates Youzan business exception.

getVerifylogs

public UmpPromotionVerifylog[] getVerifylogs(@Nullable
                                             String type,
                                             @Nullable
                                             Integer pageSize,
                                             @Nullable
                                             Long pageNo)
                                      throws IOException,
                                             YouzanException

获取优惠券/优惠码核销记录.

Parameters:

type - the type.

pageSize - the page size.

pageNo - the page number.

Returns:

优惠券/优惠码核销记录

Throws:

IOException - indicates I/O exception.

YouzanException - indicates Youzan business exception.

takeCoupon

public Coupon takeCoupon(@Nullable
                         String weixinOpenId,
                         @Nullable
                         Long fansId,
                         @Nonnull
                         Long couponGroupId)
                  throws IOException,
                         YouzanException

微信粉丝领取优惠券优惠码.

Parameters:

weixinOpenId - 微信用户对应的openid

fansId - 微信粉丝id，fans_id与weixin_openid存在一个即可

couponGroupId - 优惠券码组id

Returns:

优惠券优惠码

Throws:

IOException - indicates I/O exception.

YouzanException - indicates Youzan business exception.

getTimelimitedDiscounts

public TimelimitedDiscounts getTimelimitedDiscounts(@Nonnull
                                                    Integer pageSize,
                                                    @Nonnull
                                                    Long pageNo)
                                             throws IOException,
                                                    YouzanException

获取限时折扣的商品和折扣信息.

Parameters:

pageSize - 每页多少行数据(默认40行，最大500行)

pageNo - 第几页

Returns:

限时折扣的商品和折扣信息

Throws:

IOException - indicates I/O exception.

YouzanException - indicates Youzan business exception.

readValue

protected <T> T readValue(@Nonnull
                          String method,
                          @Nullable
                          Map<String,String> params,
                          @Nonnull
                          com.fasterxml.jackson.core.type.TypeReference valueTypeRef)
                   throws IOException,
                          YouzanException

Throws:

IOException

YouzanException