Category Management (Magento)

 All documentation in this document relates to a previous version of the Brightpearl Magento extension which will be deactivated in 2018. If you are using this previous version, please contact us about upgrading.

For help with the current extension, please see the Magento section. 

We recommend that categories are managed in Magento and that you do not activate category synchronization as part of the integration. Synchronizing categories is part of the complex level integration and is not always advisable. If you are interested in synchronizing categories please ensure that you have read this guide to understand how it works and how to manage your products.

Categories in Magento are used to create your website menus. You can have top level categories, sub-categories, sub-sub-categories, and so on. How you structure your categories depends on how you want customers to be able to browse your products, for example:

categories OR categories

When synchronization is NOT activated

When you have not activated the synchronization you will manage categories separately in both Brightpearl and Magento. This allows you to have completely different category structures and provides more flexibility between each system. You are able to rename, move, delete and add new categories into Magento without having to worry about breaking the integration.

When a product is added or moved to a category it must be done in Magento (and in Brightpearl if required).

When a new product is uploaded from Brightpearl to Magento (requires Advanced integration), the category will need to be assigned from within Magento. Magento has an import tool that can assist with this.

When synchronization is activated

When setting up your Magento store in Brightpearl you select which category tree to synchronize (see lesson 1), everything below that category can be synchronized with Magento. We recommend that you add a top level category called "Magento Store" and have all your categories stemming off from that one.


Managing categories

Categories must be managed in Brightpearl and never in Magento; changes made in Magento will not be reflected in Brightpearl and can cause the synchronizing to work incorrectly. If you require your categories to be different in Magento than in Brightpearl you must deactivate category synchronizing.

Uploading categories

Categories are uploaded to Magento when:

  • A new category is added
  • An existing category is edited (renamed or moved)
  • A product in the category is uploaded - This requires product details to be synchronized, which in turn requires additional setup steps.

Once uploaded your categories are linked so every change you make in Brightpearl will be mirrored in Magento. You should always make changes in Brightpearl, such as renaming, moving or adding a new category because the synchronizing is only from Brightpearl to Magento.

Deleting categories

A Magento category should only be deleted AFTER the Brightpearl category has been deleted. If only the Magento category is deleted it is not possible to reconnect the Brightpearl category to Magento (EVER!). You will have to create a new category in Brightpearl to replace the old one. This would mean moving all your products from the old to the new category. A better option is to disable your category in Magento and leave it in Brightpearl (perhaps add “DO NOT USE” to the name), just in case you need to use it in the future.

Putting products into categories

Products need to be added or moved between categories in Brightpearl. Any changes will be updated on Magento immediately. If the category is not yet shown in Magento it will be sent now.

How to add and sync new categories

  1. In Brightpearl, go to Products > Categories .
  2. Add a top-level category by entering the name in the top-right (max 32 characters) and clicking Add .
  3. Add a subcategory by clicking on any existing category and selecting Create subcategory .
  4. Your category is uploaded to Magento (to upload any existing category you will need to edit it, or upload a product within the category. In Magento, go to Catalog > Manage Categories  to see your category tree.
  5. Click on the category in Magento to view the general information.
  6. Edit the category description, keywords, meta data and other information relevant to the "design and website" side of things.
Have more questions? Submit a request


Please sign in to leave a comment.