Menu Close
    Searching for an experienced Woocommerce Development Company ?

    WooCommerce Akeneo PIM Connector

    Akeneo is a Product Information Management(PIM) software. This software allows the user to collect the product information in one place. Using Akeneo PIM the user can improve and enhance the product information. And can share the product information with other channels as well as e-commerce websites like WooCommerce store, a mobile applications like Mobikul Native Apps.

    Considering the convenience of managing the product information using Akeneo, Webkul has introduced the WooCommerce Akeneo PIM Connector module.

    With the help of the WooCommerce Akeneo PIM Connector module, you can connect your WooCommerce store with the Akeneo PIM software and manage a wide range of products easily. You can import all the catalog data in Akeneo through CSV and XLSX. You can also create the product in the Akeneo then export it to the WooCommerce store.

    Once you import all the catalog data in Akeneo you can push that data into the WooCommerce store. It works with simple and variable types of products. The store owner can export categories and attributes along with the product.

    Please Note – 

    Basic Requirements:

    • You must be using  WooCommerce 2.1 or newer.
    • REST API must be enabled under WooCommerce > Settings
    • This module works with Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 4.0.x and 5.0.x. Download Akeneo from here
    • 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.

    Video Tutorials

    Check out the following video tutorials below:

    How to get API keys?

    L_rwkHdAEug

    How to do module configuration?

    vXV-4Uy1nKw

    Exporting Simple Product from Akeneo to WooCommerce

    20XzvcIzeOg

    Features

    • Works with simple and variable products.
    • Push Product data via the export job.
    • Export all the categories and attributes from Akeneo to WooCommerce.
    • Import Categories to Akeneo from WooCommerce
    • Module support Multi-Credentials Feature.
    • Import Products to Akeneo from WooCommerce
    • Create multiple jobs then schedule them for execution.
    •  Association Mapping for Upsell and Crossell products for Export
    • Also export product images along with other product information.
    • Import Variations and Attribute values for product to Akeneo from WooCommerce
    • Filter data to be Imported based on Category, family, Completeness, Time conditions, Identifier(SKU), Language, and Currency.
    • Add Association Mapping for Upsell and Cross-sell products for Export.
    • Import Attributes to Akeneo from WooCommerce
    • Import Attributes terms to Akeneo from WooCommerce
    • This module is compatible with the latest Akeneo version 5.0.x
    • Map the product fields between WooCommerce and Akeneo
    • The source code is fully open for customization.

    Installing Module for Version 4.0.x to 5.0.x

    Please follow these steps for installing the WooCommerce Akeneo PIM Connector module in your Akeneo PIM platform.

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

    src-cms-1

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

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

    app-kernal-woocomerce

    in the return array.

    Step 3 – Copy the “config” folder into akeneo project root directory for routing.

    conf-cms-1

    Step 4 – Run this command after ssh to your akeneo server by the terminal

    php bin/console cache:clear--env=prod && php bin/console woocommerce:setup:install --env=prod 

    5. If you are using php-fpm. Then you need to restart the php-fpm services and apache web server.

    For Akeneo 5

    sudo service php-fpm7.4 restart
     

    To run the Quick export in Akeneo 5.0.x, you need to run the below command.

    Install composer dependency

    php -d memory_limit=4G /usr/local/bin/composer --prefer-dist --no-scripts require navneetbhardwaj/akeneo-quickexport-configurator;

    After that, register bundle in config/bundles.php

     

    Define routing to create a file in the config/routes/wk_quick_export.yml

     
     

    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;

    For Akeneo 4

     

    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 less;

    Installing Module for Version 2.x to 3.x

    Please follow these steps for installing the WooCommerce Akeneo PIM Connector module in your Akeneo PIM platform.

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

    src-cms-1

    Step 2 – Goto app/AppKernel.php then add line

          new Webkul\WooCommerceBundle\WooCommerceBundle(),

    in function registerProjectBundles()

    AppKernel.php files

    Step 3 – Goto app/config/routing.yml then add these lines at top of file woo_commerce: resource:

    woo_commerce:
            resource: "@WooCommerceBundle/Resources/config/routing.yml"
            prefix:   /

    Routing.yml file

    Step 4 – You have to navigate first to Akeneo installation directory (Ex: cd /opt/bitnami/apps/akeneo/htdocs). After SSH, you have to run the command to your Akeneo server by the terminal.

    php bin/console cache:clear--env=prod && php bin/console woocommerce:setup:install --env=prod 

    Step 5 – If you are using php-fpm. Then you need to restart the php-fpm services.

    sudo service php-fpm7.2 restart
     

     

    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
      Webpack error
      It means that webpack 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.

    WooCommerce API Integration

    The admin can easily generate API keys from the WordPress Admin backend. For this, the admin will navigate to WooCommerce -> Settings as per the below image.

    WooCommerce setting
    After that navigate to API -> Keys/Apps -> Add Key as per the below image.

    Create API keys
    The admin will be redirected to the Key Details page when the admin clicks on the Add Key button.

    Generate the key
    Here, the admin will:

    • Add the Description.
    • Select the WordPress admin User to generate the key for.
    • For this REST API key, choose Read/Write Permission as the level of access.

    After entering all the details, the admin will click the “Generate API Key” button. This will generate REST API keys for the selected user as per the below image.

    Consumer key and secret key

    Setup Credentials in Akeneo

    After installing the module in Akeneo, you need to set up the WooCommerce API keys in Akeneo. For this, log into Akeneo then navigate to WooCommerce Connector>Setup Credentials.

    • Shop URL
    • Consumer Key
    • Consumer Secret

    setup-credential-woocommerce

    Here, you will enter:

    • Your shop URL.
    • WooCommerce API Integration Tokens.
    • Then click the “Save” button.

    Attribute Mapping:

    After setting up the WooCommerce API keys in Akeneo, you need to map the product fields between WooCommerce and Akeneo as per the below image.

    attribute-mapping-woocommerce

     

    Note – If you want to export, long attribute slug to Woocommerce. so you need to do some changes in the Woocommerce end.

    – Go To Directory:

     ” wp-content/plugins/woocommerce/includes/wc-attribute-functions.php”

    – Go to at line no 486 and change 28 to <= 200

     

    Other Mapping:

    Attributes to be used as Images – The selected Akeneo image attributes will be visible as WooComerce product gallery images. Please note – The images will export in sorting order they are selected here.

    Attributes to be used as Export Attributes  When you are going to export the product from Akeneo to WooCommerce. The selected Akeneo attributes will be visible as attributes in WooCommerce. They will appear on the storefront under the ‘More Information’ tab.

    Non-Select Attribute send as Select Attribute – All non-select attributes like text, text area, etc will be exported as select type attribute.

    Send Metric Attribute with unit – In this unit like kg, gram, etc will be exported with metric value.

    Delete From Woocommerce after deletions from Akeneo – Enable this option if data like category, attributes are deleted from Akeneo will also be deleted from WooCommerce as well.

    Files to export as URL –  Export file like pdf as URL from Akeneo to WooCommerce.

     

    WooCommerce-Connector-Configuration-8

    Quick Export Currency Mapping 

    In this, you can select the default currency for quick export.

    WooCommerce-Connector-Configuration-9

    Product Association Mapping

    In association mapping, the product may be associated with none or several other products or product groups. If you want to do an association mapping you can map the product association fields in WooCommerce to Akeneo.

    Moreover, in this, you can do it for the Cross-Sell Products, and Up-sell Products.

    association-mapping-woocommerce

    Import Product Data

    You can import product data into Akeneo CSV Connector and Akeneo XLSX Connector. This will allow the Akeneo PIM to extract the data from the file then convert it to the store in the PIM database.

    Import the Product data

    For uploading the CSV or XLSX file, you can navigate to Imports>Create Import Profile after that enter Import Profile information such as Code and Label. In Job, select ‘Product import in CSV’ or ‘Product import in XLSX’ respectively then Save the profile.

    Create Product In Akeneo

    You can also create a product in Akeneo. For this, navigate to Products then click to Create button. Now, you need to choose your action – as Product or Product Model as per the below image. You can either select-

    • Product – if you want to create simple products.
    • Product Model –  if you want to create a variable product with variations.Create a product in Akeneo

    Now enter the SKU, choose a family,  then click the Save button as per the below image.

    Product Family – This is a set of attributes that will be the same for all products belonging to a family. The product family represents product type, imposes product information structure, and defines the list of attributes for a product that it belongs to.

    Choose a SKU and FamilyAdd Product Details

    After that, you need to provide information about the product. Enter the details like name, color, and upload the product image.

    Add product details

    Select Attribute

    For adding product information, select the attribute options you require. You can also create new options for the attribute. Following Attributes from Akeneo are supported for export:

    • Text
    • Text Area
    • Number
    • Date
    • Boolean
    • Select
    • Price
    • Metric
    • Image
    • Reference data select
    • Reference data multi-select
    • File

    You can also add a product description, visibility, and price.

    Product details

    Select attribute options to add product information as per the image.

    Product Information

    New Attribute Option

    If you require some additional attribute option or an attribute option is missing for a select attribute type. Then, in that case, you can create/add new options for the attribute.
    For this, enter a Code and Label, proceed further by clicking the Save button.

    New attribute option

    Additional Information:

    You can also add additional information such as product SKU, weight, and metric.

    Additional information

    Upload Image

    Click the upload picture section or use the drag and drop feature to add product images.

    Please note all the image attributes present in an Akeneo product are added as Product Media gallery images in WooCommerce.

    Add/upload product images

    Multi-Lingual Information

    Add information for other languages and store views.

    Multi-lingual information

    Select Category

    After entering all the product information, you can also select Categories for the created product.

    Select the categories

    WooCommerce Export Job

    To export the products, you first need to create the Export Profile. For this, navigate to Exports -> Create Export Profile as per the below image.

    WooCommerce export job
    This will redirect you to the Export Profile page. Here, you will enter a unique code, the label then selects a job profile.Create Export Profile

    After that in the Job field, you need to select the WooCommerce Export Job after that click Save.

    Select the job profile

    Filter The Data

    You can export the filtered data. For this, navigate to the Content section as per the below image.

    WooCommerce-Content-Export

    You can filter the data as per-

    • Channel – select the relevant channel of products to export.
    • Locales – select multiple Locales depending as per your choice.
    • Attributes – select the product attributes which you want to export. You can either select all attributes else click the Edit button to select the attributes.

    You will be navigated to the “Attribute” page when clicking the Edit button as per the below image.Attribute filter
    Here, click on the left side to select a specific attribute group. Then select the displayed attributes as per the choice.

    Filter The Products

    Akeneo enables you to decide which products to export on WooCommerce.filter the products

    Family

    Select one or more product families to export to WooCommerce. Family

    Status

    You can also filter on the status of your products as per the below image.Product status
    All – export all products whatever their status is
    Enabled (default option) – only export enabled products
    Disabled – to only export enabled products

    Completeness

    This enables you to filter on the completeness of selected locales.Product completeness
    No condition on completeness – all products will be exported whatever their completeness is.
    Complete on at least one selected locale (default option) – products must be complete on at least one locale
    Complete on all selected locales – products must be complete on all locales (if you have selected more than
    one locale).
    Not complete on all selected locales – products must not be complete on all locales (if you have selected
    more than one locale).

    Time Condition

    You can now export your product on a specific time condition.Time condition

    • No date condition (default option) – Products are not filtered using time conditions.
    • Updated products over the last n days (e.g. 6) – To filter the products that were updated during the last six days, enter 6 value.
    • Updated products since this date – To filter the products that were updated during a specific date, select a date.
    • Updated products since last export – To filter the products that were updated during the last update.

    Category

    You can configure the categories you want to export.Select the category

    By default, all categories are exported. To select a category, click n the Edit button the categories of the channel tree are displayed.category selection

    Identifier

    You can select product identifiers to export the product. You can select multiple product identifiers that should be separated by comma, space, or line breaks.

    Identifier

    After that click the Save button.

    Click on the save button

    Export Now

    After creating the export profile, click on the Export button as per the below image.

     

    Export-profile-WooCommerce-Export-All-Show

    Execution Process

    After the execution of the export process, you can check the process summary and errors if present.

    Execution details

    WooCommerce Store

    After the completion of the export process, you can check the products in WooCommerce catalog. The admin can view the products and make any changes in the product edit form of WooCommerce as per the below image.

    WooCommerce store

    Stock Information

    Since in WooCommerce the products will not be available to add them to cart until they are In Stock status. So enter the Stock Quantity and change the stock status to In Stock.

    Stock Information

    Store View

    Imported  Akeneo products will appear on the storefront as per the image.

    Store ViewExported Categories:

    The store owner can view the exported categories of Akeneo by navigating Products -> Categories as per the below image.

    Exported categories

    Exported Attributes:

    The store owner can view the exported attributes of Akeneo by navigating Products -> Attributes as per the below image.

    Exported attributes

     

    WooCommerce Import Profile

    Now in the updated Akeneo Connector, you can now import your product catalog data from WooCommerce to Akeneo. There are various job profiles available for importing products, categories, attributes, attribute sets from Magento to Akeneo.

    To do the import go to Imports>Create Import Profile, enter a code and label. Following job profiles are available:

    WooCommerce Import -This will import everything from WooCommerce. All products, categories, attributes, attribute sets.

    Families Import – This will import all attribute sets of WooCommerce into Akeneo families.

    Product Import – This will import all the products of WooCommerce.

    Category Import – This will import all the WooCommerce categories to Akeneo.

    Attribute Import – This will import all the attributes from WooCommerce to Akeneo.

    woocommerce-import-job

    Once you have selected the import job profile, from the Content section, you can select the channel and locales for import product data. You can also import multi-language data from WooCommerce to Akeneo.

    import-product-1

     

    Once everything is set up correctly, you just need to click the Import Now button.

    import-now

     

    After that, the import execution process will start. From the following screenshot, you can see the number of categories, attribute groups, attributes, etc are being imported to Akeneo.

    Import-executions-Details-1

     

    Support

    So, that was much about the User Guide of WooCommerce Akeneo PIM Connector 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 - 3.0.0

    Supported Framework Version - Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x and 5.0.x

    Blog Version - Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x and 5.0.x
    • Version Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, and 3.1.x
    • Version Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x and 5.0.x
    • Version Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x and 4.o.x
    • Version Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x and 4.0.x
    • Version Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x and 3.2.x
    . . .
    Discuss on Helpdesk

    Leave a Comment

    Your email address will not be published. Required fields are marked*


    Be the first to comment.

    Back to Top

    Table of Content

    Hide Index