Skip to main content

Klar Magento Integration Modules

Data sync for Magento 1 and Magento 2

Written by Frank Birzle
Updated today

Sign up for our Klar - Magento Technical Updates mail distribution list here:
https://cdn.forms-content.sg-form.com/44d51bd3-3cac-11f1-83e8-06e45b3a2e4c

We'll inform you whenever major new updates get released.

Connect your Magento store to Klar and get full visibility into your order data — including line items, taxes, discounts, shipping, refunds, and customer information.

We offer official integration modules for both Magento 1 and Magento 2.

What the Modules Do

Both modules send your complete order data to the Klar Orders API. Once connected, every order — including its line items, applied discounts, tax breakdowns, shipping costs, and refund information — is available in Klar for reporting and analysis.

  • Automatic sync — new and updated orders are sent to Klar automatically as they are placed, shipped, or refunded

  • Historical import — bulk-export your entire order history or a specific date range to backfill data into Klar

  • Idempotent — re-syncing the same order updates it in Klar rather than creating duplicates, so you can safely re-export at any time

Magento 2

Repository: placeholder-tech/klar-magento-2 Compatibility: Magento 2.4.x, PHP 8.1+

Highlights

  • Admin UI — configure everything from Stores > Configuration > Sales > Klar, including a Test Connection button, sync status overview, and live log viewer

  • Flexible sync options — Sync All, date range sync, single order sync, and re-sync failed orders — all from the admin panel or via CLI (bin/magento klar:order)

  • JSON Preview — inspect the exact payload that will be sent to Klar for any order, directly in the admin UI

  • Configurable field mapping — map any Magento product, customer, or order attribute to any Klar API field via a simple XML config file, without touching code. Supports dropdown labels, multiselect arrays, joined strings, booleans, and more

  • Sync tracking — the Sales > Orders grid shows when each order was last synced to Klar, with per-order error messages stored for troubleshooting

  • Configurable batch size — control how many orders are sent per API request (1–1000)

  • Detailed error logging — API errors are logged with order IDs and individual error messages to var/log/klar/klar.log

  • Bundle & configurable product support — including bundledProducts on line items (API version 07.2025)

  • Async processing — orders are synced via Magento's message queue for reliable background processing

Migrating from ICT_Klar

If you are currently using the older module hosted at ltd-iconcept/magento2-klar, a step-by-step migration guide is available. Your existing configuration, database tables, and queue settings are fully preserved.

Getting Started


Magento 1

Repository: placeholder-tech/klar-magento-1 Compatibility: Magento 1.9.x API version: 12.2022

Highlights

  • Automatic sync — orders are exported automatically after placement via cron

  • Date range export — manually schedule exports for a specific date range from Admin > Sales > Klar > Schedule Export

  • Order status tracking — view sync status and error messages per order in Admin > Sales > Klar > Orders Status

  • Email privacy — optionally hash customer emails before sending to Klar

Getting Started


Feature Comparison

Feature

Magento 1

Magento 2

Automatic order sync

Yes

Yes

Historical / bulk export

Date range

All, date range, single order

Admin UI configuration

Basic

Full (logo, sync panel, log viewer)

CLI support

bin/magento klar:order

JSON preview / debug mode

Yes

Custom attribute → Klar field mapping

Yes (XML config)

Sync status in order grid

Separate page

Inline column with timestamp

Per-order error messages

Yes

Yes

Re-sync failed orders

Manual

One-click button

Configurable batch size

Yes (1–1000)

Bundle product support

Yes

Async message queue

Cron-based

Magento message queue

API version

12.2022

07.2025

Need Help?

If you run into any issues, please open an issue on the respective GitHub repository or reach out to our support team.

Did this answer your question?