cn.binarywang.wx.miniapp.api

接口 WxMaExpressService

所有已知实现类:

WxMaExpressServiceImpl

public interface WxMaExpressService

小程序物流助手

从以下版本开始:

2019-11-26

作者:

xiaoyu

字段概要

字段

限定符和类型	字段和说明
static String	ADD_ORDER_URL 生成运单
static String	ALL_ACCOUNT_URL 获取所有绑定的物流账号
static String	ALL_DELIVERY_URL 获取支持的快递公司列表
static String	BATCH_GET_ORDER_URL 批量获取运单数据
static String	BIND_ACCOUNT_URL 绑定、解绑物流账号
static String	CANCEL_ORDER_URL 取消运单
static String	GET_ORDER_URL 获取运单数据
static String	GET_PATH_URL 查询运单轨迹
static String	GET_PRINTER_URL 获取打印员
static String	GET_QUOTA_URL 获取电子面单余额
static String	TEST_UPDATE_ORDER_URL 模拟快递公司更新订单状态
static String	UPDATE_PRINTER_URL 配置面单打印员

方法概要

限定符和类型	方法和说明
WxMaExpressOrderInfoResult	addOrder(WxMaExpressAddOrderRequest wxMaExpressAddOrderRequest) 生成运单
List<WxMaExpressOrderInfoResult>	batchGetOrder(List<WxMaExpressGetOrderRequest> requests) 批量获取运单数据
void	bindAccount(WxMaExpressBindAccountRequest wxMaExpressBindAccountRequest) 绑定、解绑物流账号
void	cancelOrder(WxMaExpressGetOrderRequest wxMaExpressGetOrderRequest) 取消运单
List<WxMaExpressAccount>	getAllAccount() 获取所有绑定的物流账号
List<WxMaExpressDelivery>	getAllDelivery() 获取支持的快递公司列表
WxMaExpressOrderInfoResult	getOrder(WxMaExpressGetOrderRequest wxMaExpressGetOrderRequest) 获取运单数据
WxMaExpressPath	getPath(WxMaExpressGetOrderRequest wxMaExpressGetOrderRequest) 查询运单轨迹
WxMaExpressPrinter	getPrinter() 获取打印员。
Integer	getQuota(WxMaExpressBindAccountRequest wxMaExpressBindAccountRequest) 获取电子面单余额。
void	testUpdateOrder(WxMaExpressTestUpdateOrderRequest wxMaExpressTestUpdateOrderRequest) 模拟快递公司更新订单状态, 该接口只能用户测试
void	updatePrinter(WxMaExpressPrinterUpdateRequest wxMaExpressPrinterUpdateRequest) 配置面单打印员，可以设置多个，若需要使用微信打单 PC 软件，才需要调用。

字段详细资料

ALL_DELIVERY_URL

static final String ALL_DELIVERY_URL

获取支持的快递公司列表

另请参阅:

常量字段值

ALL_ACCOUNT_URL

static final String ALL_ACCOUNT_URL

获取所有绑定的物流账号

另请参阅:

常量字段值

BIND_ACCOUNT_URL

static final String BIND_ACCOUNT_URL

绑定、解绑物流账号

另请参阅:

常量字段值

GET_QUOTA_URL

static final String GET_QUOTA_URL

获取电子面单余额

另请参阅:

常量字段值

UPDATE_PRINTER_URL

static final String UPDATE_PRINTER_URL

配置面单打印员

另请参阅:

常量字段值

GET_PRINTER_URL

static final String GET_PRINTER_URL

获取打印员

另请参阅:

常量字段值

ADD_ORDER_URL

static final String ADD_ORDER_URL

生成运单

另请参阅:

常量字段值

BATCH_GET_ORDER_URL

static final String BATCH_GET_ORDER_URL

批量获取运单数据

另请参阅:

常量字段值

CANCEL_ORDER_URL

static final String CANCEL_ORDER_URL

取消运单

另请参阅:

常量字段值

GET_ORDER_URL

static final String GET_ORDER_URL

获取运单数据

另请参阅:

常量字段值

GET_PATH_URL

static final String GET_PATH_URL

查询运单轨迹

另请参阅:

常量字段值

