Package org.openwms.wms.inventory.api

Interface ProductApi

@FeignClient(name="wms-inventory",
             qualifiers="productApi",
             decode404=true)
public interface ProductApi

A ProductApi.

Author:

Heiko Scherrer

Method Summary

Modifier and Type	Method	Description
void	create(List<ProductVO> products)	Create new Products.
List<ProductVO>	findAll()	Find and return all existing Products.
ProductVO	findBySKU(String sku)	Find and return an existing Product.
ProductVO	findBySKUandUOM(String sku, String uom)	Find and return an existing Product.

Method Details

findAll

@GetMapping("/v1/products")
List<ProductVO> findAll()

Find and return all existing Products.

Returns:

A list of products, never null

findBySKU

@GetMapping(value="/v1/products",
            params="sku")
ProductVO findBySKU(@RequestParam("sku")
 String sku)

Find and return an existing Product.

Parameters:

sku - The Products SKU

Returns:

The instance or a 404-NOT FOUND is returned

findBySKUandUOM

@GetMapping(value="/v1/products",
            params={"sku","uom"})
ProductVO findBySKUandUOM(@RequestParam("sku")
 String sku,
 @RequestParam("uom")
 String uom)

Find and return an existing Product.

Parameters:

sku - The Products SKU

uom - The UOM to search for

Returns:

The instance or a 404-NOT FOUND is returned

create

@PostMapping("/v1/products")
void create(@RequestBody
 List<ProductVO> products)

Create new Products.

Parameters:

products - A list of all products to create