PHPackages                             storekeeper/magento2-plugin - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. storekeeper/magento2-plugin

ActiveMagento2-module[Utility &amp; Helpers](/categories/utility)

storekeeper/magento2-plugin
===========================

Storekeeper plugin

2.1.80(10mo ago)02251[1 PRs](https://github.com/storekeeper-company/magento2-plugin/pulls)1LGPL-3.0-onlyPHPPHP ^8.1 | ^8.2CI passing

Since Jul 18Pushed 10mo ago2 watchersCompare

[ Source](https://github.com/storekeeper-company/magento2-plugin)[ Packagist](https://packagist.org/packages/storekeeper/magento2-plugin)[ RSS](/packages/storekeeper-magento2-plugin/feed)WikiDiscussions master Synced 3w ago

READMEChangelog (10)Dependencies (6)Versions (150)Used By (1)

Description
===========

[](#description)

Connect your Magento 2 stores to StoreKeeper.

Important Notices
=================

[](#important-notices)

Before using module make sure that your shop have all tax rules, classes and rates configured accordingly to your shop's region. Please follow this [official Magento guide](https://experienceleague.adobe.com/en/docs/commerce-admin/stores-sales/site-store/taxes/international-tax-guidelines#eu-tax-configuration).

If your project is using Multi-Source Inventory (MSI) functionality and/or MSI-related modules are enabled, please install this [addon module](https://github.com/storekeeper-company/magento2-plugin-msi-addon).

Installation
============

[](#installation)

1. Go to your Magento 2 directory and install the plugin via `composer`:

```
composer require storekeeper/magento2-plugin

```

2. Recompile your Magento 2 installation by running:

```
bin/magento setup:upgrade;
bin/magento setup:di:compile;
bin/magento setup:static-content:deploy;
bin/magento cache:clean;

```

Configuration
=============

[](#configuration)

1. Log into your Magento 2 backend and go to `Stores` -&gt; `Configuration` -&gt; `StoreKeeper` -&gt; `General`
2. Select your store by navigating to the deepest level in the top left store navigation
3. Enable the plugin by setting the field `Enabled` to `Yes`
4. Click button `StoreKeeper Connect` next to `Enabled`, and you will be redirected to StoreKeeper Connection page
5. Follow the onscreen instructions and enter your StoreKeeper account name
6. If it is valid - click `Connect` and you will be redirected to your StoreKeeper account Dashboard
7. Get back to Magento admin `Stores` -&gt; `Configuration` -&gt; `StoreKeeper` -&gt; `General` and click `Refresh store information` in order to receive Store ID and Store Name reserved by StoreKeeper for current integration

Sync Modes clarification
------------------------

[](#sync-modes-clarification)

Current extension operates in one of 4 modes:

- **None** - No data exchange between M2 and Storekeeper systems
- **Products** - Only product related data will be synced (products creation, activation, deactivation and stock updates)
- **Orders** - Only orders related data will be synced (order body, statuses, items, payments, shipments) **and** products stock
- **All** - Combination of two methods described above

Sync mode can be adjusted under `Stores` -&gt; `Configuration` -&gt; `StoreKeeper` -&gt; `General` -&gt; `Sync Mode` section

***Notice:*** Order shipments created from Magento admin will be synced into StoreKeeper backoffice as **Fully Delivered** due to lack of shpimnet statuses between dispatched and delivered in Magento

Delivery Methods Configuration
------------------------------

[](#delivery-methods-configuration)

In order to use **StoreKeeper Multi-Carrier Shipping** delivery option activate it under:
*Stores -&gt; Configuration -&gt; Sales -&gt; Delivery Methods -&gt; **StoreKeeper Multi-Carrier Shipping***

After that all Shipping offers configured on your StoreKeeper backoffice will be available on Magento checout

Payment Methods Configuration
-----------------------------

[](#payment-methods-configuration)

Payment methods avaliable via Storekeeper Payment Gateway can be activated in two places:

1. As an option of **StoreKeeper Payments** payment method, available under:
    *Stores -&gt; Configuration -&gt; Sales -&gt; Payment Methods -&gt; Other Payment Methods -&gt; **StoreKeeper Payments** (Yes/No)*

In this case customer will see all Payment options activated on their storekeeper account. [![Storekeeper Payments available in Magento as single Payment option](docs/storekeeper_payments.png)](docs/storekeeper_payments.png)2. As separate Payment option:
In order to display in Magento Checkout any of Payment Methods available on storekeeper account as an individual payment option, admin user needs to activate method under:
*Stores-&gt;Configuration-&gt;Storekeeper-&gt;**StoreKeeper Payments***[![Payment method iDEAL available as separate Payment option](docs/sk_payment_individually_adminarea.png)](docs/sk_payment_individually_adminarea.png)

In this case activated Payment Method(s) will appear as individual Payment Method option, and dissapear as sub-option on **StoreKeeper Payments**[![Payment method iDEAL available as separate Payment option](docs/sk_payment_individually.png)](docs/sk_payment_individually.png)

*Payment methods that does not have own logo will receive current store logo set in Content-&gt;Design-&gt;Configuration area of Magento admin panel*

Export
------

[](#export)

Module allows to export such Magento entities as: Products, Customers, Categories, Attribute Sets, Attributes, Attribute Options, Blueprints (possible combinations of simple prodcuts for compose configurables).

Exported data saved as csv in a format suitable for StoreKeeper backend. Generating and downloading of it available by path: *System-&gt;Data Transfer-&gt;**StoreKeeper Export Data***

All fields are premapped, while project-specific product attributes can be mapped via 'Featured Attributes' tab under: *Stores-&gt;Configuration-&gt;Storekeeper-&gt;.**Export***

*Notice*: Barcode field by default mapped to SKU attribute, and will export sku's that meets ***EAN13*** requirements as barcode mapped attribute.

If your store have dedicated custom barcode attribute - fell free to map it via Featured Attributes tab.

Queues
------

[](#queues)

This plugin uses the Magento 2 queue consumer functionality. If you want to run queues manually you can use following commands:

Run consumer that handles StoreKeeper webhook events

```
bin/magento queue:consumer:start storekeeper.queue.events

```

Run consumer that handles Magento entities export for StoreKeeper

```
bin/magento queue:consumer:start storekeeper.data.export

```

Run consumer that orders sync process with StoreKeeper

```
bin/magento queue:consumer:start storekeeper.queue.sync.orders

```

Disconnecting
=============

[](#disconnecting)

Disconnecting your Magento 2 store can be done in two ways

Disconnect from StoreKeeper
---------------------------

[](#disconnect-from-storekeeper)

1. Log into your StoreKeeper environment
2. Select your StoreKeeper Sales Channel
3. Go to `Settings`
4. Scroll down to the `Disconnect` button and click it

Disconnect from Magento 2
-------------------------

[](#disconnect-from-magento-2)

1. Log into your Magento 2 backend
2. Log into your Magento 2 backend and go to `Stores` -&gt; `Configuration` -&gt; `StoreKeeper` -&gt; `General`
3. Select your store by navigating to the deepest level in the top left store navigation
4. Click on `Disconnect from StoreKeeper` button at the bottom of current config section

Troubleshooting
===============

[](#troubleshooting)

Debugging
---------

[](#debugging)

If you're having any issues using the plugin, the first thing to do would be checking the `magento2/var/log/storekeeper.log` for any errors.

Tasks and Events Logging
------------------------

[](#tasks-and-events-logging)

Every incoming webhook event data are logged and can be reviewed under:
***System -&gt; Action Logs -&gt; StoreKeeper Event Log*** tab.
This grid collects info about request route, body, method, action, response code and timesteamp of every incoming webhook.

Every StoreKeeper related task from mesage queue are logged under:
***System -&gt; Action Logs -&gt; StoreKeeper Task Log*** tab.
This grid collects info about topic name, json-formatted request body, update time, status and number of trials made by Magento core queue managed in order to complete task.
Task log registers every addition of order to sync queue, its processing, as well as every operation with product sync (import, export, updates)

Running integration tests
=========================

[](#running-integration-tests)

1. Prepare your enviroment according to Magento 2 integration testing documentation
2. To run integration tests from a specific directory tree in Magento 2, use the following command:

```
cd dev/tests/integration

../../../vendor/bin/phpunit ../../../vendor/storekeeper/magento2-plugin/Test/Integration

```

2. To run a single test class in Magento 2, use the following command:

```
cd dev/tests/integration

../../../vendor/bin/phpunit ../../../vendor/storekeeper/magento2-plugin/Test/Integration/OrderCreationTest.php

```

###  Health Score

44

—

FairBetter than 91% of packages

Maintenance54

Moderate activity, may be stable

Popularity14

Limited adoption so far

Community18

Small or concentrated contributor base

Maturity78

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~25 days

Recently: every ~76 days

Total

41

Last Release

308d ago

Major Versions

0.0.4 → 1.0.02023-03-02

1.5.0 → 2.0.02024-06-12

PHP version history (4 changes)1.1.0PHP ^7.4|^8.1

1.3.2PHP ^7.4|^8.1|^8.2

1.5.0PHP ^8.2

2.1.12PHP ^8.1 | ^8.2

### Community

Maintainers

![](https://www.gravatar.com/avatar/88914b496ac4878c882ccb450fefee44f919fdc8e6d02c67000280b97ff6082d?d=identicon)[skdev](/maintainers/skdev)

---

Top Contributors

[![Telepatrick](https://avatars.githubusercontent.com/u/13983834?v=4)](https://github.com/Telepatrick "Telepatrick (261 commits)")[![ekobiliatsky](https://avatars.githubusercontent.com/u/125256777?v=4)](https://github.com/ekobiliatsky "ekobiliatsky (174 commits)")[![ikulis](https://avatars.githubusercontent.com/u/1073778?v=4)](https://github.com/ikulis "ikulis (126 commits)")[![creative-thom](https://avatars.githubusercontent.com/u/203991475?v=4)](https://github.com/creative-thom "creative-thom (82 commits)")[![rickvanoosten](https://avatars.githubusercontent.com/u/3973839?v=4)](https://github.com/rickvanoosten "rickvanoosten (13 commits)")[![tmensink-cict](https://avatars.githubusercontent.com/u/41570387?v=4)](https://github.com/tmensink-cict "tmensink-cict (2 commits)")[![MarijnDnovo](https://avatars.githubusercontent.com/u/17722715?v=4)](https://github.com/MarijnDnovo "MarijnDnovo (1 commits)")[![jnmrclmbsjse](https://avatars.githubusercontent.com/u/18332309?v=4)](https://github.com/jnmrclmbsjse "jnmrclmbsjse (1 commits)")

---

Tags

magentomagento2magento2-extensionmagento2-moduleorder-managementpayment-gateway

### Embed Badge

![Health badge](/badges/storekeeper-magento2-plugin/health.svg)

```
[![Health](https://phpackages.com/badges/storekeeper-magento2-plugin/health.svg)](https://phpackages.com/packages/storekeeper-magento2-plugin)
```

###  Alternatives

[symfony/symfony

The Symfony PHP framework

31.4k86.9M2.2k](/packages/symfony-symfony)[symfony/uid

Provides an object-oriented API to generate and represent UIDs

610303.9M1.1k](/packages/symfony-uid)[civicrm/civicrm-core

Open source constituent relationship management for non-profits, NGOs and advocacy organizations.

749284.3k35](/packages/civicrm-civicrm-core)[afragen/git-updater

A plugin to automatically update GitHub, Bitbucket, GitLab, or Gitea hosted plugins, themes, and language packs.

3.3k1.7k](/packages/afragen-git-updater)[wp-hooks/generator

Generates a JSON representation of the WordPress actions and filters in your code

87179.9k5](/packages/wp-hooks-generator)[beacon-hq/bag

A comprehensive immutable value objects implementation

18311.8k4](/packages/beacon-hq-bag)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
