BigCommerce Akeneo Connector

Live Demo

Live Demo How to get API keys? How to do module configuration? Exporting Simple Product from Akeneo to BigCommerce

BigCommerce Akeneo Connector allows you to connect your BigCommerce store with the Akeneo PIM platform. With the help of this integration, you can manage your entire catalogue from Akeneo.

Using this module, you can export products, categories, product options, media images, attributes, custom fields, and multiple images, from Akeneo to the BigCommerce store.

Basic Requirements:

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.
Node and Yarn packages need to be installed.
This module is compatible with the Akeneo PIM Community Edition, Growth Edition, and Enterprise 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?

How to do module configuration?

Exporting Simple Product from Akeneo to BigCommerce

Features – BigCommerce Akeneo Connector

Create product categories from Akeneo.
Export selected attributes as custom fields from Akeneo to the BigCommerce store.
Send multiple images of a product including variations.
Mention SEO information, inventory, pricing, shipping, and other details in products.
Option to set fixed values for all exported products.
With the help of UI Mapping Export Custom Field’s Default Value.
Export the value of the variant in the custom field.
Remove the 0s at the end of the number of the metric unit.
Import Category, Attribute, Attribute Option, Family, Product and Product Model from BigCommerce to Akeneo.
Able to export Metrics attribute type in the custom field.
When exporting Metrics type, added the Unit to the end of the number.
Ability to export multiple select field attribute types and each option is separated by a comma.
You can add any number of credentials.
This module is compatible with the latest Akeneo version 7.0.x
Choose which products to export using various filters- category, family, completeness, time conditions, locale, and currency.
Use identifier (SKU) for exporting specific products to the BigCommerce store.
Compatible with Akeneo Visual swatch attribute.
Product Model with visual swatch type attribute as axis export to BigCommerce store.
Option to export modifiers from Akeneo to BigCommerce.

BigCommerce API Credentials

Before you begin, you need to obtain API credentials from the BigCommerce control panel. Log in to your store then follow Settings>Account API Tokens>Create API Token. Now enter any name for this API account then copy the API Path URL.

After that, you need to select the ‘modify‘ scope for ‘Products‘ and Information & Settings options after that click to Save.

Once, you click the Save button; the API credentials will be visible to you, please copy them securely. Also, a text file will be downloaded automatically containing these credentials.

Composer Installation

Read This Blog

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 & 7.x

{
   "scripts":{
      "post-update-cmd":[
         "vendor/webkul/bigcommerceconnector/src/Webkul/BigCommerceBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
      ],
      "post-install-cmd":[
         "vendor/webkul/bigcommerceconnector/src/Webkul/BigCommerceBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
      ],
      "post-create-project-cmd":[
         "vendor/webkul/bigcommerceconnector/src/Webkul/BigCommerceBundle/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/bigcommerceconnector/composer_install.sh"
      ],
      "post-install-cmd":[
         "vendor/webkul/bigcommerceconnector/composer_install.sh"
      ],
      "post-create-project-cmd":[
         "vendor/webkul/bigcommerceconnector/composer_install.sh"
      ]
   },
   "repositories":[
      {
         "type":"composer",
         "url":"https://akeneorepo.webkul.com/"
      }
   ]
}

3: Use composer to install the extension.

composer require webkul/bigcommerceconnector

4: Fill out the authentication.

5: Success Message.

5: Clear your browser’s cache.

Manual Installation For Akeneo 6 and 7

Unzip the respective extension zip and then merge “src” folder into akeneo project
Run the below command over the NO-DOCKER Instance from the PIM directory.

./src/Webkul/BigCommerceBundle/install/config.sh COMPOSER=false NO_DOCKER=true

Run the below command over the docker Instance from the PIM directory

./src/Webkul/BigCommerceBundle/install/config.sh COMPOSER=false NO_DOCKER=false

Manual Installation for Version 4.0.x to 5.0.x

For installing this module in Akeneo, please follow the below steps as mentioned:

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

2. Goto config/Bundles.php and add the line:

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

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

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 the bundle in config/bundles.php

Webkul\QuickExportConfiguratorBundle\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: /

5. You have to navigate first to the 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 ca:cl --env=prod && php bin/console bigcommerce:setup:install

6. 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;

Installing Module for Version 2.x to 3.x

For installing this module in Akeneo, please follow the below steps as mentioned:

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

2. Goto app/AppKernel.php and add a line

in function registerProjectBundles()

new Webkul\BigCommerceBundle\BigCommerceBundle(),

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

big_commerce:
    resource: "@BigCommerceBundle/Resources/config/routing.yml"
    prefix:   /

4. You have to navigate first to the 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 ca:cl --env=prod && php bin/console bigcommerce:setup:install

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

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
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.

