Menu Close
    Convert your store into Shopify Multi Vendor Marketplace

    Akeneo Connector for Shopify

    Introduction

    Akeneo Connector for Shopify allows you to integrate your Shopify store with the Akeneo PIM platform. Using Shopify Akeneo Connector you can add and update products, collections, and variants from Akeneo to Shopify. Various product details can be exported such as- title, description, multiple images, SEO information, SKU, barcode, price, compare at price, quantity, weight, etc.

    Please Note -Akeneo Connector for Shopify is also compatible with Shopify Plus.

    Basic Requirements

    Before you begin, please see the minimum requirements for using this module:

    • You need to create a Shopify private app for Akeneo integration.
    • 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.
    • For exporting images to Shopify, HTTPS protocol should be enabled on the Akeneo server.
    • 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 and 5.0.x. Download Akeneo from here

    Video Tutorials

    Check out the following video tutorials below:

    How to get API keys?

    bchpsznJ7ug

    How to do module configuration?

    https://www.youtube.com/watch?v=hGlq4njuiPA&t=121s

    Exporting Simple Product from Akeneo to Shopify

    I_rcbm4QK-0

    Features

    • Export Akeneo categories as ‘Collections’ in Shopify
    • Export product data including variations
    • Specify variation’s price, SKU, quantity, barcode, weight
    • Send multiple product images to Shopify
    • Update exported products on Shopify by running the export job again.
    • Map Akeneo attributes with Shopify product details.
    • Added for configuring multiple Shopify store
    • New updated mapping for meta fields like String, Integer, and Json_string for export jobs.
    • Set fixed values for exported products in Akeneo settings.
    • This module support Shopify version 2020-07, 2020-04, 2020-01, and 2019-10
    • Export quantity, barcode, weight, product type, vendor, tags with product data.
    • Send SEO information – page title, meta description, URL
    • Akeneo Connector for Shopify is compatible with the latest Akeneo version 5.0.x
    • Mention price and compare at price.
    • Added import mapping with matched SKU and create a new mapping to prevent duplicate products.
    • Specify “Charge taxes on this product” is required or not.
    • Export metric unit with tags.
    • Filter products to export based on – category, families, completeness, time condition, status
    • The export specific product(s) using the identifier (SKU)
    • Connect multiple Shopify stores with Akeneo by providing separate credentials
    • Link variant image of the product to its variation
    • Compatible with the Shopify Plus platform also.
    • Quick export functionality included for exporting a selection of products.
    • Shopify Meta Fields mapping is supported.
    • Import products, variations, categories, attributes from Shopify to Akeneo.
    • Using Shopify standard attribute code, you can map additional attributes for imported products.
    • The source code is 100% open for customization.
    • Quick export currency mapping
    • Multiple attribute mapping by concatenating the attributes

    Shopify API Credentials

    You need to create a private app for integrating the Shopify store with Akeneo PIM. The private app gives access to your store’s data directly using Shopify’s APIs.

    Then to generate the required credentials, please follow the further steps:

    From your Shopify admin, go to Apps.

    Click Manage private apps.

    shopify app

    Click Create a new private app button

    create private app

    In the Description section, enter any Private app name.

    app details

    In the Permissions section, select Read and write access for Products, variants, and collections.

    read and write access

    Then, click ▼ Review disabled Admin API Permissions and select Read and write access for Product information

    read and write access- product information

    Also, select Read and write access for Inventory (Note: Available for Shopify Store created after 1 July 2018).

    Inventory-Access

    When you’re done, click Save. The API key and password for your app will be displayed on the screen. You just need to copy the API key and Password.

    Copy API and password

    Installing Module for Version 4.0.x to 5.0.x

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

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

    src

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

    appkernal

    in the return array.

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

    conf

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

    php bin/console cache:clear--env=prod;
    php bin/console ca:warmup && php bin/console shopify:setup:install

    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

    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

    return [
       \WebkulQuickExportConfiguratorBundle\QuickExportConfiguratorBundle::class => ['all' => true],
    ];

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

    wk_quick_expoort:
       resource: "@QuickExportConfiguratorBundle/Resources/config/routing.yml"
       prefix: /

    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 2.x to 3.x

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

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

    src

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

    new Webkul\ShopifyBundle\ShopifyBundle(),

    in function registerProjectBundles()

    shopify-akeneo-connector-installation

    3 – Goto app/config/routing.yml and add these lines at the top of the file.

    shopify:
        resource: "@ShopifyBundle/Resources/config/routing.yml"
        prefix:   /

    shopify-akeneo-connector-installation.png

    4 – You have to navigate to Akeneo Installation Directory(Ex. cd /opt/bitnami/apps/akeneo/htdocs ) then run this command after ssh to your akeneo server by the terminal.

    php bin/console cache:clear--env=prod;
    php bin/console ca:warmup && php bin/console shopify:setup:install

    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 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 Akeneo Credentials

    To add credentials navigate to Shopify Connector >> Create Shopify Credentials.

    Webkul-Shopify-Connector-Configuration-3

    Now log in to your Akeneo panel then go to the Shopify Connector menu option. In the Credentials tab, you need to enter your Shopify store URL, API key, and Password.

    You can add multiple Shopify stores for configuring

    Webkul-Shopify-Connector-Configuration-2

    Attributes Mapping

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

    Please go to the Attributes Mapping tab. On the left, you will find all the product fields that can be synchronized with Akeneo attributes. In the middle, you need to select the attribute of Akeneo which will be mapped with the Shopify product field.

    Following attributes can be mapped:

    • Name
    • Description
    • Price
    • Stock Quantity
    • Vendor
    • Product Type
    • Tags
    • Barcode (ISBN, UPC, GTIN, etc.)
    • Compare at price
    • Meta Title
    • Meta Description
    • URL and handle
    • Taxable (1/0)
    • Fulfillment Service

    Webkul-Shopify-Connector-Configuration

    Use This Fixed Value – In case you want to use any definite (same) value for the attribute, you can enter it on the right. But, please note that all the exported products will be using this mentioned attribute value.

    For eg., If you want the weight of all the exported products to be 1, then you need to deselect the Akeneo attribute in the middle and enter 1 as the fixed value on the right. Now, all the exported products’ weight will be shown as 1 in Shopify.

    fixed value

    Map Existing Categories of Shopify with Akeneo

    For avoiding duplication of attributes, categories, and features creation in PrestaShop, therefore you must do the mapping of these existing data with Akeneo first go to Product Field Mapping>Map Product/Category.

    Webkul-Shopify-Connector-Configuration-1

    Click the Create Mapping button for creating a new mapping for a category, attribute, or feature.

    Shopify-Connector-Export-Mapping-Index

    Select Mapping Type as – CategoryAttribute, or Feature.

    Then, select Akeneo value and Shopify value accordingly after that click Save.

    Shopify-Connector-Export-Mapping-Index-1

    Shopify Other Mapping –

    Image Mapping – Provide the attributes created as image type which you want to export to your Shopify store.

    Association Mapping  – Associations like Cross-Sell, Upsell, Substitution, etc can be mapped in meta fields.

    cross selling

    Attribute to be used as Meta field – If you want to export Meta fields to Akeneo, simply create the required attributes in Akeneo and then select them from Attributes to be used as Meta Fields option. There will be three option-

    • String
    • Integer
    • Json_string

    map field

    Quick Export Currency Mapping – From this option, you need to select the currency for the export job. After that, the selected currency attribute value will be used for all quick export jobs.

    quivk export

    Import Attributes Mapping

    After the release of Akeneo Connector for Shopify version 2.0.0, the module now supports bi-directional synchronization. This means you can now send as well receive your product data between Shopify and Akeneo.

    In the Import Attributes Mapping section, you need to configure some settings so that import functionality works properly:

    import attribute mapping

    Map More Attributes – 

    If your products have lots of information, you can enter Shopify attribute code ID and click Add Field. Shopify Akeneo Connector module supports various attributes of Shopify products. Please make sure to use the same attribute code of Shopify in Akeneo.

    add fields

    Shopify Other Mappings-

    Set Family (for simple products) –  From this option, you need to select an Akeneo family for imported products. All the simple products imported from Shopify store will come under this family.

    Set Common Images – From here, you need to select the Akeneo image attributes which will be the common images for the product model. This option is meant for Shopify imported products with variants. Make sure you have created the required attributes in Akeneo already.

    Set Variant Image – From here, you need to select an Akeneo image attribute which will be mapped with Shopify imported product variant’s image.

    Import Smart Collection as Collection – With this you can Import collection in Akeneo with smart collection.

    shopify other mapping

    Other Setting –

    Logs Setting –

    In other settings, you can Enable API Request Logs and Enable API Response Log in you can check all the export/import processing. If there is any error or issue in the export/import process that will be visible.

    other setting

    Tags Export Setting

    These tags will be exported from Akeneo to Shopify. There will be three types to export the tag –

    You want to pull tags as Named Tags – In this, you can export tags as Named tags.

    Do you want to pull through the attribute name as well in tags – In this, you can export name and tags both then name and tags will be separated by a dash, colon, space.

    Do you want to pull through the Metric UNIT name as well in tags – In this, you can export metric value when you will enable this unit will also be exported as well.

    tags export setting

    Meta Fields Export Setting –In this, you can export the meta field with Use key and UseNamespace. There will be two types –

    • Use Key for Meta Field as Attribute Code / Label – selected attribute will be exported through attribute code/attribute lable.
    • Use Namespacefor Meta Field as Attribute Group Code / global – Selected attribute can be exported through attribute group code or global.

    meta fields

    Other Settings –
    other setting

    Creating Product in Akeneo

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

    Product – Select this type for creating a simple product.

    Product Model – Select this type for creating a product having multiple variations such as colors, sizes.Select the product type

    Now enter the required SKU, choose a family, and 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 products type, imposes product information structure and defines the list of attributes for a product that it belongs to.set sku and family

    Add Product Details

    Now you need to provide the basic details about a product such as a name, description, weight, price, etc.enter product details

    Select Attribute

    For adding product information, select the attribute options you require. You can also create new options for the attribute. You can export furthermore attributes from Akeneo to Shopify:

    • Name
    •  Description
    • Price
    • Weight
    • Stock quantity 
    • Inventory policy
    • Allow customers to purchase this product when it’s out of stock
    • Vendor
    • Product type
    • Tags
    • Barcode
    • Compare Price
    • Meta Title
    • Meta Description
    • URL and handle
    • Taxable (1/0) 
    • Fulfillment Service

    other product information

    Mention the product’s price and its compare at price (if any). Then, you can mention the search engine listing information – page title, description, URL.

    price and seo

    Add New Attribute Option

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

    Add attribute option

    Upload an Image

    In this connector, we can upload the images. We can click on the image attribute to add an image. After it, we can delete, change, and download the image.

    Upload an Image

    Select category

    Select a category for the product from the left panel and use the checkbox.

    Select a category

    Creating Product Variants

    To create a product with variations, go to Products>Create and select the Product Model.

    select product modelThen, enter a Code, select Family, and select Variant. In Variant, you need to select how the variations will be created.create product model

    Then, enter the basic product details which are common to all the variations. You can mention the product name, description, vendor, product type, taxable, upload images, SEO information,product model - information

    To add a variation, click down arrow symbol.Create a variant product

    Then, mention variant axis such as size, color and enter SKU for variation product.add new variation Once the variation product is created, you can mention its price, compare at price, barcode, weight, quantity.variation information

    Creating Export Job

    Now to export your product data you need to create a job profile. First, go to Exports>Create Export Profile and enter a unique code, label and select Shopify Export Job.create export job - shopify

    Credentials for Multi-Store

    If you have multiple stores in Shopify, you can enter the store credentials here by going to the Credential section.

    Export-profile-Shopify-Export-Only-Product-Edit

    After saving the export profile, go to the Content section and select Locale and Currency for the exported products.channel-currency

    Filter Products to Export

    You can decide which products you want to export and filter them using various options. To export a specific product you can enter its SKU in Identifier.

    Filter the product

    Filter product based on categories selection and click Confirm.Filter the product with category

    Execution Process

    Once you have filtered the products and saved your export job profile, click the Export Now button.

    export now

    After the completion of the execution process, you can see the number of products exported from Akeneo to Shopify, and also see the status as completed.Execution details completed

    View Products in Shopify

    You can see the products have been created using Akeneo mentioning all the product details.

    Product in Shopify store

    You can edit and update any product information as you like.

    Variant product details

    All the variation information will also appear mentioning inventory, price, SKU. SEO information can also be seen here.

    Variant product details at Shopify

    Shopify Storefront

    Once the export job is complete, the products will appear on the storefront. The customer will see the name, price, images, and description on the product page.

    shopify simple product

    Products with Variations

    All the variations will be available and the option name will also appear on the product page.

    variation products on shopify

    Shopify Quick Export

    Akeneo Connector for Shopify module also supports Quick Export functionality. It basically allows you to export some selection of products without going through the process of creating an export job profile and following the long procedure.

    webkul-shopify-akeneo-connector-quick-export

    To do quick export, simply select product(s), go to Quick Export option and choose Shopify Export (All Attributes).

    webkul-shopify-akeneo-connector-quick-export-select

    Once you click the Quick Export option, the execution process will run. You can check the details from the notifications section and check the progress in proccess tracker.

    proccess tracker

    Import Job

    For importing product data from Shopify to Akeneo, go to Imports>Create Import Profile.

    There are Category, Attribute, family, product, product model types of import jobs in Shopify Akeneo Connector.

    Import-profiles-management

    Now enter a code, label, and select Job as Shopify Import Product.

    webkul-shopify-akeneo-connector-import-job-profileNow, go to Content and select the appropriate channel, locale, and currency for importing Shopify products to Akeneo.

    content

    In case you are managing multiple Shopify stores, you can select the store credential from the drop down, and click Save.

    Import-profile-Shopify-Import-Product-Edit-1

    After that, click the Import Now button to execute the import process.

    webkul-shopify-akeneo-connecto-import-process-1-1

    Import profile – Shopify Delete / Reimport Product Data Mapping

    Using this import job you can delete the export product mapping which is deleted from Shopify.

    Create an import profile then enter the details

    Export-profile-Shopify-Delete-Reimport-Product-Data-Mapping-Edit-1

    After that, click the Import Now button to execute the import process.

    import-mapping

    Support

    Thank you for reading this documentation. In case you have an issue with this module, please create a support ticket at – https://webkul.uvdesk.com/en/customer/create-ticket. For further queries or customization discussions, please send an email to [email protected]

    Current Product Version - 3.0.0

    Supported Framework Version - Akeneo Version 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 Version 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 Version 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, and 3.1.x
    • Version Akeneo Version 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, and 3.2.x
    • Version Akeneo Version 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 Version 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
    . . .
    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