mhinspeya/module-appoutfit

MHinspeya AppOutfit

1.0.0 2026-05-26 13:07 UTC

Requires

• mhinspeya/backend-mod: ^1.0

Suggests

• mhinspeya/backend-mod: Support Configuration

OSL-3.0

• MHinspeya

• magento
• magento 2
• MHinspeya

README

mhinspeya/module-appoutfit

• Main Functionalities
• Installation
• Configuration
• REST API Endpoints Reference

Main Functionalities

MHinspeya AppOutfit enables creation, deletion, update, and management of outfit categories and products via REST API, including base64 image decoding/saving and dynamic MGZ Pagebuilder block generation.

Installation

Type 1: Zip file

1. Unzip the zip file in app/code/MHinspeya
2. Enable the module by running php bin/magento module:enable MHinspeya_AppOutfit
3. Apply database updates by running php bin/magento setup:upgrade
4. Flush the cache by running php bin/magento cache:flush

Type 2: Composer

1. Install the module composer by running composer require mhinspeya/module-appoutfit
2. Enable the module by running php bin/magento module:enable MHinspeya_AppOutfit
3. Apply database updates by running php bin/magento setup:upgrade
4. Flush the cache by running php bin/magento cache:flush

Configuration

Access the settings under Inspeya > AppOutfit > Configuration in the Magento Admin Panel.

• Enable AppOutfit on the Frontend: Toggle module frontend features.
• User Name & Admin Password: Credentials used for API tokens.
• Category Name: Select the root category under which outfit categories are created.

REST API Endpoints Reference

All endpoints are configured with <resource ref="anonymous"/> and can be accessed under /rest/V1/...

1. Get Outfit Categories

• URL: /V1/outfit-category/getOutfitCategories/
• Method: GET
• Description: Returns all categories and subcategories defined under the root Outfit category.
• Payload: None.
• Response: JSON array of category list metadata.

2. Get Products of an Outfit Category

• URL: /V1/outfit-category/getOutfitCategoryProduct/:catid
• Method: GET
• Path Parameters:
  • catid (string/integer): The category ID of the outfit.
• Description: Returns all products assigned to the specified category ID.
• Response:

  [
    {
      "product_id": "1234",
      "productName": "Example Product",
      "description": "Product Description",
      "shortdescription": "Short Description",
      "image": "https://image-url.com/media.jpg",
      "sku": "product-sku",
      "ean": "product-ean",
      "special_price": 0.00,
      "price": 49.99,
      "type_id": "simple",
      "is_sale": 0,
      "is_new": 1,
      "brand_name": "Brand"
    }
  ]
  

3. Create Outfit Category

• URL: /V1/outfit-category/getCreatOutfitCategory/
• Method: POST
• Description: Creates or updates an outfit category along with its images and landing page block layout.
• Headers: Content-Type: application/json
• Payload (JSON):

  {
    "OutfitName": "Summer Casual",
    "category_description": "A stylish summer casual collection.",
    "category_image": "data:image/jpeg;base64,...",
    "thumbnail_image": "data:image/jpeg;base64,...",
    "vertical_image_outfit": "data:image/jpeg;base64,...",
    "Outfit_Image_1": "data:image/jpeg;base64,...",
    "Outfit_Image_2": "data:image/jpeg;base64,...",
    "Outfit_Image_3": "data:image/jpeg;base64,...",
    "Outfit_Image_4": "data:image/jpeg;base64,...",
    "Outfit_Image_5": "data:image/jpeg;base64,..."
  }
  

• Response:

  [
    {
      "status": "Category is Created!",
      "category_id": 456
    }
  ]
  

4. Assign Products to Category

• URL: /V1/outfit-category/getOutfitAssignedProduct/
• Method: POST
• Headers: Content-Type: application/json
• Payload (JSON):

  {
    "category_id": "456",
    "products_ean": "ean1,ean2,ean3"
  }
  

• Response:

  [
    {
      "status": true,
      "message": "Products are assigned to Category Id: 456"
    }
  ]
  

5. Remove Products from Category

• URL: /V1/outfit-category/getOutfitDeletedProduct/
• Method: POST
• Headers: Content-Type: application/json
• Payload (JSON):

  {
    "category_id": "456",
    "products_ean": "ean1,ean2"
  }
  

• Response:

  [
    {
      "status": true,
      "message": "Products is deleted from the Category Id: 456"
    }
  ]
  

6. Delete Outfit Category

• URL: /V1/outfit-category/getOutfitDeletedCategory/
• Method: DELETE
• Headers: Content-Type: application/json
• Payload (JSON):

  {
    "category_id": "456"
  }
  

• Response:

  [
    {
      "status": "true",
      "message": "Category Id: 456 is deleted from the Shop"
    }
  ]
  

7. Update Outfit Category

• URL: /V1/outfit-category/getOutfitUpdateCategory/
• Method: POST
• Headers: Content-Type: application/json
• Payload (JSON):

  {
    "category_id": "456",
    "category_name": "Summer Casual Updated",
    "category_description": "Updated Description",
    "category_image": "data:image/jpeg;base64,...",
    "thumbnail_image": "data:image/jpeg;base64,...",
    "vertical_image_outfit": "data:image/jpeg;base64,...",
    "Outfit_Image_1": "data:image/jpeg;base64,...",
    "Outfit_Image_2": "data:image/jpeg;base64,...",
    "Outfit_Image_3": "data:image/jpeg;base64,...",
    "Outfit_Image_4": "data:image/jpeg;base64,...",
    "Outfit_Image_5": "data:image/jpeg;base64,...",
    "assigned_products": "ean1,ean2",
    "deleted_products": "ean3"
  }
  

• Response: Returns the updated category properties and absolute file URLs for all outfit images.

8. Product Scanner Data

• URL: /V1/outfit-category/getProductScannerData/
• Method: POST
• Headers: Content-Type: application/json
• Payload (JSON):

  {
    "ean": "4005900000000"
  }
  

• Response: Scan validation and details data.

9. Get Public Outfit Categories

• URL: /V1/outfit/public
• Method: POST
• Description: Returns all public/published categories for AppOutfit.
• Payload: Filters or empty json {}.
• Response: List of public category models.

10. Get Private Outfit Categories

• URL: /V1/outfit/private
• Method: POST
• Description: Returns private/restricted categories for AppOutfit.
• Payload: Filters or empty json {}.
• Response: List of private category models.