Uninstall Module For Akeneo 6 & 7

Run the below command over the NO-DOCKER Instance from the PIM directory

./src/Webkul/BigCommerceBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=true

Run the below command over the docker Instance from the PIM directory

./src/Webkul/BigCommerceBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=false

Setup Credentials in Akeneo

After successfully installing the BigCommerce Akeneo Connector module, please log in to your Akeneo platform then navigate to BigCommerce Connector>Setup Credentials.

After that click on the Create Credentials. The following page appears, when you need to enter the following:

API Path
Client ID
Client Secret
Access Token

Credentials:

You can add multiple credentials in BigCommerce Akeneo Connector. You need to activate the credentials to export the products from Akeneo to Bigcommerce. The active credential will be visible at the time of creating an export profile.

You can also enable the option to Quick Export the products from the Akeneo product grid.

Activated
Default for QuickExport

Attribute Mapping

You need to do the attribute mapping of Akeneo attributes with BigCommerce product fields.

While exporting products from Akeneo to BigCommerce, various information is sent to your e-commerce store.

You can send the following product information from Akeneo:

Name
Price, Cost Price, Retail Price, Sale Price.
Tax Provider Tax Code
Product SKU
Weight, If weight is zero, it will become a downloadable product in the BigCommerce store.
Width, Height, and Depth
Description
Shipping – Free Shipping and Fixed Shipping Price
Multiple Images
Inventory Tracking – Current Stock Level and Low Stock Level
Brand Name
Product UPC/EAN Number
Bin Picking Number
Call for Pricing
Search Keywords
Visible
Featured Product
Sort Order
Minimum Purchase Quantity and Maximum Purchase Quantity
SEO – Page Title, Meta Keywords, Meta Description

Mapping for the following BigCommerce Native fields is also available –

MPN (mpn)
Global Trade Item Number (gtin)
Tax Class (tax_class_id)
Track Inventory (inventory_tracking)
Availability (availability)
Availability description (availability_description)
Preorder release date (preorder_release_date)
Preorder message (preorder_message)
Is Preorder Only? (is_preorder_only)
Show Product Condition (is_condition_shown)
Purchaseability (availability)

Custom Field Mapping

Here, you can map custom fields with attribute label names as required and can manually set the mappings for the attribute labels.

Mapping for exporting the modifier options with the simple product and product model.

The following are supported types:

- Radio Button
- Rectangle List
- Dropdown
- Text
- Number
- Date
- Multi Line Text
- CheckBox
- Swatch (Single Color and Image values)

Variant options type mapping for exporting variant options as mapped type to bigcommerce with the Product Model.

Fixed Value for All Products

On the right, you can provide a fixed attribute value of the exported products. For example, if you want all the exported products to become visible on the BigCommerce store, you can enter the ‘Yes’ value for the ‘Is Visible’ attribute.

Other Mappings

In this section, you need to mention those Akeneo attributes which include the product images. Further, you need to specify those custom fields for BigCommerce products.

Image mapping: Here, map the image attributes with the image description attributes as required.

The attribute in BigCommerce:

Now you can also export the Akeneo attributes to BigCommerce custom fields in these attributes are supported like text, text area, metric type, simple-select, boolean, date, number, and multi-select.

The attribute in BigCommerce:

Quick Export Currency Mapping

In this section, you can set the default currency while exporting the product via quick export.

Other Setting

Log setting

Log set is used for checking the API logs like what we have exported and imported in Akeneo. For it, You have to enable the request and response log.

Enable API request Logs: By enabling this, we can download and check all the import jobs.

Enable API response Logs: By enabling this, we can download and check all the export jobs.

Other Setting

In this, you can export metric value to the BigCommerce custom field.

The attribute in BigCommerce:

Creating Products in Akeneo

After setting up the BigCommerce Akeneo Connector module, you can export your products from Akeneo. In this section, I will explain to you how to create a product in Akeneo. If you have already created or imported your products to Akeneo, you can move on to the next section and skip this part.

To create a new product in Akeneo follow Products>Create then select the Product option.

After that entered, SKU and then choose a product family.

Add Product Details

Now, you need to fill in all the production information for this new product. Please note that only the mapped attributes product information will be sent from Akeneo to the BigCommerce store. So, kindly make sure all the product fields are correctly mapped with Akeneo attributes.

Select Attribute

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

Date
File
Identifier
Image
Metric
Multi Select
Number
Price
Number
Reference data select
Reference data multi-select
Simple Select
Text
Text Area
Yes/No

You can mention various information about the product – name, description, SEO information, inventory, shipping, pricing, and other details.

SEO Information – Mention page title, meta description, and meta keywords.