TEST_UPDATE_ORDER_URL

static final String TEST_UPDATE_ORDER_URL

模拟快递公司更新订单状态

另请参阅:

常量字段值

方法详细资料

getAllDelivery

List<WxMaExpressDelivery> getAllDelivery()
                                  throws WxErrorException

获取支持的快递公司列表

返回:

快递公司列表

抛出:

WxErrorException - 获取失败时返回

   查看文档
 

getAllAccount

List<WxMaExpressAccount> getAllAccount()
                                throws WxErrorException

获取所有绑定的物流账号

返回:

物流账号list

抛出:

WxErrorException - 获取失败时返回

   查看文档
 

bindAccount

void bindAccount(WxMaExpressBindAccountRequest wxMaExpressBindAccountRequest)
          throws WxErrorException

绑定、解绑物流账号

参数:

wxMaExpressBindAccountRequest - 物流账号对象

抛出:

WxErrorException - 请求失败时返回

   查看文档
 

getQuota

Integer getQuota(WxMaExpressBindAccountRequest wxMaExpressBindAccountRequest)
          throws WxErrorException

获取电子面单余额。仅在使用加盟类快递公司时，才可以调用。

参数:

wxMaExpressBindAccountRequest - 物流账号对象

返回:

电子面单余额

抛出:

WxErrorException - 获取失败时返回

   查看文档
 

updatePrinter

void updatePrinter(WxMaExpressPrinterUpdateRequest wxMaExpressPrinterUpdateRequest)
            throws WxErrorException

配置面单打印员，可以设置多个，若需要使用微信打单 PC 软件，才需要调用。

参数:

wxMaExpressPrinterUpdateRequest - 面单打印员对象

抛出:

WxErrorException - 请求失败时返回

   查看文档
 

getPrinter

WxMaExpressPrinter getPrinter()
                       throws WxErrorException

获取打印员。若需要使用微信打单 PC 软件，才需要调用

返回:

打印员

抛出:

WxErrorException - 获取失败时返回

   查看文档
 

addOrder

WxMaExpressOrderInfoResult addOrder(WxMaExpressAddOrderRequest wxMaExpressAddOrderRequest)
                             throws WxErrorException

生成运单

参数:

wxMaExpressAddOrderRequest - 生成运单请求对象

返回:

生成运单结果

抛出:

WxErrorException - 请求失败时返回

   查看文档
 

batchGetOrder

List<WxMaExpressOrderInfoResult> batchGetOrder(List<WxMaExpressGetOrderRequest> requests)
                                        throws WxErrorException

批量获取运单数据

参数:

requests - 获取运单请求对象集合，最多不能超过1000个

返回:

运单信息集合

抛出:

WxErrorException - 获取失败时返回

   查看文档
 

cancelOrder

void cancelOrder(WxMaExpressGetOrderRequest wxMaExpressGetOrderRequest)
          throws WxErrorException

取消运单

参数:

wxMaExpressGetOrderRequest - 运单信息请求对象

抛出:

WxErrorException - 取消失败时返回

   查看文档
 

getOrder

WxMaExpressOrderInfoResult getOrder(WxMaExpressGetOrderRequest wxMaExpressGetOrderRequest)
                             throws WxErrorException

获取运单数据

参数:

wxMaExpressGetOrderRequest - 运单信息请求对象

返回:

运单信息

抛出:

WxErrorException - 获取失败时返回

   查看文档
 

getPath

WxMaExpressPath getPath(WxMaExpressGetOrderRequest wxMaExpressGetOrderRequest)
                 throws WxErrorException

查询运单轨迹

参数:

wxMaExpressGetOrderRequest - 运单信息请求对象

返回:

运单轨迹对象

抛出:

WxErrorException - 查询失败时返回

   查看文档
 

testUpdateOrder

void testUpdateOrder(WxMaExpressTestUpdateOrderRequest wxMaExpressTestUpdateOrderRequest)
              throws WxErrorException

模拟快递公司更新订单状态, 该接口只能用户测试

参数:

wxMaExpressTestUpdateOrderRequest - 模拟快递公司更新订单状态请求对象

抛出:

WxErrorException - 模拟更新订单状态失败时返回

   查看文档