Mapping
Native fields
The mapping section will let you map all necessary fields to match your BigCommerce data with your PIM source data.
It means that App will populate the data from the chosen PIM's attribute into the BigCommerce target field (e.g. in the PIM, you use the "My_short_description" attribute to fill in the description of your products, then you will map it with the "Description" field in your BigCommerce instance).
There are two main types of functional limitations that are applied to the fields that you are going to map:
- Attribute type used - visible in BigCommerce Platform Limits and listed on the mapping page under each attribute.
- For some fields, the characters max length is established from the BigCommerce side and therefore it needs to be respected.
The drop-down list will be automatically populated with data from your PIM.
Custom fields
Custom fields allow you to map almost any type of attribute that can be transformed into text from the Akeneo PIM to the BigCommerce store. The list of available attributes is automatically prepopulated from the PIM.
Limitations:
- Up to 200 custom fields can be selected in the Apps.
- Only 1000 eligible attributes are displayed in the App ready to be selected.
- Selected attributes' value cannot be longer than 250 characters. Otherwise, it will not be imported.
Consult the Custom fields mapping section to understand how to map Custom fields.
Different types of mapping for BigCommerce native fields
Akeneo App for BigCommerce allows you to manage your mapping in two different ways:
Simple mapping - if your data modelization in the PIM is based on the same attributes for all PIM families then you can map one particular data source to match all your products (eg. If you use the "My_short_description" field to fill in your description for all of your products independently on their family, then you will map it using simple mapping.
Complex mapping - this option allows you to map a BigCommerce target field differently for each product family. See more details in the "Complex mapping" section.
Be aware that you can combine both types of mapping depending on your needs. If you wish to use the complex mapping for a specific field, all you need to do is to check the corresponding checkbox and click on ‘MANAGE FAMILY MAPPING’ to access complex mapping for this specific field.
Be careful if you opt for a complex mapping for one of the mandatory fields: make sure that your mapping is completed for all concerned families before launching your first import in order to avoid unnecessary errors.
You need to click on the SAVE button in the top right corner of the page to save the changes.
Simple mapping for native fields
For a moment, the following native target fields are available for mapping:
Native fields for simple products & product models
Native fields | Supported by the App | Supported PIM attributes | Limitations |
---|---|---|---|
PRODUCT INFORMATION | |||
BASIC INFORMATION | |||
Product Name - mandatory field | Yes |
Identifier, Text | 255 max characters length |
Default Price - mandatory field | Yes |
Number, Price | The values cannot be null or negative |
Weight - mandatory field | Yes |
Measurement, Number | Not mandatory for digital products |
Product Type - mandatory field | Yes |
Simple select | The values must be as follows in the Akeneo PIM: • physical - value set by default • digital |
Brand | Yes |
Text, Simple select | |
DESCRIPTION | |||
Description | Yes |
Text area | |
IMAGES & VIDEOS | |||
Images | Yes |
Image, Asset collection |
The limitation depends on the media source: • 15 image attributes max The maximum size of the image must be less than 2MB for image attributes and asset collections using a media file, and 8MB for asset collections using a media link. |
PRODUCT IDENTIFIERS | |||
SKU | Yes |
Identifier, Text | |
Manufacturer Part Number (MPN) | Yes |
Identifier, Text, Number | 50 max characters length |
UPC/EAN | Yes |
Identifier, Text | UPC or EAN must be numeric and have a length of 6, 8, 12, or 13 numbers |
GTIN | Yes |
Identifier, Text | |
Bin Picking Number (BPN) | Yes |
Identifier, Text, Number | 255 max characters length |
PRICING | |||
Tax Class | No |
||
Cost | No |
||
MSRP | No |
||
Sale price | No |
||
Tax Provider Tax Code | No |
||
Discount type | No |
||
INVENTORY | |||
Track inventory | No |
||
Stock | No |
||
Low stock | No |
||
STOREFRONT | |||
STOREFRONT DETAILS | |||
Set as Featured Product on my Storefront | Yes |
Boolean | |
Search Keywords | Yes |
Simple select, Multi select | |
Sort Order | No |
||
Template Layout File | No |
||
Warranty Information | Yes |
Text, Text area | |
Availability Text | Yes |
Text | |
Condition | No |
||
Show condition on storefront | No |
||
RELATED PRODUCTS | |||
Automatically show related products on my storefront | No |
Set to Yes by default | |
FULFILLMENT | |||
DIMENSIONS & WEIGHT | |||
Height | Yes |
Measurement, Number | |
Width | Yes |
Measurement, Number | |
Depth | Yes |
Measurement, Number | |
SHIPPING DETAILS | |||
Fixed Shipping Price | No |
||
Free Shipping | No |
||
PURCHASABILITY | |||
Purchasability | No |
||
Minimum Purchase Quantity | No |
||
Maximum Purchase Quantity | No |
||
GIFT WRAPPING | |||
Gift Wrapping options | No |
||
CUSTOMS INFORMATION | |||
Country of origin | No |
||
Commodity description | No |
||
HS codes | No |
||
SEO & SHARING | |||
SEARCH ENGINE OPTIMIZATION | |||
Page Title | Yes |
Text | |
Product URL | Yes |
Text, Text area | Do not include the domain name in the URL. Example of accepted URL format: /my-bigcommerce-product/ |
Meta Description | Yes |
Text | |
OPEN GRAPH SHARING | |||
Object type | No |
||
Title - use product name | No |
Set to Yes by default | |
Description - use meta description | No |
Set to Yes by default | |
Thumbnail image | No |
Set to Yes by default |
Native fields for product variants
Native fields | Supported by the App | Supported PIM attributes | Limitations |
---|---|---|---|
Purchasable | No |
Set to Yes by default | |
Image | Yes |
Image, Asset collection |
The limitation depends on the media source: • 1 image attribute max The maximum size of the image must be less than 2MB for image attributes and asset collections using a media file, and 8MB for asset collections using a media link. |
SKU - mandatory field | Yes |
Identifier, Text | |
Default Price | Yes |
Number, Price | The values cannot be null or negative |
Sale Price | No |
||
MSRP | No |
||
Weight | Yes |
Measurement, Number | |
Width | Yes |
Measurement, Number | |
Height | Yes |
Measurement, Number | |
Depth | Yes |
Measurement, Number | |
Cost | No |
||
UPC/EAN | Yes |
Identifier, Text | UPC or EAN must be numeric and have a length of 6, 8, 12, or 13 numbers |
GTIN | Yes |
Identifier, Text | |
Bin Picking Number (BPN) | No |
||
Manufacturer Part Number (MPN) | No |
By default, product model attribute values are considered when creating product variants. It means that product variants created without a specific mapping will automatically use the configuration of the product model. If you wish to override certain product model information, use this section to map them (this does not apply to images)
Media mapping
Media mapping allows you to map PIM images or PIM asset collections to BigCommerce images. By choosing PIM images, you will map & synchronize PIM image attributes to BigCommerce. If you select PIM asset collections, you will map and synchronize a specific asset attribute from the related asset family to the asset collection to BigCommerce.
The App allows you to map asset attributes of two types: media link or media file. Only asset attributes whose media type is image are selectable. If the asset attribute you want to map does not appear, please check the asset family settings to make sure it belongs to the right type.
How to map media?
Follow these steps to map your images:
- In the Native fields tab, click on EDIT MEDIA MAPPING
- Now, choose a media source. You can choose between images and asset collections.
It is not possible to map a mix of images and asset collections.
Image attributes
- You can now select an image attribute that you want to map.
Asset collections
- You can now select an asset collection that you want to map.
Then, select the asset attribute in the asset family related to your asset collection that you want to import.The App supports up to 5 asset collections to synchronize and map 1 asset attribute for each asset collection at the product level.
This corresponds to a maximum of 250 images per product.
Please note that it is only possible to map 1 asset collection at the variant level. - Click on Save to save the mapping.
Please note that it is possible to change the order of your media. To do this, simply select your media - click on the icon with three stripes - and drag the asset to the desired position.
Mapping - General Rules
They are four mandatory fields required for product creation on the BigCommerce API side:
SIMPLE PRODUCT & PRODUCT MODELS:
- Product Name*
- Default Price*
- Product Type*
- Weight*
PRODUCT VARIANTS:
- SKU* - BigCommerce API limitation
Default Price exception - If you use a system other than PIM for your price management, please set up your product price in PIM to 0 to avoid problems with product creation during import. Product default price field cannot be empty nor negative.
When you create product variants, make sure to set up a default price of the product model. Otherwise, the product model and its variants will not be created.
It is important to remember that if you set up your price to 0, you have to be aware that you need to change it before your Product goes to the production process. BigCommerce proposes the solution to set up a dynamic price by using their customized options; however, a price has to be set up on the PIM side to create your products and product variants correctly.
Weight exception - If some or most of your products are digital, please set up your Weight to 0 in PIM to avoid problems with product creation during import.
Be aware that BigCommerce uses the "NAME" value as the single product identifier. Therefore you cannot import two identic names into your BigCommerce store. You are able to modify the name of your products as many times as you want, but please always make sure not to create any doubles.
Please be aware that those exceptions are linked to BigCommerce API restrictions and, therefore, mandatory to import your product catalog correctly.
To review all BigCommerce API product catalog limits, please visit: BigCommerce Help Center
PRODUCT MODELS & PRODUCT VARIANTS
Please note that because of the BigCommerce product options structure, the mandatory fields for creating your product model need to be filled in the common part of the product models, even though you will then want to map a specific weight or price for your product variant. Without mandatory fields, the product model will not be created and the connector will show an error during importation.
Those fields are:
- Product model name
- Weight
- Price
You can map specific fields for your product model and then override that information via App for product variants.
Be aware that the App does not manage the deletion of product models and product variants. If you have deleted a product model in your BigCommerce store, make sure to do it accordingly in your PIM before relaunching the import.
The App supports the following PIM attribute types for product variants:
- Simple Select
- Metrics
- Boolean
Images vs variants
- Images for product models - once imported, if removed or modified in the PIM, changes will apply
- Images for product variants, once imported, only modifications in the PIM will be taken into account, product variant images cannot be removed
- Images attributed localted on the product model level can be used on the product variant level
- Image attribute located n the product variant level cannot be used on the product model level
Complex mapping for native fields
Please note that complex mapping is only available for simple products & product models.
Complex mapping allows you to map BigCommerce target fields differently for each product family. Depending on your data modelization strategy, it can be used for each target field or only for one or a few of them.
If you wish to use a complex mapping for one of the BigCommerce target fields, please check the box below the drop-down list. Then you will see the ‘MANAGE FAMILY MAPPING’ appear.
To define your family by family mapping, please click on the 'MANAGE FAMILY MAPPING'.
The additional family-by-family mapping section will appear.
All PIM families will be retrieved from your PIM and displayed in the PIM family column.
Same as for the Simple mapping (see above), PIM attributes will be prepopulated for each dropdown list. The attribute type allowed does vary and depends on the BigCommerce target value (see general mapping page).
On the top of the page, you will see the progression bar of your Family by Family mapping.
Please keep in mind that to avoid any errors during your import, if you decide on the Family to Family mapping for the mandatory values, you should complete your mapping for all concerned families before launching your first import.
Custom fields mapping
Thanks to custom fields you can map the following attributes types from your Akeneo PIM into BigCommerce:
- Date (format: MM/DD/YYYY)
- Identifier
- Multi-select
- Simple select
- Measurement
- Number
- Price
- Text
- Text area (up to 250 characters)
- Boolean
- Those listed attribute types will be transformed into text.
- The translated title of your attribute will be imported as the attribute name.
- If the selected attribute exists only for some of your families, only those families will be enriched with this specific custom field.
- The App does not impact the import order of custom fields in BigCommerce.
- If you delete product attributes in your PIM or in the App interface, those will be removed automatically from your product page in BigCommerce during the next import.
- If you changed some attribute translations/labels in your PIM, please make sure to run a FULL import to update your product pages in your BigCommerce store correctly. Otherwise, new translations will be missing.
Follow these steps to map your custom fields:
- Go to: Custom fields tab >> Click on Manage Custom fields
- Select PIM attributes that you want to map
- Validate your choice by clicking on Confirm selection
Follow these steps to remove some of the custom fields from the mapping:
- Go to: Custom fields tab >> Click on Manage Custom fields
- Deselect PIM attributes that you want to remove from your mapping
- Validate your choice by clicking on Confirm selection