Pricing Information -Mention cost price, sale price, retail price, fixed shipping price, and normal price.

Add New Option Attribute

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.

Upload Images

Upload multiple images of a product and export them to the BigCommerce store.

Multi-Lingual Information

Add information for other languages and store views.

Select Categories

Now you need to select a category for the product. You can also choose more than one category for a product. If a category is not available in Akeneo, the module will automatically create a new category in the BigCommerce store.

BigCommerce Export Job

Once you have created or imported the products in Akeneo, you can now move forward with the export process.

To do that please go to Exports>Create Export Profile then enter any code, label after that select the ‘BigCommerce Export Job‘ option.

After saving the profile go to the Content section and select the channel where your products will be exported. You can also choose the locales for deciding in what language you will be sending the content. Select currency according to your store.

In case you have too many products in Akeneo and want to export only a few products, you can use various filters.

Export media and export modifier options are also available.

You can filter products based on family, status, completeness, category, and time condition.

Further, if you want to export only one or more products, you can do that by entering the SKU value in the identifier section.

After that, you can select credentials and the click Save button.

Run Export Job

Once you have saved the export profile information, you can now click the Export Now button after that wait for the execution process to get completed.

You can see the progress of the export process as below. Moreover, if there is any error you can also see it here.

Media Export Job

Under export section, tap Create Export Profile.

Now add the details as shown below and choose the job type as – BigCommerce Product and Product Model Media Export.

Lastly, after saving the job, edit it after that and choose the credentials.

After saving, you can export the media.

View Exported Products in BigCommerce

Once the execution process is completed, you will see the Akeneo product in BigCommerce. Log in to your BigCommerce admin panel then go to the Products list.

You can make any changes to the exported product and modify or update any information. Every product detail which is mapped between Akeneo and BigCommerce will be imported and can be seen here. If weight is not mentioned in Akeneo, it will become a downloadable product in BigCommerce automatically.

Upload multiple images of a product and send them to the export product database.

Inventory Tracking information is also exported from Akeneo.

Custom Fields allows you to mention more information about a product. If custom fields are correctly mapped in the Akeneo Connector configuration, they will appear here as well.

Storefront Details such as Search keywords, Warranty Info, Sort Order, and Condition as mentioned in the Akeneo are visible in this section.

Purchase quantity information and SEO information are also sent to the BigCommerce store.

Purchasability with this you can manage the product availability and available quantity.

Categories are also created from Akeneo. So if you have a product category in Akeneo but not there in BigCommerce, the Akeneo Connector module will automatically create categories while exporting the products.

Exported Products on Storefront

Now, let’s see how exported products appear on the storefront. You can see the product name, price, SKU, UPC, purchase quantity information, custom fields information, etc. on the product page.

Once the export job is finished in Akeneo, the exported products will be available to the customers for purchase. The customer can see the multiple images, descriptions, warranty information, related product and much more.

Import Profile

Now you can now import your product catalog data from Bigcommerce to Akeneo. There are various job profiles available for importing Category, Attribute, Attribute Option, Family, Product and Product Model from Bigcommerce to Akeneo.

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

Once you have selected the import job profile.

After that from the Content section, you can select the channel and locales for importing product data.

Setup Credentials – In case you are managing multiple BigCommerce stores, you can provide separate API credentials for each BigCommerce store individually.

Once everything is set up correctly, you just need to click the Import Now button then the import execution process will start.

Support

In case you find anything missing or not explained correctly, or you have any customization needs, reach out to us at support@webkul.com. You can also raise a ticket at our HelpDesk System.

Please explore our Akeneo Development Services and quality Akeneo Extensions.

Categories: Akeneo

Kavita Singh 1-October-2024

View Comments (2) Comment or Ask a Question

Quick Links

BigCommerce Akeneo Connector

Table of Content

Live Demo

Basic Requirements:

Video Tutorials

How to get API keys?

How to do module configuration?

Exporting Simple Product from Akeneo to BigCommerce

Features – BigCommerce Akeneo Connector

BigCommerce API Credentials

Composer Installation

Manual Installation For Akeneo 6 and 7

Manual Installation for Version 4.0.x to 5.0.x

Docker Installation Command :

Installing Module for Version 2.x to 3.x

Common Issues After Installation

Uninstall Module For Akeneo 6 & 7

Setup Credentials in Akeneo

Credentials:

Attribute Mapping

Fixed Value for All Products

Other Mappings

Quick Export Currency Mapping

Other Setting

Creating Products in Akeneo

Add Product Details

Select Attribute

Add New Option Attribute

Upload Images

Multi-Lingual Information

Select Categories

BigCommerce Export Job

Run Export Job

Media Export Job

View Exported Products in BigCommerce

Exported Products on Storefront

Import Profile

Support