storekeeper/magento2-plugin

Storekeeper plugin

2.1.75 2024-10-17 07:09 UTC

Requires

• php: ^8.1 | ^8.2
• brick/money: 0.5.* | 0.6.* | 0.7.* | 0.9.*
• erusev/parsedown: v1.7.4
• magento/product-community-edition: ^2.4.6
• picqer/php-barcode-generator: *
• storekeeper/api-wrapper: ^6.2
• symfony/polyfill-uuid: *

LGPL-3.0-only

README

Connect your Magento 2 stores to StoreKeeper.

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.

If your project is using Multi-Source Inventory (MSI) functionality and/or MSI-related modules are enabled, please install this addon module.

Installation

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

composer require storekeeper/magento2-plugin

1. 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

1. Log into your Magento 2 backend and go to Stores -> Configuration -> StoreKeeper -> 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 -> Configuration -> StoreKeeper -> General and click Refresh store information in order to receive Store ID and Store Name reserved by StoreKeeper for current integration

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 -> Configuration -> StoreKeeper -> General -> 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

In order to use StoreKeeper Multi-Carrier Shipping delivery option activate it under:
Stores -> Configuration -> Sales -> Delivery Methods -> 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 avaliable via Storekeeper Payment Gateway can be activated in two places:

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

In this case customer will see all Payment options activated on their storekeeper account. 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->Configuration->Storekeeper->StoreKeeper Payments

In this case activated Payment Method(s) will appear as individual Payment Method option, and dissapear as sub-option on StoreKeeper Payments

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

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->Data Transfer->StoreKeeper Export Data

All fields are premapped, while project-specific product attributes can be mapped via 'Featured Attributes' tab under: Stores->Configuration->Storekeeper->.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

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 your Magento 2 store can be done in two ways

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

1. Log into your Magento 2 backend

2. Log into your Magento 2 backend and go to Stores -> Configuration -> StoreKeeper -> 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

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

Every incoming webhook event data are logged and can be reviewed under:
System -> Action Logs -> 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 -> Action Logs -> 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

1. Prepare your enviroment according to Magento 2 integration testing documentation https://developer.adobe.com/commerce/testing/guide/integration/

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

1. 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