Skip to main content

Warehouse Service

A Warehouse is a commercial space vital in the supply chain that is used to store finished goods and raw materials and is widely used in industries such as manufacturing and distribution.

Each warehouse keeps records that show stock movements, losses and balances at the warehouse.

Warehouse Object

Attributes


AttributeTypeDescription
activebooleanHas the value true if the warehouse is active or false if the warehouse is not active.
codestringWarehouse specific unique code.
idlongUnique identifier for the Warehouse.
locationLocationDtoLocation details.
namestringWarehouse Name.
primarybooleanHas the value true if the warehouse is primary or false if the warehouse is not primary.

API


List All Warehouse

Returns list of warehouse.

Parameters

Code

  @Autowired
private InventoryClient inventoryClient;

public List<WarehouseResponse> getWarehouseList(String accessToken){
return this.inventoryClient.getWarehouseList(accessToken);
}

Retrive Warehouse details by code

Retrieves the details of an existing warehouse. You need only supply the code that was returned upon warehouse creation.

Parameters

Code

  @Autowired
private InventoryClient inventoryClient;

public WarehouseResponse getWarehouseDetailsByCode(final String accessToken, final String code){
return this.inventoryClient.getWarehouseDetailsByCode(accessToken, code);
}

Retrive Warehouse Products

Retrieves the details of Warehouse details with available quantity by product codes. You need only supply the set<string> of product codes.

Parameters

Code

  @Autowired
private InventoryClient inventoryClient;

public WHProductResponse getWarehouseProducts(final String accessToken, final Set<String> productCodes){
return this.inventoryClient.getWarehouseProducts(accessToken, productCodes);
}

Retrive Active Warehouse Products

Retrieves the details of all active Warehouse details with product and available quantity.

Parameters

Code

  @Autowired
private InventoryClient inventoryClient;

public WHProductResponse getActiveWarehouseProducts(final String accessToken){
return this.inventoryClient.getActiveWarehouseProducts(accessToken);
}

Objects


LocationDto

AttributeTypeDescription
addresslistList of Address. Attribute for Address
idlongUnique identifier for the Location.
namestringName of location

Address

AttributeTypeDescription
address1stringAddress line 1
address2stringAddress line 2
citystringCity
countrystringCountry
postalCodestringPostal Code
preferredbooleanIs this a default address?

WHProductResponse

AttributeTypeDescription
warehouseslistList of warehouse and product details. Attribute for WarehouseShortInfo

WarehouseShortInfo

AttributeTypeDescription
codestringWarehouse specific unique code.
idlongUnique identifier for the Warehouse.
locationLocationDtoLocation details.
namestringWarehouse Name.
primarybooleanHas the value true if the warehouse is primary or false if the warehouse is not primary.
productAvailableQuantityMapProduct Code and Available quantity Map.