Package org.openwms.wms.inventory.api

Interface PackagingUnitApi

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

A PackagingUnitApi.

Author:

Heiko Scherrer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCEPT_HEADER_PU

Method Summary

Modifier and Type	Method	Description
void	create(String transportUnitBK, String luPos, String loadUnitType, CreatePURequestVO request)	Create a PackagingUnit in the existing LoadUnit with the given luPos within the TransportUnit identified by the transportUnitBK.
void	createOnLocation(PackagingUnitVO pu)	Create a new PackagingUnit on the Location given as actualLocation of the pu.
List<PackagingUnitVO>	findOfProductinLG(String productPKey, String locationGroupName)	Find and return all PackagingUnits that contain a Product identified by the given productPKey that is located within a particular LocationGroup identified by the given locationGroupName.
List<PackagingUnitVO>	findOnTU(String transportUnitBK)	Find and return all PackagingUnits that are booked on a TransportUnit identified by the given transportUnitBK.

Field Details

ACCEPT_HEADER_PU

static final String ACCEPT_HEADER_PU

See Also:

• Constant Field Values

Method Details

create

@PostMapping(value="/v1/transport-units/{transportUnitBK}/load-units/{luPos}/packaging-units",
             params="loadUnitType")
void create(@PathVariable("transportUnitBK")
 String transportUnitBK,
 @PathVariable("luPos")
 String luPos,
 @RequestParam("loadUnitType")
 String loadUnitType,
 @RequestBody
 CreatePURequestVO request)

Create a PackagingUnit in the existing LoadUnit with the given luPos within the TransportUnit identified by the transportUnitBK. If the LoadUnit is not defined, a new LoadUnit of the given loadUnitType is created.

Parameters:

transportUnitBK - The business key of the TransportUnit

luPos - The LoadUnit position

loadUnitType - The LoadUnit type in case the LoadUnit is created

request - Contains additional information about the PackagingUnit to create

createOnLocation

@PostMapping("/v1/packaging-units")
void createOnLocation(@RequestBody
 PackagingUnitVO pu)

Create a new PackagingUnit on the Location given as actualLocation of the pu.

Parameters:

pu - The PackagingUnit representation, contains the Location where to create it

findOnTU

@GetMapping("/v1/transport-units/{transportUnitBK}/load-units/packaging-units")
List<PackagingUnitVO> findOnTU(@PathVariable("transportUnitBK")
 String transportUnitBK)

Find and return all PackagingUnits that are booked on a TransportUnit identified by the given transportUnitBK.

Parameters:

transportUnitBK - The business key of the TransportUnit

Returns:

A list of PackagingUnits

findOfProductinLG

@GetMapping(value="/v1/packaging-units",
            params={"productPKey","locationGroupName"})
List<PackagingUnitVO> findOfProductinLG(@RequestParam("productPKey")
 String productPKey,
 @RequestParam("locationGroupName")
 String locationGroupName)

Find and return all PackagingUnits that contain a Product identified by the given productPKey that is located within a particular LocationGroup identified by the given locationGroupName.

Parameters:

productPKey - The Product persistent key

locationGroupName - The identifying name of the LocationGroup

Returns:

A list of PackagingUnits