Guide for Akeneo BigCommerce App

Akeneo BigCommerce App connects Akeneo PIM with BigCommerce store. With this app, users can easily import and export data between Akeneo and BigCommerce.

It allows to manage the BigCommerce catalog directly from Akeneo. The user can connect multiple BigCommerce stores with Akeneo to perform import and export operations.

Users can export products, categories, product options, attributes, custom fields, and multiple images from Akeneo to the BigCommerce store.

Additionally, if you’re looking for SEO optimization for your Akeneo products, then you can check Akeneo SEO Manager App.

• Export categories, products from Akeneo to BigCommerce.
• Select Attributes and export them as Custom Fields from Akeneo to BigCommerce.
• Export Product Images from Akeneo to BigCommerce
• Can filter the data for export based on Family, Completeness, Time conditions, Language, and Currency for Product Export.
• Introduced logger settings for API request logs.
• Distinct jobs for exporting categories, products, product models, and all data.
• Supports multiple credential features.
• Utilize UI Mapping to export the Default Value of Custom Fields.
• Export variant values in the custom field.
• Option to eliminate the trailing zero in numbers.
• Capable of exporting Metrics attribute types in the custom field.
• When you export Metrics types, the system adds the Unit Code at the end of the value, ensuring consistency and clarity in the data.
• Ability to export attributes with multiple select fields. Use the label of each option, separated by commas, for multiselect.
• User can export Boolean/number type custom fields.
• User-friendly credential setup with Store name.
• Feature to export custom product URLs.
• Updated the Attribute Mapping section to include an option for product URLs.
• Supports the export of video links in product exports.
• User can export Image Descriptions.
• Set Thumbnail images for Product exports.
• Export Modifier options to BigCommerce.
• Support for Asset, Brand and Category Export.
• Option to import Attributes, Attribute options, Family, Family variants, Products and Product Models.
• Enhanced export functionality for reference entity attributes (Text, Number, Single/Multiple Options), now aligned with BigCommerce custom fields.
• Functionality in export job to update existing Product and Product Model.

Please note, however, that you can import or export an unlimited number of products.

Support for Reference Entity is not available in this app currently.

First, search for the Akeneo BigCommerce App in the Akeneo app store. Next, tap the connect button.

After tapping the Connect button, proceed to the page that appears. Then, tap the Allow and Next buttons to continue.

Afterwards, check and agree to the app’s privacy policy and terms and conditions,, and tap the Allow and Next button,

Thereafter, provide the access permissions to the category trees, including – Catgeory, Locale, Attribute Group, and others, and then tap the Next button after that.

Note: These app permissions appear in the case of Akeneo EE edition users only.

Now, confirm the access and tap the Confirm button.

After the permissions section, the app connects, and you can navigate to the app dashboard.

Now, the user can see the Akeno BigCommerce App connected, and tap on Open App to open it.

Akeneo App Flow Management:

To manage the Akeneo BigCommerce App, tap the Manage App button. Here, for the flow type, you need to select the Other type.

Note: You must select the Data Source flow type in the Growth, Flexibility, and Serenity editions.

After the app connects and opens, the system redirects the user to the Plans page, where they must purchase a plan based on their requirements.

Now, the user will click on Buy Now to purchase a new plan. Then, the system redirects them to PayPal to complete the transaction.

After successful payment, the system redirects the user to the Plans page, where the selected plan is now in the Activated state.

For the initial process, the user needs to generate BigCommerce API credentials, which they will use to connect Akeneo with the BigCommerce store.

First, log in to your BigCommerce store. Then, navigate to Settings > Account API Tokens > Create API Token.

Afterward, enter a name for the API account and copy the API path URL.

After that, select the Modify scope for ‘Products’ and the Information & Settings options. Then, click Save to confirm.

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

Once the connection is successfull, the user has to enter the BigCommerce store credentials into the app.

Next, they’ll navigate to Setup Credentials > Create and then fill in the API details in the fields provided, as shown below.

Next, the user will enter the following details:

• API Path
• Access Token

After filling in the credentials, tap on Save to add and save them successfully. The added store will be visible in the Setup Credentials section as below,

From here, the user can search between multiple stores added through the search bar.

Additionally, they can manage the activation status and edit the API credentials by hovering over a particular store.

For the next process, User will proceed for Attribute Mapping between fields in BigCommerce and Akeneo attributes.

The following columns are available for the field mappings,

• Field in BigCommerce: Attributes available in BigCommerce store.
• Akeneo Attribute: Attributes available in Akeneo.
• Fixed value for all Products: Set Default value for attributes.

Custom Fields Mapping

Under this section, user can perform custom field mapping as well to export the fields from Akeneo to BigCommerce.

User can create custom fields by matching them with the names of attribute labels as needed, and have the option to set these mappings for the attribute labels manually.

Attributes To Be Used as Modifiers

