patchworks/magento2-connector

Patchworks Connector module for Magento2

Magento2 Patchworks Connector

The Magento2 Patchworks Connector, provides extensions to the standard Magento2 REST API to give a few extra features that come in handy when importing/exporting data from Magento2., _(*1)

Installation

To install and enable the module, run the following commands from the root location of your Magento2 installation: 1. composer require patchworks/magento2-connector 2. php bin/magento module:enable Patchworks_Connector, _(*2)

Note

This module is still in first release beta., _(*3)

About Patchworks

http://www.patchworks.co.uk/
Patchworks middleware helps integrate data between different business systems. Check out the website above for more information., _(*4)

Key Features

Reindex (GET)
/rest/V1/patchworks/reindex?index={indexName}
Allows a remote system to trigger a reindex process via the REST API., _(*5)

REST API Error Report
/rest/V1/patchworks/apierror?report={reportNumber}
Allows the remote retrieval of the webapi-X error from the logs folder., _(*6)

Image Search (GET)
/rest/V1/patchworks/imagesearch?sku={sku}
Allows a remote system to search the /media/import folder for image references that have a file name matching the SKU passed in the URL. Matching images are then returned as an array for use in external systems., _(*7)

Mass Stock Update (PUT)
/rest/V1/patchworks/stocklevels/
Allowance for external systems to post stock levels on mass, the module then updates the database directly with the new stock level data., _(*8)

When sending data to this function it expects the following format:, _(*9)

{
    'stock_items': {
        'sku': 'ABC123',
        'qty': 49
    },
    {
        'sku': 'FJ3FF',
        'qty': 23
    }
}

Mass Stock Export (GET)
/rest/V1/patchworks/stocklevels/
Allows the export of all stocklevels from the Magento system in a single call., _(*10)