Warehouse Service

Back

Overview

Warehouses represent physical storage locations where stock is held.

Each Warehouse defines:

• unique identifier code (Code)
• descriptive name (Name)
• optional address reference (AddressId)
• active status flag (IsActive)

Warehouses are used by Stock Items to define where products are physically stored and are required for all inventory operations. Each warehouse can hold multiple products, and products can exist in multiple warehouses.

All warehouse operations are tenant-aware and fully audited.

Endpoints

Back to Inventory

GET

/api/v1/Warehouse/GetAllWarehouse

Returns all warehouses regardless of active status.

Behavior:

• Returns a list of WarehouseModel
• Returns 200 with an empty list if no warehouses exist

Response:

• List<WarehouseModel>

Authorization:

• Requires Bearer Token

GET

/api/v1/Warehouse/GetAllWarehouseFilteredByActive?isActive={isActive}

Returns warehouses filtered by active status.

Query parameters:

• isActive (bool, required) - filter by active status

Behavior:

• Filters by IsActive flag
• Returns a list of WarehouseModel
• Returns 200 with an empty list if no warehouses match the filter

Response:

• List<WarehouseModel>

Authorization:

• Requires Bearer Token

GET

/api/v1/Warehouse/GetWarehouseById/{id}

Returns a single warehouse by its ID.

Route parameters:

• id (long, required)

Behavior:

• Looks up warehouse by Id
• Returns warehouse details if found

Errors:

• Returns 404 if warehouse does not exist

Response:

• WarehouseModel

Authorization:

• Requires Bearer Token

GET

/api/v1/Warehouse/GetWarehouseByCode/{code}

Returns a single warehouse by its unique code.

Route parameters:

• code (string, required)

Behavior:

• Looks up warehouse by Code
• Returns warehouse details if found

Errors:

• Returns 404 if warehouse does not exist

Response:

• WarehouseModel

Authorization:

• Requires Bearer Token

POST

/api/v1/Warehouse/AddNewWarehouse

Creates a new warehouse.

Request body (WarehouseModel):

• Code (string, required, must not be empty)
• Name (string, required, must not be empty)
• AddressId (long?, optional)
• IsActive (bool?, optional, defaults to false if not provided)

Behavior:

• Validation is enforced in the service layer (IsReadyToAdd())
• Prevents duplicates by enforcing uniqueness of Code
• Successful creation writes an audit log entry

Errors:

• Returns 400 if:
  • request body is invalid (IsReadyToAdd() is false)
  • warehouse with the same Code already exists
  • database insert - or other internal error occurs

Response:

• 200 OK with message: "New warehouse added"
• 400 Bad Request with message: "Add new warehouse failed"

Authorization:

• Requires Bearer Token

PUT

/api/v1/Warehouse/UpdateWarehouseById/{id}

Updates an existing warehouse.

Route parameters:

• id (long, required)

Request body (WarehouseModel):

• Code (string, optional)
• Name (string, optional)
• AddressId (long?, optional)
• IsActive (bool?, optional)

Behavior:

• The controller sets Id from the route
• Validation is enforced (IsReadyToUpdate() requires Id > 0, Code not empty, Name not empty)
• Updates only fields provided in body:
  • Code updated if not null or whitespace
  • Name updated if not null or whitespace
  • AddressId updated if not null
  • IsActive updated if not null (defaults to false if provided as null)
• Successful update writes an audit log entry

Errors:

• Returns 400 if:
  • request body is invalid (IsReadyToUpdate() is false)
  • warehouse does not exist

Response:

• 200 OK with message: "Update warehouse successful"
• 400 Bad Request with message: "Update warehouse failed"

Authorization:

• Requires Bearer Token

DELETE

/api/v1/Warehouse/DeleteWarehouseById/{id}

Deletes a warehouse by its ID.

Route parameters:

• id (long, required)

Behavior:

• Performs a hard delete
• Successful deletion writes an audit log entry

Errors:

• Returns 400 with message "Warehouse not found" if the warehouse does not exist

Response:

• 200 OK with message: "Warehouse deleted successfully"
• 400 Bad Request with message: "Warehouse not found"

Authorization:

• Requires Bearer Token

Notes

• Validation is enforced in the service layer, not via model attributes
• Code must be unique across all warehouses
• IsActive defaults to false if not provided during creation or update
• Deleting a warehouse does not cascade to related stock items (consider adding validation to prevent deletion if stock items exist)
• Internal errors are logged and not exposed to API consumers