Mapping is given to export the modifier options with product and product model.

The following attribute types are supported,

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

In the Other Mapping section, the user can perform additional mappings. They are as follows,

Image Mappings

Under this section, user can set the mapping for export of images and videos.

• Attributes to be used as Images: Select the attributes which are required to be exported as Images.
• Attributes to be used as Videos: Select the attributes which will then be exported as videos.

Image Description Mappings

User can add mappings for image descriptions. They can also select a particular mapping to be used as Thumbnail Image.

The mapping also has drag and drop functionality to set the sort order as per requirement.

Other Setting

The below 2 settings are available in this section,

• Remove extra fractional zeros of metric attribute value:
• Set Attribute Group (For Attribute import):

The Import Media Mapping section is for mapping the media type attributes for importing from BigCommerce to Akeneo.

1. Choose Media Type: Select the media type for import job to import the image, asset and video of the product and product model.
2. Attribute to be used as Images: This option appears when media type is selected as Image from above option.

Step 1: Navigate to Settings and Categories

First, go to Settings and select Categories from the menu.

Step 2: Create a Category Template

Click on Create Template to access the Create New Category Template page.
Enter the Label and Code (both required), then click Create.

Step 3: Create an Attribute

After creating the category template, click on Create Attribute.
This will take you to the Add Attribute Page.

Step 4: Fill in Attribute Details

On the Add Attribute Page, provide the Label and Code (both required).
Then, select the Attribute Type for the field.

You can see two important options for the attribute:

• Value per Channel: Assign different values for the attribute across multiple sales channels.
• Value per Locale: Define different values based on specific regions or languages.
  These options allow for flexibility and localization.

Step 5: Modify Settings and Add Translations

After you create the attribute, the system redirects you to the template page.
Under Name Settings, you will see Value per Channel and Value per Locale.

Below these, you will find the Label Translations section, where you can add translations for your attribute’s label.
The available languages include:

• English (United States) 🇺🇸 – en
• Hindi (India) 🇮🇳 – hi
• Japanese (Japan) 🇯🇵 – ja

You can update the label translations based on your target audience’s language preferences.

The Category Field Mapping interface enables users to map BigCommerce Category Fields to Akeneo category attributes.

The first dropdown lets users select a BigCommerce Category Field, while the second input allows them to choose the corresponding Akeneo Category Attribute.

Category Field Attribute Code

Each Akeneo Category Attribute has a unique “Attribute Code” that identifies it.

Ensure the correct Attribute Code is selected when mapping to BigCommerce Category Fields to ensure accurate data synchronization.

In the Category Attribute Scope section, there are two key options:

• Localizable: This means the attribute supports multiple languages, allowing the value to be translated for different locales.
• Scopable: This means the attribute varies depending on different sales channels, allowing the value to be scoped per channel.

Users can add mappings by clicking the + Add Field button.

After clicking the + Add Field button, you can begin filling in the required details for each field mapping.

Select the appropriate BigCommerce Category Field and the corresponding Akeneo Category Attribute from the dropdowns.

Ensure that the Category Attribute Scope is set correctly (either Localizable or Scopable) based on your needs.

Once all fields are filled, click Save to confirm your mappings and ensure the changes are applied.

Users can add more mappings by clicking the + Add Field button.

Additionally, when a BigCommerce Category Field is selected, a tooltip dynamically appears.

It offers detailed information about the supported value types (e.g., text, boolean, etc.), thereby helping users ensure accurate mapping.

The app, therefore, provides both export and import functionalities, enabling seamless data transfer between Akeneo and BigCommerce.

The user can navigate to Exports or Imports from the side panel to perform the required jobs. There are pre-made export and import jobs, and new jobs can be created as well.

Export Job

After creating an Export Job, User can edit the job to configure filtering the data and products for exporting, they get the following filters,

Filter The Data

Here, User can set the below options as per requirement for filtering data,

• Channel – Set the Channel in which to export data.
• Locale – Set the Locale from this option.
• Currency – Set the Currency from this option.
• Date Format – Set the date format from this option.
• Update Existing Product – If this option is enabled, only existing products will be updated.
• Export Media – If Enabled, Media will also be exported.
• Export Modifier Options – If Enabled, Modifier options shall also be exported.
• Update/Remove Custom Fields – If Enabled, custom fields will also be updated or removed.

Filter The Products

Here, User can set the below options as per requirement for filtering products,

• Family – Select the Family to export.
• Status – Select the product according to their Status (Enabled or Disabled) for exporting.
• Completeness – Filter products based on their completeness.
• Time Condition – Filter products based on their date of updation.
• Identifier – Enter the product identifier in this field to only export specific products.

Further, the Export Job is executed by user as below image,

Import Job

So that is much about the Akeneo BigCommerce App.

If you require further assistance, you can reach out to us directly from [email protected] or raise a ticket.