org.oxerr.youzan.service

Class TradeService

java.lang.Object

org.oxerr.youzan.service.TradeService

public class TradeService
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
TradeService(KdtApiClient client)

Method Summary

Modifier and Type	Method and Description
boolean	applySelfFetchTrade(String code) 核销到店自提订单.
TradeDetail	closeTrade(String tid, String closeReasonId, String closeReason, String fields) 卖家关闭一笔交易.
Trades	getForOuterSoldTrades(String outerType, String outerUserId, Integer pageSize, Long pageNo, Boolean useHasNext, Instant startCreated, Instant endCreated, Instant startUpdate, Instant endUpdate, String type, String status, String fields) 根据第三方userId查询订单列表.
SelfFetchTrade	getSelfFetchTrade(String code, String fields) 获取到店自提订单信息.
Trades	getSoldTrades(Integer pageSize, Long pageNo)
Trades	getSoldTrades(String version, Integer pageSize, Long pageNo, Boolean useHasNext, Instant startCreated, Instant endCreated, Instant startUpdate, Instant endUpdate, String type, String status, Long senderId, Long buyerId, String buyerNick, String buyWay, String keyword, Integer weixinUserType, Long weixinUserId, String fields) 查询卖家已卖出的交易列表.
TradeDetail	getTrade(String tid, Integer subTradePageSize, Long subTradePageNo, String fields) 获取单笔交易的信息.
protected <T> T	readValue(String method, Map<String,String> params, com.fasterxml.jackson.core.type.TypeReference valueTypeRef)
TradeDetail	updateTradeMemo(String tid, String memo, String flag, String fields) 修改一笔交易备注.

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

TradeService

public TradeService(KdtApiClient client)

Method Detail

getTrade

public TradeDetail getTrade(@Nonnull
                            String tid,
                            @Nullable
                            Integer subTradePageSize,
                            @Nullable
                            Long subTradePageNo,
                            @Nullable
                            String fields)
                     throws IOException,
                            YouzanException

获取单笔交易的信息.

Parameters:

tid - 交易编号

subTradePageSize - 指定获取子交易每页条数，不传则获取全部，上限500

subTradePageNo - 指定获取子交易的第几页，不传则获取全部

fields - 需要返回的交易对象字段，如tid,title,receiver_city等

Returns:

单笔交易的信息

Throws:

IOException - indicates I/O exception.

YouzanException - indicates Youzan business exception.

getSoldTrades

public Trades getSoldTrades(@Nullable
                            String version,
                            @Nullable
                            Integer pageSize,
                            @Nullable
                            Long pageNo,
                            @Nullable
                            Boolean useHasNext,
                            @Nullable
                            Instant startCreated,
                            @Nullable
                            Instant endCreated,
                            @Nullable
                            Instant startUpdate,
                            @Nullable
                            Instant endUpdate,
                            @Nullable
                            String type,
                            @Nullable
                            String status,
                            @Nullable
                            Long senderId,
                            @Nullable
                            Long buyerId,
                            @Nullable
                            String buyerNick,
                            @Nullable
                            String buyWay,
                            @Nullable
                            String keyword,
                            @Nullable
                            Integer weixinUserType,
                            @Nullable
                            Long weixinUserId,
                            @Nullable
                            String fields)
                     throws IOException,
                            YouzanException

查询卖家已卖出的交易列表.

Parameters:

version - 版本号

pageSize - 每页条数

pageNo - 页码

useHasNext - 是否启用has_next的分页方式

startCreated - 交易创建开始时间

endCreated - 交易创建结束时间

startUpdate - 交易状态更新的开始时间

endUpdate - 交易状态更新的结束时间

type - 订单类型 ，默认查询所有交易状态的数据，除了默认值外每次只能查询一种状态。 可选值：

• FIXED （一口价）
• GIFT （送礼）
• BULK_PURCHASE（来自分销商的采购）
• PRESENT （赠品领取）
• GROUP （拼团订单）
• COD （货到付款）
• PEER （代付）
• QRCODE（扫码商家二维码直接支付的交易）
• QRCODE_3RD（线下收银台二维码交易）

status - 一次只能查询一种状态。 可选值：

• TRADE_NO_CREATE_PAY（没有创建支付交易）
• WAIT_BUYER_PAY（等待买家付款）
• WAIT_GROUP（等待成团，即：买家已付款，等待成团）
• WAIT_SELLER_SEND_GOODS（等待卖家发货，即：买家已付款）
• WAIT_BUYER_CONFIRM_GOODS（等待买家确认收货，即：卖家已发货）
• TRADE_BUYER_SIGNED（买家已签收）
• TRADE_CLOSED（付款以后用户退款成功，交易自动关闭）
• ALL_WAIT_PAY（包含：WAIT_BUYER_PAY、TRADE_NO_CREATE_PAY）
• ALL_CLOSED（所有关闭订单）

senderId - sender ID

buyerId - 注册买家ID

buyerNick - 买家昵称

buyWay - 购买方式

keyword - 搜索条件

