Vue Storefront is now Alokai! Learn More
Magento integration

Magento integration

Storefront Cloud offers you a special Command Line tool to import the data from your Magento2 instance. Before that, we need to configure your Magento2 instance to provide us with the OAuth2 credentials, required to run the API requests.

Magento API configuration

The tool uses the Magento2 API via OAuth authorization, so you need to prepare Magento Integration access beforehand. Go to your Magento2 admin panel and click: System -> Integrations

Magento Admin Panel

Then click Add new integration and just fill:

  • name (whatever)
  • your password to confirm the changes,
  • check Catalog, Sales, My Account and Carts on API permissions tab — save

Magento API

In the result, you’ll click Activate and get some OAuth access tokens:

Magento tokens

Now please create and edit the config/local.js file in your api repository and modify the following section: You may create a new local config file using Gitlab

  "magento2": {
    "url": "",
    "imgUrl": "http://localhost:8080/media/catalog/product",
    "assetPath": "/../var/magento2-sample-data/pub/media",
    "magentoUserName": "",
    "magentoUserPassword": "",
    "httpUserName": "",
    "httpUserPassword": "",
    "api": {
      "url": "",
      "consumerKey": "byv3730rhoulpopcq64don8ukb8lf2gq",
      "consumerSecret": "u9q4fcobv7vfx9td80oupa6uhexc27rb",
      "accessToken": "040xx3qy7s0j28o3q0exrfop579cy20m",
      "accessTokenSecret": "7qunl3p505rubmr7u1ijt7odyialnih9"
  "imageable": {
    "namespace": "",
    "maxListeners": 512,
    "imageSizeLimit": 1024,
    "whitelist": {
      "allowedHosts": [
    "cache": {
      "memory": 50,
      "files": 20,
      "items": 100
    "concurrency": 0,
    "counters": {
      "queue": 2,
      "process": 4 
    "simd": true,
    "keepDownloads": true
You may create / edit a local config file using Gitlab

Execute the import

It’s safe to run these commands over and over as they perform an upsert operation - which means these commands insert or update the existing records. To execute the import script, you should use our Command line tool and perform the import operation:

node scripts/cli.js import

Read more on import command...

Advanced scenarios

Storefront Cloud uses the mage2vuestorefront to execute the Magento synchronization. This tool offers way more syncing scenarios: for example, on-demand indexing or delta-main indexing schemas. Please contact us for details.