BigCommerce Akeneo Connector allows you to connect your BigCommerce store with Akeneo PIM platform. With the help of this integration, you can manage your entire catalog from Akeneo. Using this module, you can export products, categories, product options, attributes, custom fields, multiple images, from Akeneo to BigCommerce store.
Please Note – BigCommerce Akeneo Connector is compatible with Community Edition, Enterprise Edition, and Cloud (PaaS/Flexibility) Edition of Akeneo.
- This module works with Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, and 3.1.x. Download Akeneo from here
- Node and Yarn packages need to be installed.
- Create product categories from Akeneo.
- Export selected attributes as custom fields from Akeneo to BigCommerce store.
- Send multiple images of a product including variations.
- Mention SEO information, inventory, pricing, shipping, other details in products.
- Option to set fixed values for all exported products.
- Choose which products to export using various filters- category, family, completeness, time conditions, locale, currency.
- Use identifier (SKU) for exporting specific products to BigCommerce store.
BigCommerce API Credentials
Before you begin, you need to obtain API credentials from BigCommerce control panel. Log in to your store and follow Advance Settings>API Accounts>Create API Account. Now enter any name for this API account and copy API Path URL.
After that, you need to select ‘modify‘ scope for ‘Products‘ and click Save button.
Once, you click 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.
For installing this module in Akeneo, please follow the below steps as mentioned:
1. Unzip the respective extension zip and then merge “src” folder into akeneo project root directory.
2. Goto app/AppKernel.php and add line
in function registerProjectBundles()
3. Goto app/config/routing.yml and add these lines at the top of file
big_commerce: resource: "@BigCommerceBundle/Resources/config/routing.yml" prefix: /
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.
rm -rf ./var/cache/** && php bin/console pim:install:asset --env=prod && php bin/console assets:install web --symlink && yarn run webpack && php bin/console d:s:u --force
5. You have to restart your web server like Apache, Nginx. Run the command for Apache web server.
sudo service apache2 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.
Setup Credentials in Akeneo
Akeneo Connector Settings
In the Settings tab, you need to do the 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:
- Price, Cost Price, Retail Price, Sale Price
- Avalara Product Tax Code
- Product SKU
- Weight, If weight is zero, it will become a downloadable product in the BigCommerce store.
- Width, Height, and Depth
- 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
- Search Keywords
- Featured Product
- Sort Order
- Minimum Purchase Quantity and Maximum Purchase Quantity
- SEO – Page Title, Meta Keywords, Meta Description
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 ‘Yes’ value for ‘Is Visible’ attribute.
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.
Log setting is used for the 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.
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 in Akeneo, you can move on to the next section and skip this part.
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 BigCommerce store. So, kindly make sure all the product fields are correctly mapped with Akeneo attributes.
For adding product information, select attribute options you require. You can also create new options for the attribute. Following Attributes from Akeneo are supported for export:
- Text Area
- Reference data select
- Reference data multi-select
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.
Add information for other languages and store views.
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 to the export process. To do that please go to Exports>Create Export Profile and enter any code, label and select ‘BigCommerce Export Job‘ option.
After saving the profile go to the Content section and select your 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. You can filter products based on family, status, completeness, category, and time condition. Further, if you want to export only one or more product, you can do that by entering SKU value in the identifier section.
Run Export Job
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 and go to 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 Akeneo Connector configuration, they will appear here as well.
Other Details such as Bin Picking Number, Featured Product, Visible, Warranty Info, Sort Order as mentioned in the Akeneo are visible in this section.
Purchase quantity information and SEO information are also sent to BigCommerce store.
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, description, warranty information, related product and much more.
Thank you for reading this documentation. In case you find anything missing or not explained correctly, or you have any customization needs, then please send a mail to firstname.lastname@example.org
Current Product Version - 1.0.4
Supported Framework Version - Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, and 3.1.x