weixinUserType - 微信粉丝类型

weixinUserId - 微信粉丝ID

fields - 需要返回的交易对象字段

Returns:

卖家已卖出的交易列表

Throws:

IOException - indicates I/O exception.

YouzanException - indicates Youzan business exception.

getSoldTrades

public Trades getSoldTrades(@Nullable
                            Integer pageSize,
                            @Nullable
                            Long pageNo)
                     throws IOException,
                            YouzanException

Throws:

IOException

YouzanException

updateTradeMemo

public TradeDetail updateTradeMemo(@Nonnull
                                   String tid,
                                   @Nullable
                                   String memo,
                                   @Nullable
                                   String flag,
                                   @Nullable
                                   String fields)
                            throws IOException,
                                   YouzanException

修改一笔交易备注.

Parameters:

tid - 交易编号

memo - 交易备注

flag - 交易备注加星标，取值为1-5

fields - 需要返回的交易对象字段，如tid,title,receiver_city等。可选值：TradeDetail交易结构体中所有字段均可返回；多个字段用“,”分隔。如果为空则返回所有

Returns:

交易的信息

Throws:

IOException - indicates I/O exception.

YouzanException - indicates Youzan business exception.

closeTrade

public TradeDetail closeTrade(String tid,
                              String closeReasonId,
                              String closeReason,
                              String fields)
                       throws IOException,
                              YouzanException

卖家关闭一笔交易.

买家下单后未支付的情况下卖家关闭订单，在买家付款后该接口失效。

Parameters:

tid - 交易订单编号

closeReasonId - 关闭原因代码

closeReason - 关闭交易的原因

fields - 需要返回的交易对象字段，如tid,title,receiver_city等。可选值：TradeDetail交易结构体中所有字段均可返回；多个字段用“,”分隔。如果为空则返回所有

Returns:

交易的信息

Throws:

IOException - indicates I/O exception.

YouzanException - indicates Youzan business exception.

applySelfFetchTrade

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

核销到店自提订单.

Parameters:

code - 提货码

Returns:

核销结果

Throws:

IOException - indicates I/O exception.

YouzanException - indicates Youzan business exception.

getSelfFetchTrade

public SelfFetchTrade getSelfFetchTrade(@Nonnull
                                        String code,
                                        @Nullable
                                        String fields)
                                 throws IOException,
                                        YouzanException

获取到店自提订单信息.

Parameters:

code - 提货码

fields - 需要返回的交易对象字段，如tid,title,receiver_city等。可选值：TradeDetail交易结构体中所有字段均可返回；多个字段用“,”分隔。如果为空则返回所有

Returns:

到店自提订单信息

Throws:

IOException - indicates I/O exception.

YouzanException - indicates Youzan business exception.

getForOuterSoldTrades

public Trades getForOuterSoldTrades(@Nonnull
                                    String outerType,
                                    @Nonnull
                                    String outerUserId,
                                    @Nullable
                                    Integer pageSize,
                                    @Nullable
                                    Long pageNo,
                                    @Nullable
                                    Boolean useHasNext,
                                    @Nullable
                                    Instant startCreated,
                                    @Nullable
                                    Instant endCreated,
                                    @Nullable
                                    Instant startUpdate,
                                    @Nullable
                                    Instant endUpdate,
                                    @Nullable
                                    String type,
                                    @Nullable
                                    String status,
                                    @Nullable
                                    String fields)
                             throws IOException,
                                    YouzanException

根据第三方userId查询订单列表.

Parameters:

outerType - 三方用户ua

outerUserId - 三方用户userId

pageSize - 每页条数

pageNo - 页码

useHasNext - 是否启用has_next的分页方式

startCreated - 交易创建开始时间

endCreated - 交易创建结束时间

startUpdate - 交易状态更新的开始时间

endUpdate - 交易状态更新的结束时间

type - 订单类型 ，默认查询所有交易状态的数据，除了默认值外每次只能查询一种状态。 可选值： FIXED （一口价） GIFT （送礼） BULK_PURCHASE（来自分销商的采购） PRESENT （赠品领取） GROUP （拼团订单） COD （货到付款） PEER （代付） QRCODE（扫码商家二维码直接支付的交易）

status - 交易状态 ，默认查询所有交易状态的数据，除了默认值外每次只能查询一种状态。 可选值： TRADE_NO_CREATE_PAY（没有创建支付交易） WAIT_BUYER_PAY（等待买家付款） WAIT_GROUP（等待成团，即：买家已付款，等待成团） WAIT_SELLER_SEND_GOODS（等待卖家发货，即：买家已付款） WAIT_BUYER_CONFIRM_GOODS（等待买家确认收货，即：卖家已发货） TRADE_BUYER_SIGNED（买家已签收） TRADE_CLOSED（付款以后用户退款成功，交易自动关闭） ALL_WAIT_PAY（包含：WAIT_BUYER_PAY、TRADE_NO_CREATE_PAY） ALL_CLOSED（所有关闭订单）

fields - 需要返回的交易对象字段

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