Add Item Retrieval by Name and Enhance Item Data Response

[PramithaMJ]

Pull Request: Add Item Retrieval by Name and Enhance Item Data Response

Title

Enhance Item Retrieval and Response Structure for Items

Description

This pull request introduces enhancements to the item retrieval functionality and updates the response structure for item-related endpoints. Specifically, it adds the capability to retrieve items by name and includes additional fields in the item response structure to provide more comprehensive details about each item.

Changes Made

New Endpoint:

• GET /lifepill/v1/item/get-by-name:
  • Retrieves a list of items by their name.
  • Example URL: http://localhost:8081/lifepill/v1/item/get-by-name/?itemName=Sampl22
  • Response structure:

    [
    {
      "itemId": 309,
      "branchId": 3,
      "itemName": "Sampl22",
      "sellingPrice": 100.0,
      "itemBarCode": "1234567890123",
      "supplyDate": "2023-05-18T00:00:00.000+00:00",
      "supplierPrice": 80.0,
      "itemManufacture": "Manufacturer Name",
      "itemQuantity": 50.0,
      "itemCategoryName": null,
      "measuringUnitType": "CAPSULE",
      "manufactureDate": "2023-04-01T00:00:00.000+00:00",
      "expireDate": "2024-04-01T00:00:00.000+00:00",
      "purchaseDate": "2023-05-15T00:00:00.000+00:00",
      "warrantyPeriod": "12 months",
      "rackNumber": "A1",
      "discountedPrice": 90.0,
      "discountedPercentage": 10.0,
      "warehouseName": "Main Warehouse",
      "itemImage": "http://example.com/image.jpg",
      "itemDescription": "This is a sample item description.",
      "freeIssued": false,
      "discounted": false,
      "specialCondition": false,
      "stock": false
    },
    {
      "itemId": 311,
      "branchId": 3,
      "itemName": "Sampl22",
      "sellingPrice": 100.0,
      "itemBarCode": "1234567890123",
      "supplyDate": "2023-05-18T00:00:00.000+00:00",
      "supplierPrice": 80.0,
      "itemManufacture": "Manufacturer Name",
      "itemQuantity": 50.0,
      "itemCategoryName": null,
      "measuringUnitType": "CAPSULE",
      "manufactureDate": "2023-04-01T00:00:00.000+00:00",
      "expireDate": "2024-04-01T00:00:00.000+00:00",
      "purchaseDate": "2023-05-15T00:00:00.000+00:00",
      "warrantyPeriod": "12 months",
      "rackNumber": "A1",
      "discountedPrice": 90.0,
      "discountedPercentage": 10.0,
      "warehouseName": "Main Warehouse",
      "itemImage": "http://example.com/image.jpg",
      "itemDescription": "This is a sample item description.",
      "freeIssued": false,
      "discounted": false,
      "specialCondition": false,
      "stock": false
    }
    ]

Enhanced Endpoint:

• GET /lifepill/v1/item/get-all-items:
  • Retrieves a list of all items.
  • Response structure:

    {
    "code": 201,
    "message": "SUCCESS",
    "data": [
        {
            "itemId": 19,
            "brandId": 3,
            "itemName": "Item 9",
            "sellingPrice": 50.99,
            "itemBarCode": "901234567890",
            "supplyDate": "2024-04-11T18:30:00.000+00:00",
            "supplierPrice": 48.99,
            "itemManufacture": "Manufacturer I",
            "itemQuantity": 419.0,
            "itemCategoryName": "Vitamins and Supplements",
            "itemCategoryId": 4,
            "measuringUnitType": "GRAM",
            "manufactureDate": "2023-08-31T18:30:00.000+00:00",
            "expireDate": "2025-08-31T18:30:00.000+00:00",
            "purchaseDate": "2024-04-11T18:30:00.000+00:00",
            "warrantyPeriod": "9 years",
            "rackNumber": "I9",
            "discountedPrice": 49.99,
            "discountedPercentage": 50.0,
            "warehouseName": "Warehouse I",
            "itemImage": "item9_image.jpg",
            "itemDescription": "Description for Item 9",
            "freeIssued": true,
            "discounted": false,
            "specialCondition": false,
            "stock": true
        }
    ]
    }

Test Plan

• Unit Tests: Ensure that the unit tests cover all new and existing functionality related to item retrieval and response.
• Integration Tests: Verify that the new and enhanced endpoints return the correct data in the expected format.
• Manual Testing: Manually test the endpoints using tools like Postman to confirm that they return the expected results.

Conclusion

These changes improve the application's item management capabilities, providing more detailed information about items and enhancing the user experience when retrieving item data. Your feedback on these changes is appreciated.

Best regards, Pramitha Jayasooriya Backend Developer at LifePill https://pramithamj.me