liquidlab-agency/magento2-innoship-hyva-checkout

Hyva Checkout compatibility module for InnoShip (https://innoship.com/)

Maintainers

Package info

github.com/liquidlab-agency/magento2-innoship-hyva-checkout

Type:magento2-module

pkg:composer/liquidlab-agency/magento2-innoship-hyva-checkout

Statistics

Installs: 109

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

1.2.2 2026-05-18 16:38 UTC

This package is auto-updated.

Last update: 2026-05-18 16:39:17 UTC


README

Hyvä Checkout compatibility layer for the InnoShip_InnoShip shipping module.

Developed by Liquidlab AgencyRomania’s first full-service Hyvä agency and the first Hyvä partner in Romania.

The upstream InnoShip_InnoShip module ships a working Luma checkout integration: a PUDO (pickup-drop-off) point picker built on Knockout/jQuery components and window.checkoutConfig. None of that runs inside Hyvä Checkout, which uses Magewire + Alpine.js and does not expose checkoutConfig to the frontend.

This module bridges that gap. It replaces InnoShip's checkout-side UI with a Hyvä-native equivalent while continuing to use InnoShip's database, shipping carrier, AWB generation, and order-management code unchanged.

This module is an independent, community-developed integration. It is not affiliated with, endorsed by, or developed in partnership with Innoship.

Screenshots

Checkout — InnoShip shipping method, no point selected
Checkout — locker method (no point selected)
PUDO picker modal with map, county/city filters and markers
Interactive Leaflet map picker
Order view — PUDO summary with Google Maps / Waze links
Customer order view — pickup point summary
Selected PUDO point displayed in checkout
Selected pickup point with “Clear” button

Video Demo

Checkout Flow and Billing Management

checkout-process.mp4

The video above demonstrates the checkout flow for a customer without a saved address:

  1. The customer selects a shipping method that delivers to a pickup point (locker).
  2. The interactive map opens, allowing the customer to choose their preferred PUDO point.
  3. Billing Address Logic: Since a locker address cannot be used for invoicing, the module automatically unchecks "My billing and shipping address are the same".
  4. If the billing address was previously mirrored from the shipping address, the module clears the location fields (street, city, etc.) while preserving the customer's identity (name, email, phone). This ensures the customer is prompted to provide a valid billing address for their invoice.

Dynamic Payment Method Updates

payment-update.mp4

This video shows how payment methods are filtered based on the selected shipping method:

  1. Payment methods (such as Cash on Delivery) are restricted according to the carrier's configuration in the admin panel.
  2. The payment methods list in Hyvä Checkout refreshes automatically as soon as a shipping method is selected, ensuring the restrictions take effect without a page reload.

What it does

1. PUDO point picker in Hyvä Checkout

When the customer chooses an InnoShip shipping method (e.g. innoshipcargusgo_*), Hyvä Checkout renders a "Choose Pickup Point on Map" button under the shipping method.

Checkout — locker shipping method, no point selected yet

  • Clicking it opens a modal with an interactive Leaflet map of available pickup points.
  • The modal uses a two-column layout: a left sidebar for filters and search, and a right panel for the map.
  • The customer can narrow results by county and city (county/city lists come from the innoship_pudo table).
  • After a city is selected, a search input appears in the sidebar. It filters all currently loaded pins in real time by name, street address, city, and postcode — entirely client-side, with no Magewire roundtrip per keystroke.
  • Search results appear as a dropdown list (capped at 20 matches). Clicking a result pans and zooms the map to that pin and opens its popup, ready for the customer to confirm their choice.
  • If no county is selected but the customer's shipping address has a Romanian region, the map auto-centers on that region and shows points within ~50 km, sorted by distance.
  • Marker icons reflect the courier (Cargus, DPD, FAN, eMag, Posta Romana, etc.).
  • Each marker's popup shows the address, phone number, opening hours, accepted payment methods, and a "Select This Point" button.

Picker modal with county/city filters and pickup-point markers

The picker is implemented as two Magewire components, Magewire\PudoPicker (modal + filters + map data) and Magewire\PudoPoint (selected-point summary), wired together via emit() / $listeners. The map UI itself is an Alpine.js component (view/frontend/web/js/pudo-picker.js). The search input uses Hyvä's CSP-safe Alpine binding pattern (:value + @input instead of x-model, which the CSP-friendly Alpine build does not support).

Screen.Recording.2026-05-14.at.3.59.02.PM.mp4

2. Persisted PUDO selection

The PUDO selection is saved to the checkout session as soon as the customer picks a point — it is not transient UI state. This gives the picker real saving functionality:

  • The selection survives Magewire roundtrips during checkout (filter changes, address edits, payment-method switches).
  • It survives full page reloads. If the customer refreshes mid-checkout or returns to checkout in the same session, the picker remounts with the previously chosen point already selected and displayed — no need to re-pick.
  • The selection is also written to the quote shipping address (innoship_pudo_id, innoship_courier_id, plus extension attributes) and the address fields are rewritten to the pickup point's address. This is required because InnoShip's AWB-generation code reads the destination from the shipping address.
  • On PudoPicker mount, the component reconciles the quote shipping address against the session: if the session holds a selected PUDO whose ID is missing from the current quote address, it re-applies the selection so order submission carries the PUDO ID. The check is idempotent (early-returns when the IDs already match) so it does not trigger redundant quote saves.

The session storage key is innoship_selected_pudo_point (defined as INNOSHIP_PUDO_SESSION_KEY in Magewire\PudoPicker and Magewire\PudoPoint). The customer can clear the selection at any time using the "Clear PUDO" button shown next to the chosen point.

Selected PUDO displayed in checkout — name, address, payment methods, clear button

3. Automatic shipping address clearing on PUDO deselection

When a PUDO is selected, its locker address is written to the quote shipping address. If the customer later deselects the PUDO (either manually or by switching shipping method), that address becomes invalid as a delivery address — it belongs to the locker, not the customer. The module clears the relevant fields automatically in two scenarios.

Explicit deselection — "Clear PUDO" button

When the customer clicks the clear button, Magewire\PudoPoint::clearPudoPoint() runs. Before wiping the session, it captures the PUDO ID and compares it against the innoship_pudo_id column that was stamped onto the quote shipping address when the point was selected. If the two IDs match — meaning the customer has not manually edited the address since picking the locker — the module blanks the shipping address location fields (company, street, city, postcode, region). The customer is then shown an empty shipping-address form and is prompted to enter their real delivery address.

If the IDs do not match — because the customer edited the address form after selecting the PUDO — the location data is left untouched; only the PUDO stamps (innoship_pudo_id, innoship_courier_id) are removed from the address and the quote. In both cases the PUDO selection is fully cleared from the session and the innoship-pudo-cleared event is emitted so the shipping-address form re-renders immediately.

Shipping method change

Magewire\PudoPoint listens for Hyvä Checkout's shipping_method_selected event (emitted by Hyva\Checkout\Magewire\Checkout\Shipping\MethodList on every method change). When the event fires and there is a PUDO in the session:

  • If the new method is still an InnoShip carrier (method code contains innoshipcargusgo), the selection is left in place — the customer may just be switching between InnoShip rate options.
  • Otherwise, clearPudoPoint() is called with the same fingerprint logic described above, clearing both the PUDO selection and the locker address fields.

This prevents a stale locker address from being submitted when the customer switches to a home-delivery method.

4. Pre-submit observer

Observer\CheckoutSubmitBefore listens on checkout_submit_before (which fires earlier than the InnoShip module's own sales_model_service_quote_submit_before observer). It re-stamps the PUDO data onto the shipping address from the most authoritative available source (quote custom data → session → existing address fields) and saves the quote.

This is defensive: Hyvä's checkout flow has multiple steps that may reload or restore the shipping address, and InnoShip's downstream code expects the PUDO fields to be present before its own observer runs. Without this, late address restorations can blank out innoship_pudo_id and the AWB generation fails.

5. Disabled upstream controllers

Several InnoShip_InnoShip frontend controllers exist only to serve the Luma checkout JS (view/frontend/web/js/checkout.js) and have no purpose in a Hyvä-only storefront. Rather than fork or patch InnoShip_InnoShip, this module declares DI preferences in etc/frontend/di.xml that swap each unused controller class for a shared no-op stub (Controller/Disabled/NotFound) which throws NotFoundException — every dead URL returns a clean 404.

Disabled endpoints:

  • /innoshipf/pudo/getpudo
  • /innoshipf/pudo/getmap
  • /innoshipf/pudo/setpudo
  • /innoshipf/pudo/getpudofromlocation
  • /innoshipf/courier/listcouriers
  • /innoshipf/courier/setcourierid

The stub implements both HttpGet/HttpPostActionInterface and CsrfAwareActionInterface so POSTs reach the 404 instead of being rejected at 405 / CSRF. Admin AWB controllers (Adminhtml/Awb/*) are untouched — the preferences are scoped to etc/frontend/di.xml.

6. Validation gate

Magewire\PudoPoint implements Hyvä's EvaluationInterface. If the selected shipping method is an InnoShip method, the customer cannot proceed past the shipping step until a pickup point is chosen — Hyvä displays an inline error and emits shipping:method:error.

7. Order-view PUDO summary

On the customer's order view page (My Account → Orders), the module overrides InnoShip's order_info_innoship_front block with a Hyvä-friendly template (templates/order/order_shipping_pudo.phtml). It shows the chosen pickup point's name, address, and "Open in Google Maps" / "Open in Waze" deep links. PUDO lookups go through ViewModel\PudoInfo, which reads from the innoship_pudo table via this module's repository.

Customer order view — pickup point summary with Google Maps and Waze deep links

8. Automatic billing address management

When a PUDO point is selected, the module ensures that the billing address is not set to the locker address (which is invalid for invoicing).

  • It automatically sets the "Same as shipping" flag to false.
  • If the billing address was a mirror of the shipping address, it clears the address fields (company, street, city, postcode, region) to force the customer to enter their real billing information.
  • It preserves the customer's identity fields (First Name, Last Name, Email, Telephone) and country to minimize re-typing.

8. Dynamic payment method restrictions

The module ensures that the available payment methods are always in sync with the selected shipping method:

  • Per-carrier allowlists: It respects the payment method restrictions configured in the InnoShip admin panel for each carrier.
  • Instant Refresh: In Hyvä Checkout, the payment methods list is automatically refreshed whenever the shipping method changes, ensuring restrictions take effect immediately without a page reload.
  • Improved logic: Unlike the upstream implementation, our restriction logic is more robust and handles normalized shipping method codes correctly.

How it integrates with InnoShip_InnoShip

Concern Owned by
innoship_pudo table + cron sync of pickup points InnoShip_InnoShip (this module reads only)
Shipping carriers (innoshipcargusgo, etc.) and AWB generation InnoShip_InnoShip
Payment method restriction configuration InnoShip_InnoShip
quote_address / sales_order_address columns (innoship_pudo_id, innoship_courier_id, innoship_shipping_price) InnoShip_InnoShip schema
Marker images and bundled Leaflet 1.9.4 assets InnoShip_InnoShip::images/..., InnoShip_InnoShip::js/leaflet.js
Hyvä-compatible PUDO picker UI + modal This module
Magewire components + Alpine map controller This module
Payment method filtering and refresh logic This module
Pre-submit safety observer This module
Disabling unused InnoShip_InnoShip frontend controllers via DI preferences This module
Hyvä order-view template override This module

The module is also registered with Hyvä's CompatModuleRegistry (in etc/frontend/di.xml) so Hyvä knows that Liquidlab_InnoShipHyva is the compatibility layer for InnoShip_InnoShip and will skip InnoShip's Luma-specific frontend assets.

Requirements

  • Magento 2.4+
  • PHP 8.1+
  • InnoShip_InnoShip (provides the schema, Leaflet assets, and shipping carriers)
  • Hyva_Checkout
  • magewirephp/magewire

Installation

composer require liquidlab-agency/magento2-innoship-hyva-checkout

About Liquidlab

Liquidlab Agency is Romania’s first full-service Hyvä agency and the first Hyvä partner in the country.

We specialize in Magento 2 development and performance optimization, transforming slow stores into blazing-fast, high-converting Hyvä platforms.

Our three pillars — Security • Stability • Performance — guide every project we deliver.

Whether it’s custom Hyvä implementations, store migrations, rescue projects for troubled Magento stores, or AI-accelerated development, we deliver scalable, secure, and lightning-fast e-commerce solutions.

  • Website: liquidlab.ro
  • Services: Magento 2 • Hyvä Theme • Performance • Migrations • Rescue Projects

License

Proprietary — © Liquidlab Agency. All rights reserved.

Built with ❤️ in Romania for merchants who demand the best checkout experience.