Select Page

Shopify Akeneo Meta field Definitions || Export Shopify Meta field

Kavita Singh
Published: July 20, 2022

Shopify Akeneo Meta field Definitions Addon is an addon of Shopify Akeneo Connector. This add-on allows you to create and export meta field definitions from Akeneo to the Shopify platform. 

Meta fields defination: They act as a template that defines which parts of your store a certain meta field applies to as well as the possible values for that meta field.

Please Note:

  • This module is an add-on to Shopify Akeneo Connector, so it must be installed first.
  • This module is compatible with the Akeneo community and Enterprise(Flexibility) edition.
  • If you want to use this extension on Akeneo EE Serenity mode, please contact us.
  • For the Akeneo installation, your Akeneo server should meet these system requirements.

Basic Requirements

  • This module works with Akeneo, Akeneo 5.0.Download Akeneo from here
  • Node and Yarn packages need to be installed.
  • Also works with Akeneo Cloud Flexibility Mode which is a PAAS Edition of Akeneo

Feature

  • Export Meta field Definitions from Akeneo to Shopify.
  • Create Meta field Definitions.
  • Export Meta field Products & product variants to Shopify.
  • This module is compatible with Akeneoversion 5. x
  • The source code is 100% open for customization.
  • Compatible with the Shopify Plus platform also.

Composer Installation

Read This Blog

Before beginning the composer installation

Searching for an experienced
Akeneo Company ?
Read More


1: Get the ACCESS KEYS [Create a support ticket]
2: In Akeneo composer.json, add our repository as well as the installation script.

For Akeneo <=5.x 

{
  "scripts": {
        "post-update-cmd": [
           "vendor/webkul/metafielddefinitionsbundle/composer_install.sh"
        ],
        "post-install-cmd": [
           "vendor/webkul/metafielddefinitionsbundle/composer_install.sh"
        ],
        "post-create-project-cmd": [
          "vendor/webkul/metafielddefinitionsbundle/composer_install.sh"
       ]
   },
  "repositories": [{
    "type": "composer",
    "url": "https://akeneorepo.webkul.com/"
  }]
}

3: Use composer to install the extension.

         composer require webkul/metafielddefinitionsbundle

4: Complete the authentication form.
5: Send a Message of Success
6: Delete your browser’s cache.

Installing Module for Version 5.0.x

For installing this module in Akeneo, please follow the further steps:

1 – Unzip the respective extension zip then merge the “src” folder into the akeneo project root directory.

2 – Goto config/Bundles.php then add the line:

Webkul\MetafieldDefinitionsBundle\MetafieldDefinitionsBundle::class => ['all' => true],

in the return array.

3 – Then copy the “config” folder into Akeneo project root directory for routing.

– After that run this command after ssh to your akeneo server by the terminal.

rm -rf var/cache && php bin/console ca:warmup && php bin/console MetafieldDefinitions:setup:install

6 –  If you are using php-fpm then you need to restart the php-fpm services and apache web server.

sudo service php-fpm7.4 restart

Docker Installation Command :

For Akeneo 5

alias docker_php='docker-compose run -u www-data --rm php php';
alias docker_yarn='docker-compose run -u node --rm node yarn';
docker_php bin/console cache:clear --env=prod;
docker_php bin/console pim:installer:assets --symlink --clean --env=prod;
docker_php bin/console d:s:u --force;
docker_yarn run webpack;
docker_yarn run update-extensions;
docker_yarn run less;

Common Issues After Installation

It might happen that even after proper installation, upon opening your Akeneo admin dashboard, you see a loading screen. In that case, do check for the following solution:

  • Webpack Installation: If you get the below error
error
  • It means that the web pack is not installed in your system. Run the following command\
npm install --save-prod webpack
npm install
  • Module routing.yml is not configured properly. Re-check the routing.yml file as mentioned in the 3rd step of Module Installation
  • Clear your browser cache.

Setup credential in Akeneo

Note: The only functionality that this add-on supports is the export of product meta fields. From Akeneo to Shopify, you can only export meta fields.

After successfully installing the Shopify Akeneo connector and Shopify Akeneo Meta field Definitions Addon module in Akeneo, the Meta field Defination button will be visible then you need to set up the Shopify API credentials in Akeneo.

Webkul-Shopify-Connector-Configuration

For more details about the setup credentials in Akeneo, You can refer Shopify Akeneo connector user guide. Click here to know more. Shopify Akeneo Connector.

Export Attributes Mapping

You can sync detailed information about the product meta fields from Akeneo to Shopify. But first, you need to do the mapping of Akeneo meta fields attributes with Shopify meta fields.

Webkul-Shopify-Connector-Configuration-1

Create Metafields Defination in Akeneo

To view the list of meta field definitions in Akeneo, click on Metafeild definition. You may then add a new definition based on your requirements.

Webkul-Shopify-Connector-Configuration-2

After that to add a new defination click on add defination button:

Metafields-Definition

Once you will click on add definition it will redirect you to a new page. Then you have to add details as shown in the image.

You can export defination type products and variant

Metafields-Definition-1

Click the Save button once you’ve finished adding the details. Once your definition has appeared in the list, turn on the button shown in the image below to mark it as a pin.

Metafields-Definition-3

Export the Meta fields

Now to export your meta field data you need to create a job profile and then execute it. First, go to Exports>Create Export Profile.

Export-profiles-management-4

 After that enter a unique code, and label, and select a job profile.

Export-profiles-management-1

Metadifeilds Defination:

First, you need to export the defination to Shopify. Once you will add the details you need to click on the Save button.

Export-profile-Shopify-Metafields-Definition-Export-Edit

Execution Process

Wait for the execution process to complete then check the errors. After the completion of the export job, the meta fields defination will appear on Shopify.

Export-executions-Details-1

Defination in Shopify

Akeneo-Metafields2-·-Product-metafield-definitions-·-Shopify

Variants in Shopify:

Akeneo-Metafields2-·-Variant-metafield-definitions-·-Shopify

Meta fields Product:

Now, you need to export meta fields product create an export profile and filter the data then click on the Save button:

Export-profile-Shopify-Metafields-Product-Export-Edit-1

Execution Process

Wait for the execution process to complete then check the errors. After the completion of the export job, the meta fields products will appear on Shopify.

Export-executions-Details-4

You can export meta fields variants in the same way from Akeneo to Shopify.

Meta fields Product in Shopify:

Akeneo-Metafields2-·-Products-·-Sunglasses-·-Shopify

Support

So, that was much about the  User Guide of Shopify Akeneo Meta field Definitions Addon for any queries or doubts reach out to us at [email protected]. You can also raise a ticket at our HelpDesk System.

Please explore our Akeneo Development Services and Quality Akeneo Extensions.

Current Product Version – 1.0.0

Supported Framework Version – 5.x.x

Source: webkul.com