Package pl.grizzlysoftware.dotykacka.client.v2.service

Interface WarehouseService

public interface WarehouseService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<java.util.Collection<Warehouse>>	createWarehouses(java.util.Collection<Warehouse> warehouses)
retrofit2.Call<Warehouse>	deleteWarehouse(java.lang.Long warehouseId)
retrofit2.Call<ProductStock>	getProductStockById(java.lang.Long warehouseId, java.lang.Long productId)
retrofit2.Call<java.util.Collection<ProductStock>>	getProductStocks(java.lang.Long warehouseId)
retrofit2.Call<Warehouse>	getWarehouse(java.lang.Long warehouseId)
retrofit2.Call<ResultPage<Warehouse>>	getWarehouses(int page, int limit, java.lang.String filter, java.lang.String sort)
retrofit2.Call<Warehouse>	patchWarehouse(java.lang.Long warehouseId, Warehouse warehouse)
retrofit2.Call<com.fasterxml.jackson.databind.JsonNode>	sales(java.lang.Long warehouseId, WarehouseItemSale body)
retrofit2.Call<com.fasterxml.jackson.databind.JsonNode>	stockup(java.lang.Long warehouseId, WarehouseStockUp body)
retrofit2.Call<com.fasterxml.jackson.databind.JsonNode>	transfer(java.lang.Long warehouseId, WarehouseTransfer body)
retrofit2.Call<Warehouse>	updateWarehouse(java.lang.Long warehouseId, Warehouse warehouse)
retrofit2.Call<java.util.Collection<Warehouse>>	updateWarehouses(java.util.Collection<Warehouse> warehouses)

Method Detail

createWarehouses

@POST(" ")
retrofit2.Call<java.util.Collection<Warehouse>> createWarehouses(@Body
                                                                 java.util.Collection<Warehouse> warehouses)

Parameters:

warehouses - - warehouses to be created

Returns:

Warehouses

updateWarehouses

@PUT(" ")
retrofit2.Call<java.util.Collection<Warehouse>> updateWarehouses(@Body
                                                                 java.util.Collection<Warehouse> warehouses)

Parameters:

warehouses - - warehouses to be created or updated

Returns:

Warehouses

updateWarehouse

@PUT("{warehouseId}")
retrofit2.Call<Warehouse> updateWarehouse(@Path("warehouseId")
                                          java.lang.Long warehouseId,
                                          @Body
                                          Warehouse warehouse)

Parameters:

warehouseId - - warehouse id

warehouse - - warehouse to be updated

Returns:

Warehouse

patchWarehouse

@PATCH("{warehouseId}")
retrofit2.Call<Warehouse> patchWarehouse(@Path("warehouseId")
                                         java.lang.Long warehouseId,
                                         @Body
                                         Warehouse warehouse)

Parameters:

warehouseId - - warehouse id

warehouse - - warehouse to be patched

Returns:

Warehouse

deleteWarehouse

@DELETE("{warehouseId}")
retrofit2.Call<Warehouse> deleteWarehouse(@Path("warehouseId")
                                          java.lang.Long warehouseId)

Parameters:

warehouseId - - warehouse id

Returns:

Warehouse

getWarehouse

@GET("{warehouseId}")
retrofit2.Call<Warehouse> getWarehouse(@Path("warehouseId")
                                       java.lang.Long warehouseId)

Parameters:

warehouseId - - warehouseId id

Returns:

Warehouse

getWarehouses

@GET(" ")
retrofit2.Call<ResultPage<Warehouse>> getWarehouses(@Query("page")
                                                    int page,
                                                    @Query("limit")
                                                    int limit,
                                                    @Query("filter")
                                                    java.lang.String filter,
                                                    @Query("sort")
                                                    java.lang.String sort)

Parameters:

page - - pagination parameter, default = 1

limit - - pagination parameter, default = 100, max = 100

filter - - query filter

sort - - Description: Sort parameters in format: column_name1,column_name2 //means asc -column_name1,-column_name2 //means desc

Returns:

Warehouses

getProductStocks

@GET("{warehouseId}/products")
retrofit2.Call<java.util.Collection<ProductStock>> getProductStocks(@Path("warehouseId")
                                                                    java.lang.Long warehouseId)

Parameters:

warehouseId - - warehouse from which product stocks should be fetched

Returns:

Product stock

getProductStockById

@GET("{warehouseId}/products/{productId}")
retrofit2.Call<ProductStock> getProductStockById(@Path("warehouseId")
                                                 java.lang.Long warehouseId,
                                                 @Path("productId")
                                                 java.lang.Long productId)

Parameters:

warehouseId - - warehouse from which product stock should be fetched

productId - - id of product for which stock should be fetched

Returns:

Product stock

stockup

@POST("{warehouseId}/stockups")
retrofit2.Call<com.fasterxml.jackson.databind.JsonNode> stockup(@Path("warehouseId")
                                                                java.lang.Long warehouseId,
                                                                @Body
                                                                WarehouseStockUp body)

Parameters:

warehouseId - - warehouse to which stocks should be filled

body - - stock up data

Returns:

stock up id

transfer

@POST("{warehouseId}/transfer")
retrofit2.Call<com.fasterxml.jackson.databind.JsonNode> transfer(@Path("warehouseId")
                                                                 java.lang.Long warehouseId,
                                                                 @Body
                                                                 WarehouseTransfer body)

Parameters:

warehouseId - - warehouse to which stocks should be transfered

body - - transfer data

Returns:

transfer id

sales

@POST("{warehouseId}/transfer")
retrofit2.Call<com.fasterxml.jackson.databind.JsonNode> sales(@Path("warehouseId")
                                                              java.lang.Long warehouseId,
                                                              @Body
                                                              WarehouseItemSale body)

Parameters:

warehouseId - - warehouse in which products should be put on sale

body - - product sale data

Returns:

sale id