Package org.openwms.wms.receiving.api

Interface ReceivingApi

@FeignClient(name="wms-receiving",
             qualifiers="receivingApi")
public interface ReceivingApi

A ReceivingApi.

Author:

Heiko Scherrer

Method Summary

Modifier and Type	Method	Description
void	cancelOrder(String pKey)	Cancel an existing ReceivingOrder.
void	captureOrder(String pKey, CaptureRequestVO request)	Execute the process of capturing a Goods Receipt.
ReceivingOrderVO	changeOrder(String pKey, ReceivingOrderVO order)	Update an existing ReceivingOrder.
void	createOrder(ReceivingOrderVO order)	Create a new ReceivingOrder.

Method Details

createOrder

@PostMapping("/v1/receiving-orders")
void createOrder(@RequestBody
 ReceivingOrderVO order)

Create a new ReceivingOrder.

Parameters:

order - The ReceivingOrder representation

changeOrder

@PutMapping("/v1/receiving/{pKey}")
ReceivingOrderVO changeOrder(@PathVariable("pKey")
 String pKey,
 @RequestBody
 ReceivingOrderVO order)

Update an existing ReceivingOrder.

Parameters:

pKey - The persistent identifier of the ReceivingOrder to change

order - The ReceivingOrder representation with the modified values

Returns:

The updated instance

captureOrder

@PostMapping("/v1/receiving-orders/{pKey}/capture")
void captureOrder(@PathVariable("pKey")
 String pKey,
 @RequestBody
 CaptureRequestVO request)

Execute the process of capturing a Goods Receipt.

Parameters:

pKey - The persistent identifier of the ReceivingOrder the capture targets on

request - Required capture request data

cancelOrder

@DeleteMapping("/v1/receiving-orders/{pKey}")
void cancelOrder(@PathVariable("pKey")
 String pKey)

Cancel an existing ReceivingOrder.

Parameters:

pKey - The persistent identifier of the ReceivingOrder