Synchronization
This section provides an overview of the different types of synchronization and how they work.
Synchronization
The synchronization section is where the magic happens! Here, you can launch import jobs to seamlessly transfer product data from your PIM to your BigCommerce store.
Synchronization scope
There are three types of synchronization available:
- Categories: Select this option to import PIM categories/sub-categories.
- Products import: Select this option to import simple products - without variants.
- Products with variants import: Select this option to import products with variants.
Synchronization type
Manual synchronization
The app allows you to launch your synchronizations manually.
To launch a synchronization manually, follow the steps below:
- Navigate to the Synchronization tab.
- Click on the Manual sync button.
- In the modal that appears, select the desired import process: Full import, or Delta import.
- (Optional) Set filters.
- Click on Launch synchronization.
Scheduled synchronization
With the App, you have the flexibility to schedule your imports on a recurring basis. You can choose from the following frequencies:
- Daily
- Weekly
- Monthly
Synchronization start times are automatic:
- Products: 8:30 AM (UTC)
- Products with variants: 2:30 PM (UTC)
To schedule your imports:
- Navigate to the Synchronization tab.
- Click on the Schedule sync button.
- In the modal that appears, select the desired import frequency: daily, weekly, or monthly.
- (Optional) Set filters.
- Click Save to confirm your selection.
If you wish to deactivate the scheduled synchronization, follow these steps:
- Go to the Synchronization tab.
- Locate the scheduled synchronization you want to deactivate.
- Click on the Schedule sync button.
- In the modal that appears, change the frequency to Never.
- Click Save to confirm your selection.
By deactivating the scheduled synchronization, the import jobs will no longer run automatically according to the previously set frequency.
Apply filters to your imports
List of available filters:
| Filter | Scope | Import type | Information |
|---|---|---|---|
| Import process | Categories, Products, Products with variants |
Manual, Scheduled | Required The filters feature allows you to choose if you want to perform a full or delta import: • Full import: this process is used to import the whole catalog: products, media, and custom fields. Please use the full import for the first synchronization with the App. • Delta import: this process is used to import changes made in the PIM catalog since the last synchronization: creating new products/categories or updating values on products/categories. Please use the delta import to reduce the import duration. |
| Completeness | Products | Manual | Optional This filter allows products to be synchronized according to their completeness in the PIM. Only products with completeness greater than or equal to that used in the filter will be synchronized. |
| Import images | Products, Products with variants |
Manual, scheduled | When unselected, this filter skip images during synchronizations. |
| Import custom fields | Products, Products with variants |
Manual, scheduled | When unselected, this filter skip custom fields during synchronizations. |
| Import prices | Products, Products with variants |
Manual, scheduled | When unselected, this filter synchronizes prices when creating products and skips prices for product updates. It allows users to import their prices from an ERP. |
| Filter attribute | Products, Products with variants |
Manual, Scheduled | Optional This filter allows products to be synchronized according to the value of a Boolean attribute: • Yes: the product is synchronized • No: the product is not synchronized • Empty: the product is not synchronized The Boolean attribute must be created in the PIM and then mapped into the Akeneo App for BigCommerce. |
In the Execution section, you can only consult the import that is currently in progress. You will be able to verify the type of synchronization job, the method used, and the execution time. Please consult the History tab if you need additional information about past jobs.
Category synchronization
Category synchronization allows you to import your entire category tree from the category/sub-category selected in the store configuration.
List of category's data supported by the App
| Category's data | Supported by the App | Information |
|---|---|---|
| CATEGORY DETAILS | ||
| Display name - Category label | Yes | 50 max characters length |
| URL | No | |
| Description | No | |
| Parent category - PIM category structure | Yes | |
| Template layout file | No | |
| Sort order | No | |
| Default product sort | No | Use store settings default |
| Category image | No | |
| SEARCH ENGINE OPTIMIZATION | ||
| Home page title | No | |
| Meta keywords | No | |
| Meta description | No | |
| Search keywords | No |
Category deletion
Deleting synchronized categories in BigCommerce is not handled by the app. If a category is deleted on the Akeneo side, it must be manually deleted in BigCommerce.
If a category is deleted in BigCommerce, it must be manually deleted in Akeneo. Otherwise, it will be recreated by the app during the next category synchronization.
Product synchronization
Product synchronization allows you to import all simple products - without variants - and their attributes.
By default, all products are synchronized, regardless of their status in Akeneo. Product status is automatically synchronized in the Visible on Storefront field:
- Set to Yes if the Product status is enabled
- Set to No if the Product status is disabled
Please note it is necessary to start by synchronizing categories before synchronizing products for the initial import. Products must be attached to a category in order to be created.
Simple product deletion
Deleting synchronized products in BigCommerce is not handled by the app. If a product is deleted on the Akeneo side, it must be manually deleted in BigCommerce.
If a product is deleted in BigCommerce, it must be manually deleted in Akeneo. Otherwise, it will be recreated by the app during the next simple product synchronization.
Product with variants synchronization
Product with variants synchronization allows you to import all product models, variants, and their attributes.
All product models are synchronized, regardless of their variant status in Akeneo.
Please note that there is an exception: if a product model has no enabled variants in Akeneo, the product model is not synchronized.
List of compatible attributes as variation axis
| Attribute type | Supported by the App |
|---|---|
| Simple select | Yes |
| Measurement | Yes |
| Boolean | Yes |
| Reference entity single link | Yes |
Product with variants deletion
Deleting synchronized products with variants in BigCommerce is not handled by the app. If a product model is deleted on the Akeneo side, it must be manually deleted in BigCommerce.
If a product model is deleted in BigCommerce, it must be manually deleted in Akeneo. Otherwise, it will be recreated by the app during the next synchronization.
If a product variant is deleted on the Akeneo side, it is automatically deleted in BigCommerce.
If a product variant is deleted in BigCommerce, it must be manually deleted in Akeneo. Otherwise, it will be recreated by the app during the next synchronization.
Synchronization Status
The following synchronization statuses are available in the BigCommerce App:
| Status | Definition |
|---|---|
| PENDING | The job has been launched but not running yet. This status should last no more than a few seconds. |
| IN PROGRESS | The import is proceeding. The length will vary depending on the number of products/categories imported. |
| SUCCESS | The import is finished with no warnings or errors. It means that all your products/categories have been imported entirely with the information entered in your PIM instance. |
| WARNING | The import is done with warnings and/or errors. If you did receive the following information: "Your job is completed, but it contains: X warnings X errors" It means that your job has been completed, but some of the products, product attributes, or categories could not be imported. Please consult the import logs. |
| ERROR | The import has crashed with an error. It usually means that there is an overall problem with either PIM or BigCommerce instance. Please consult the import logs. |
| STOPPED | The import was stopped before its end. Please contact the support team. |