Reading list Switch to dark mode

    Akeneo WooCommerce WPML Integration

    Updated 15 April 2024

    Introduction

    With the help of this add-on connector, you can export your product information in multiple languages from Akeneo to the WooCommerce store. It works with simple and variable products. Akeneo WooCommerce WPML Integration add-on also exports the categories, attributes, and attribute terms in multi-languages.

    Please Note:

    • WooCoomerce Akeneo Connector is required to use this Akeneo WooCommerce WPML Integration add-on.
    • Akeneo WooCommerce WPML Integration is compatible with Community Edition, Enterprise Edition, and Cloud (PaaS/Flexibility) Edition of Akeneo.

    Basic Requirements

    • You must be using  WooCommerce 2.1 or newer.
    • Compatible with WooCommerce WPML API (plugin) Version 1.0.2
    • Compatible with WooCommerce Akeneo Connector Version 5.3.0
    • This module works with 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, 5.0.x, 6.0.x and 7.0.x. Download Akeneo from here

    Features

    • Categories export in multiple languages to WooCommerce.
    • Export attributes and attribute options in multiple languages to WooCommerce.
    • Products Exports in multiple languages to WooCommerce
    • This module is compatible with the latest Akeneo version 7.0.x
    • Export product variations in multiple languages to WooCommerce.
    • Source code is open for customization.

    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 WPML

    oCmBjCe334U

    Installation

    Two different types of module installation processes are available for the module.

    1. Composer Installation
    2. Manual Installation

    Installation using Composer Installation

    Read This Blog

    Searching for an experienced
    Akeneo Company ?
    Find out More

    Before beginning the composer installation:

    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 6. x and 7.x

    {	
      "scripts": {	
            "post-update-cmd": [	
               "vendor/webkul/wpmlproductbundle/src/Webkul/WpmlProductBundle/install/config.sh COMPOSER=true NO_DOCKER=true"	
            ],	
            "post-install-cmd": [	
               "vendor/webkul/wpmlproductbundle/src/Webkul/WpmlProductBundle/install/config.sh COMPOSER=true NO_DOCKER=true"	
            ],	
            "post-create-project-cmd": [	
              "vendor/webkul/wpmlproductbundle/src/Webkul/WpmlProductBundle/install/config.sh COMPOSER=true NO_DOCKER=true"	
           ]	
       },	
      "repositories": [{	
        "type": "composer",	
        "url": "https://akeneorepo.webkul.com/"	
      }]	
    }	
    

    For Akeneo <=5. x 

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

    3: Use composer to install the extension.

    composer require webkul/wpmlproductbundle

    4: Complete the authentication form.

    5: Send a Message of Success

    6: Delete your browser’s cache.

    Manual Installation For Akeneo 6 and 7

    •  After unzipping the appropriate extension zip, merge the “src” folder into the akeneo project.
    • From the PIM directory, run the following command over the NO-DOCKER Instance.
    ./src/Webkul/WpmlProductBundle/install/config.sh COMPOSER=false NO_DOCKER=true
    •  Run the command below over the PIM directory’s DOCKER instance.
    ./src/Webkul/WpmlProductBundle/install/config.sh COMPOSER=false NO_DOCKER=false

    Manual Installation for Version 4.0.x to 5.x

    Before installing the Akeneo WooCommerce WPML Integration module in the Akeneo Pim you have to install the WooCommerce Akeneo Connector module. You can get information about the installation process from this link.

    Install WooCommerce Akeneo Connector module

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

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

    src-cms-1-1

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

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

    Screenshot-from-2020-10-16-14-11-07

    in the return array.

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

    conf-cms-1-1

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

    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

    For Akeneo 4

    sudo service php-fpm7.3 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;
    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;

    Manual Installation For Version 2. x to 3. x

    Before installing the Akeneo WooCommerce WPML Integration module in the Akeneo Pim you have to install the WooCommerce Akeneo Connector module. You can get information about the installation process from this link.

    Install WooCommerce Akeneo Connector module

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

    • Unzip the respective extension zip then merge the “src” folder into the Akeneo project root directory.
      Manage Src folder to Akeneo project root directory
    • Goto app/AppKernel.php then add the line
      Add the code in AppKernel.php file
    new Webkul\WpmlProductBundle\WpmlProductBundle(),

    in function registerProjectBundles()

    • Goto app/config/routing.yml then add these lines at top of the file
      Add the code in routing.yml file
    WpmlProduct:
        resource: "@WpmlProductBundle/Resources/config/routing.yml"
        prefix:   /
    
    • You have to navigate to Akeneo Installation Directory(Ex. cd /opt/bitnami/apps/akeneo/htdocs ). Run this command after ssh to your akeneo server by the terminal
    php bin/console ca:cl --env=prod;php bin/console woocommerce:setup:install --env=prod;
    • You have to restart your web server like Apache, Nginx. Then, run the command for Apache web server.
    • If you are using php-fpm. Then you need to restart the php-fpm services.

    sudo service php-fpm7.2 restart

    Common Issue After Installation

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

    • Webpack Installation: If you get the below errorWebpack error

    It means that a 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.

    Uninstall Module: For Akeneo 6 and 7

    • From the PIM directory, run the command below over the NO-DOCKER Instance.
     ./src/Webkul/WpmlProductBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=true
    • Run the command below over the PIM directory’s DOCKER instance.
     ./src/Webkul/WpmlProductBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=false

    WooCommerce API Integration

    After installing the module in Akeneo you have to go to your WordPress admin dashboard. Here you will get the Woocommerce plugin icon then navigate to Woocommerce -> Setting.

    WooCommerce API integration

    After clicking on the setting, you have to generate the API Keys.

    For it, you have to generate the key to navigate WooCommerce -> Settings – > Advanced -> Rest API -> Add Key.

    Add a key in REST API WooCommerce

    Now you have to enter Description, username, and Permission.

    Add details to generate the API key

    Click on the generate API keys. Now you can see your API key is generated.

    Generated API keys

    Install WPML Plugin

    After that, for using WooCommerce WPML Akeneo Connector you have to install the WPML plugin in WooCommerce. You Have to go for Plugin – > Add new and search for the WPML plugin then install it in WooCommerce.

    Install WPML plugin

    Setup Credentials In Akeneo

    After successfully installing the module in Akeneo, you need to set up the WooCommerce Akeneo Connector credentials in Akeneo. The user can log into Akeneo and then follow WooCommerce Akeneo Connector -> Setup Credentials.

    WooCommerce-Connector-Configuration-3

    Then click on Add credentials. Here you have to fill in the details.

    • Shop URL
    • Consumer key
    • Consumer Secret key

    WooCommerce-Connector-Configuration-1-1

    Then click the “Save” button. If you want to edit the credentials click on the credential which you have created.

    WooCommerce-Edit-Credential

    Mapping 

    In the Mapping tab, you need to match the product fields between WooCommerce and Akeneo. You need to select the correct Akeneo attribute that matches the Woocommerce product information.

    • Slug
    • Product Name
    • Price 
    • Weight
    • Length
    • Width
    • Height
    • Description
    • Short Description
    • Quantity
    • Is Featured?
    • Purchase note
    • Reviews Allowed?
    • Backorders Allowed

    WooCommerce-Edit-Credential-1

    Other Mappings

    We can also map some other Akeneo attributes with WooCommerce.

    • Attributes to be used as Images: Here you can export the product images with the Akeneo products.
    • Attributes to be used as Custom Fields: You can export the products attribute like color for multivariant products.
    • Non-Select Attribute send as Select Attribute
    • Send Metric Attribute with the unit
    • Files to export as URL
    • Delete From Woocommerce after deletions from Akeneo(Category, Attribute, Options, Products)

    WooCommerce-Edit-Credential-2

    Quick Export Currency Mapping

    When you are going to export the products you can map currency. A merchant can set the currency for the end-users.

    WooCommerce-Edit-Credential-4

    Enable WooCommerce WPML Connector in Akeneo

    Here you can enable the WooCommerce WPML Connector in Akeneo. The WPML makes it easy to build multilingual sites and run them. Here you will get two options.

    Enable WPML Export: Here you can export the product in multilingual. Your end-user can see the product in a different language. WooCommerce WPML Integration add-on also exports the categories, attributes, and attribute terms in multi-languages.

    WPML export in Locales: When you set the WPML to enable you can see the WPML Export locales. You can select the different locales then export the products.

    WooCommerce-Edit-Credential-5

    Create Product In Akeneo

    To create a product in Akeneo, go to navigate to Products then click the “Create” button. Now, you need to choose the product type – Product or Product Model.

    Product – Select this type for creating simple and virtual products.

    Product Model – Select this type for creating a configurable product with variations.

    Create a product in Akeneo

    Now enter the required SKU, choose a family, then click the Save button.

    Product Family – A family 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.

    Product Family

    Add Product Details

    Now you need to provide information about the product. First, select the Channel and Locale then enter the details.

    To export data in multi-language to your WooCommerce store, you must enter data it in all languages you want to export.

    English:

    Product-Hat-Edit-8

    German:

    Product-Hat-Edit-7

    French:

    Product-Hat-Edit-9

    Select Attribute

    For adding product information, select the attribute options you require. You can also create new options for the attribute. You can check further attributes that Akeneo supports:

    • Product Name
    • Image
    • Price
    • Weight
    • Length
    • Width
    • Height
    • Description
    • Short Description
    • Quantity

    Product-Hat-Edit-1

    Multi-Lingual Information

    Add information to other languages and store views.

    Product-Hat-Edit-2

    Add New Attribute Option

    If an attribute option is missing for a select attribute type (simple or multi-select), you can directly add it to the Product Edit Form. Enter a Code and Label values, then click Save.

    Product-Hat-Edit-3

    Upload Image

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

    Product-Hat-Edit-4

    Select Category

    After entering all the product information, save your changes, then go to Product Navigation then select Categories.

    Product-Hat-Edit-5

    WooCommerce Export Job

    Now to export your product data in multi-language you need to create a job profile and then execute it. First, go to Exports>Create Export Profile.

    Export-profiles-management-13

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

    Create export job in Akeneo

    Job Profiles

    WooCommerce WPML Product Export:  Exports everything (categories, attributes, attribute options, attribute group families, and products) based on filters in a job. A product must have a category to be included in the export job.

    Export-profiles-management-14

    Filter The Data

    Now go to the Content section then select the following options:

    In this section, you have to select all the languages which you want to export to your woo-commerce store.

    Select Active Credentials: In this, you have to select the credential in which you want to export the data.

    Channel – Each export job can only be linked to one channel, please select the relevant channel of products to
    export.

    Locales – Select one or more Locales depending on your requirements.

    Attributes – You can select which product attributes you want to export all or a few of them. Click the Edit button to select the attributes.

    Export-profile-WooCommerce-Export-Job-Edit-1-1

    Filter The Products

    Now you need to decide which products to export on WooCommerce WPML.

    Export-profile-WooCommerce-Export-Job-Edit-2

    Family

    Select one or more product families to export to WooCommerce WPML. If you want to export products belonging to specific families, click on the drop-down list then click on the families to add in the field like clothing, shoes, and t-shirts.

    Family in Akeneo export profile

    Status

    You can also filter on the status of your products, three options available:

    filter the products with status

    • All – It will export all the products.
    • Enabled – Only enabled products.
    • Disabled – Only disabled products.

    Completeness

    This enables you to filter on the completeness of selected locales. Further, the four options for completeness are proposed:

    Filter the product with completeness

    • No condition on completeness – All the 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 – The 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 within a specific time condition. You can check the furthermore option.

    Filter the product with 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 the 6 value.
    • Updated products since this date – To filter the products that were updated during a specific date, select a date.
    • Updated products since the last export

    Category

    You can configure the categories of the channel tree you want to export. For example, you want to export clothing products to update.

    Filter the product with categories

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

    Categories selection

    Identifier

    You can make a selection of identifiers to export by adding them to the SKU field. You can copy then paste a list of identifiers, and separate them by using commas, spaces, or line breaks.

    Identifier

    After that, click the Save button then follow the next step to execute this profile.

    Export-profile-WooCommerce-Export-Job-Edit-3

    Export Now

    After creating the export profile, click on the Export button. The execution of the export process will begin, and the page will refresh continually to update the information.

    Export-profile-WooCommerce-Export-Job-Show

    Execution Process

    The user can wait for the execution process to complete and then check the errors. After that, after the completion of the export job, the products will appear in the WooCommerce WPML product list.

    Process-tracker-Show-job-16

    WooCommerce Store

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

    The user can click on “Product” and then “All Products” to see the exported multi-languages products data from Akeneo.

    Products-‹-WooCommerce-WPML-—-WordPress

    WooCommerce Product List

    With the help of WooCommerce WPML Integration, you can filter the product according to the languages. The end user can see the product content in further languages exported from Akeneo.

    Products-‹-WooCommerce-WPML-—-WordPress-1

    WooCommerce Product Category View

    Here you can see the multi-language product category exported from the Akeneo. Now you can filter the product category with the use of WooCommerce WPML integration.

    Product-categories-‹-WooCommerce-WPML-—-WordPress

     

    Product in Store

    You can see the product on the website. You can also choose the language exported by you for the products.

    Hat-–-WooCommerce-WPML-1-

    Support

    So, that was much about the User Guide of Akeneo WooCommerce WPML Integration 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 - Akeneo 2 to 5 || 3.0.0, Akeneo 6 || 4.0.0 and Akeneo 7 || 5.1.1

    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, 5.0.x, 6.0.x and 7.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, 5.0.x, 6.0.x and 7.0.x
    • Version Akeneo 2.0.x, 2.1.x, 2.2.x, and 2.3.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, 5.0.x, 6.0.x and 7.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, 4.0.x, 5.0.x and 6.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, 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.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
    . . .

    Leave a Comment

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


    Be the first to comment.

    Back to Top

    Message Sent!

    If you have more details or questions, you can reply to the received confirmation email.

    Back to Home

    Table of Content