Package org.openwms.wms.shipping.api

Interface ShippingApi

@FeignClient(name="wms-shipping", qualifiers="shippingApi") public interface ShippingApi
A ShippingApi.
Author:
Heiko Scherrer

  • Field Details

  • Method Details

    • createOrder

      @PostMapping("/v1/shipping-orders") void createOrder(@NotNull @RequestBody @NotNull ShippingOrderVO shippingOrder)
      Create a new ShippingOrder.
      Parameters:
      shippingOrder - The order instance to create

    • findInStates

      @GetMapping(value="/v1/shipping-orders", params="states") List<ShippingOrderVO> findInStates(@NotNull @RequestParam("states") @NotNull List<String> states)
      Find and return all ShippingOrders in one of the given states.
      Parameters:
      states - The states to search for
      Returns:
      An (empty) list of orders never null

    • findByPKey

      @GetMapping("/v1/shipping-orders/{pKey}") ShippingOrderVO findByPKey(@NotNull @PathVariable("pKey") @NotNull String pKey)
      Find and return a ShippingOrder.
      Parameters:
      pKey - The persistent key of the ShippingOrder
      Returns:
      The instance

    • findByOrderId

      @GetMapping(value="/v1/shipping-orders", params="orderId") ShippingOrderVO findByOrderId(@RequestParam("orderId") String orderId)

    • findByPositionPKey

      @GetMapping("/v1/shipping-order-positions/{pKey}") ShippingOrderVO findByPositionPKey(@PathVariable("pKey") String pKey)
      Find and return the ShippingOrder that belongs to the ShippingOrderPosition.
      Parameters:
      pKey - The persistent key of the ShippingOrderPosition
      Returns:
      The instance

    • updatePositionPartially

      @PatchMapping("/v1/shipping-order-positions/{pKey}") ShippingOrderPositionVO updatePositionPartially(@PathVariable("pKey") String pKey, @RequestBody ShippingOrderPositionVO shippingOrderPosition)
      Update single fields of a ShippingOrderPosition.
      Parameters:
      pKey - The persistent key of the ShippingOrderPosition to change
      shippingOrderPosition - The partial structure
      Returns:
      The updated representation