mhinspeya / module-checksizeapi

1.0.3 2026-10-20 12:36 UTC

Requires

• php: ^8.2 || ^8.3 || ^8.4
• mhinspeya/backend-mod: ^1.0.2

Suggests

• mhinspeya/backend-mod: Support Configuration

OSL-3.0

• MHinspeya

• inventory
• magento
• magento 2
• omnichannel
• MHinspeya
• php 8.4
• Magento 2.4.8
• stock recovery

Published on Packagist.org on 2026-10-20 12:37 UTC

README

The MHinspeya_CheckSizeAPI module integrates your Magento 2 store with the Modehaus.de API to recover lost sales from out-of-stock variations and provide local omnichannel physical store stock information.

Business-Level Overview

This module is designed to solve customer friction caused by out-of-stock sizes or colors on the storefront, driving conversion rates and offline store traffic.

1. External Stock Recovery (Partner Network Integration)

   • When a customer views a product page where their preferred size or color is sold out, the module connects in real-time to the Modehaus.de API (using the product's EAN or SKU).
   • It fetches availability from the partner network and lists alternative sizes available on Modehaus.de.

2. Omnichannel Store Availability (BOPIS / Click-and-Collect)

   • Under the "Buy directly on site / Vor Ort direkt kaufen" section, the module queries local Multi-Source Inventory (MSI) where available.
   • It displays which physical retail stores/branches currently have the product in stock and in which sizes.

Documentation (User Guide & Overview)

Bundled HTML documentation with admin and storefront screenshots:

Document	Description
docs/USER_GUIDE.html	Full setup, configuration, audit log, and storefront verification
docs/OVERVIEW.html	Product overview for merchants and stakeholders
docs/README.md	How to open docs from admin

From admin: Inspeya → CheckSizeAPI → Configuration (or Stores → Configuration → MHinspeya.de → CheckSizeAPI Configuration) → License Key group → View User Guide or View Overview.

Features

• Real-time Inventory Check: Branch sizes from MSI inventory sources when configured.
• Modehaus.de API Integration: AJAX check for missing sizes via GraphQL.
• Dynamic Icons: Configurable icons for store availability and Modehaus check.
• Hyvä Compatible: Built for Hyvä themes (Alpine.js).
• License validation and admin audit log (config_save, license_check).
• Localization: de_DE, de_CH, de_AT CSV files.

Installation

bin/magento module:enable MHinspeya_CheckSizeAPI
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy -f de_DE de_CH de_AT en_US
bin/magento cache:flush

Requires MHinspeya_BackendMod (Inspeya admin menu).

Admin menu & permissions

1. Inspeya → CheckSizeAPI → Configuration — module settings (section/eanmenu).
2. Inspeya → CheckSizeAPI → Audit Log — configuration and license audit grid.

ACL (System → Permissions → User Roles): under Inspeya → CheckSizeAPI grant:

• CheckSizeAPI (root) — show the menu branch
• Configuration — edit settings and open User Guide / Overview
• Audit Log — view audit grid

Configuration steps

Navigate to Stores → Configuration → MHinspeya.de → CheckSizeAPI Configuration.

Step 1 — Documentation

In License Key → Documentation & User Guide, click View User Guide or View Overview.

Step 2 — License key

1. Enter your License Key.
2. Save Config. Status icon shows valid/invalid.
3. Invalid keys disable Activate CheckOnSize in Frontend.

Step 3 — Enable CheckOnSize

Set Activate CheckOnSize in Frontend to Yes for the desired store view scope.

Step 4 — Modehaus.de text style

Customize (per store view):

• Modehaus.de Text Title
• Missing a Size Label
• Buy Directly on Site Label
• Check Item Availability Label
• Availability Icon (default: view/frontend/web/images/pos_shopping.svg)

Step 5 — Modehaus API connection

1. Product EAN/SKU for Check — EAN or SKU sent to Modehaus.
2. Authorization Key, Graphql API Key, Shop URL.
3. Check Size Icon (default: modehaus_de_netzwerk.svg).
4. Save Config.

Step 6 — Verify storefront

Open a PDP with a valid EAN/SKU: confirm local branch stock and Modehaus.de size check (see User Guide §8).

Step 7 — Audit log

Inspeya → CheckSizeAPI → Audit Log — review saves and license checks (API/license values masked as [PROTECTED]).

Technical notes

• Config paths: eanmenu/license/*, eanmenu/custom/enable_checkonsize, eanmenu/modehaus_api_text/*, eanmenu/modehaus_api/*.
• Audit table: mhinspeya_checksizeapi_audit_log.
• PHP 8.4 / Magento 2.4.8: \Throwable handling, PSR logging, graceful MSI fallback.

Localization

Translation files: i18n/de_DE.csv, i18n/de_CH.csv, i18n/de_AT.csv.

© MHinspeya. All rights reserved.