Documentation Home

Broadleaf Import

This module provides the ability to bulk import data into Broadleaf. This currently supports the following bulk import use cases:

  • Catalog data (Products, Skus, Categories)
  • Assets (.zip file of media items)
  • Import via an API
  • Flexibility to bulk import other non-Broadleaf-specific entities

The Broadleaf import tool is also extensible to support bulk imports for your own custom entities.

Installation

If your project uses the Parent Starter (BOM) configuration, only the following entry needs to be added to the "core" project pom.xml"

<dependency>
    <groupId>com.broadleafcommerce</groupId>
    <artifactId>broadleaf-import</artifactId>
</dependency>

If the Parent Start (BOM) is not being used, then the following steps need to be done to include the Import module into your project:

  1. Add the following to your property section of your parent pom.xml

    <broadleaf-import.version>3.2.1-GA</broadleaf-import.version>
    
  2. In the dependency management section of your parent pom.xml, add:

    <dependency>
        <groupId>com.broadleafcommerce</groupId>
        <artifactId>broadleaf-import</artifactId>
        <version>${broadleaf-import.version}</version>
        <type>jar</type>
        <scope>compile</scope>
    </dependency>
    
  3. Finally, add the following to the dependency management section of your admin pom.xml:

    <dependency>
        <groupId>com.broadleafcommerce</groupId>
        <artifactId>broadleaf-import</artifactId>
    </dependency>
    

Version Compatibility

Import Version Broadleaf Core Version
2.2.x-GA 5.2.x-GA
3.0.x-GA 6.0.x-GA
3.2.x-GA 6.1.x-GA
3.3.x-GA 6.2.x-GA
4.0.x-GA 7.0.x-GA

Module Dependencies

Optional Dependencies