me.chanjar.weixin.channel.api.WxChannelWarehouseService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weixin-java-channel Show documentation
微信视频号/微信小店 Java SDK
There is a newer version: 4.7.1.B
package me.chanjar.weixin.channel.api;


import java.util.List;
import me.chanjar.weixin.channel.bean.base.WxChannelBaseResponse;
import me.chanjar.weixin.channel.bean.warehouse.LocationPriorityResponse;
import me.chanjar.weixin.channel.bean.warehouse.PriorityLocationParam;
import me.chanjar.weixin.channel.bean.warehouse.WarehouseIdsResponse;
import me.chanjar.weixin.channel.bean.warehouse.WarehouseLocation;
import me.chanjar.weixin.channel.bean.warehouse.WarehouseParam;
import me.chanjar.weixin.channel.bean.warehouse.WarehouseResponse;
import me.chanjar.weixin.channel.bean.warehouse.WarehouseStockParam;
import me.chanjar.weixin.channel.bean.warehouse.WarehouseStockResponse;
import me.chanjar.weixin.common.error.WxErrorException;


/**
 * 视频号小店 区域仓库服务
 *
 * @author Zeyes
 */
public interface WxChannelWarehouseService {

  /**
   * 创建仓库
   *
   * @param param 仓库信息
   * @return 响应
   *
   * @throws WxErrorException 异常
   */
  WxChannelBaseResponse createWarehouse(WarehouseParam param) throws WxErrorException;

  /**
   * 查询仓库列表
   *
   * @param pageSize 每页数量（最大不超过10）
   * @param nextKey  由上次请求返回，记录翻页的上下文。传入时会从上次返回的结果往后翻一页，不传默认拉取第一页数据
   * @return 响应
   *
   * @throws WxErrorException 异常
   */
  WarehouseIdsResponse listWarehouse(Integer pageSize, String nextKey) throws WxErrorException;

  /**
   * 获取仓库详情
   *
   * @param outWarehouseId 外部仓库ID
   * @return 响应
   *
   * @throws WxErrorException 异常
   */
  WarehouseResponse getWarehouse(String outWarehouseId) throws WxErrorException;

  /**
   * 修改仓库详情
   *
   * @param outWarehouseId 外部仓库ID
   * @param name           仓库名称
   * @param intro          仓库介绍
   * @return 响应
   *
   * @throws WxErrorException 异常
   */
  WxChannelBaseResponse updateWarehouse(String outWarehouseId, String name, String intro) throws WxErrorException;

  /**
   * 批量增加覆盖区域
   *
   * @param outWarehouseId 外部仓库ID
   * @param coverLocations 覆盖区域
   * @return 响应
   *
   * @throws WxErrorException 异常
   */
  WxChannelBaseResponse addWarehouseArea(String outWarehouseId, List coverLocations)
    throws WxErrorException;

  /**
   * 批量删除覆盖区域
   *
   * @param outWarehouseId 外部仓库ID
   * @param coverLocations 覆盖区域
   * @return 响应
   *
   * @throws WxErrorException 异常
   */
  WxChannelBaseResponse deleteWarehouseArea(String outWarehouseId, List coverLocations)
    throws WxErrorException;

  /**
   * 设置指定地址下的仓的优先级
   *
   * @param param 参数
   * @return 响应
   *
   * @throws WxErrorException 异常
   */
  WxChannelBaseResponse setWarehousePriority(PriorityLocationParam param) throws WxErrorException;

  /**
   * 获取指定地址下的仓的优先级
   *
   * @param addressId1 省份地址编码
   * @param addressId2 市地址编码
   * @param addressId3 区地址编码
   * @param addressId4 街道地址编码
   * @return 仓的优先级
   *
   * @throws WxErrorException 异常
   */
  LocationPriorityResponse getWarehousePriority(Integer addressId1, Integer addressId2, Integer addressId3,
    Integer addressId4) throws WxErrorException;

  /**
   * 更新区域仓库存数量
   *
   * @param param 参数
   * @return 响应
   *
   * @throws WxErrorException 异常
   */
  WxChannelBaseResponse updateWarehouseStock(WarehouseStockParam param) throws WxErrorException;

  /**
   * 获取区域仓库存数量
   *
   * @param productId      商品ID
   * @param outWarehouseId 外部仓库ID
   * @param skuId          商品skuId
   * @return 响应
   *
   * @throws WxErrorException 异常
   */
  WarehouseStockResponse getWarehouseStock(String productId, String skuId, String outWarehouseId)
    throws WxErrorException;
}