Documentation Home

Broadleaf Commerce Marketplace Module

The marketplace module enables some key new features:

  • Vendor on-boarding capabilities and marketplace maintenance tooling
  • The ability for vendors to manage catalog and orders via portal or API
  • Tooling for marketplace admins to override and enhance vendor data
  • The ability to view and manage split orders and fulfilment via a portal or API
  • Cross-vendor, ordering, bundling and merchandising capabilities

In addition to the self service portal and admin consoles, this module also provides a combination of APIs, Endpoints, and Integration hook-points that aid in:

  • Managing new vendors
  • Integrating with various fulfillment providers or external systems
  • Inbound and outbound order and fulfillment syncing
  • Hook-points to handle order events like order submission, fulfillment, and cancellation

How it works

The marketplace feature set and functionality is broken down into two main categories: Catalog Organization and Order Fulfillment

Catalog Organization

As a vendor:
I am able to manage my catalog and product through my own vendor portal,
create a new product, and promote those changes to the marketplace for approval.

And as a Marketplace admin:
I am able to review those items, make any enhancements or merchandising changes, and finally deploy to production when ready.

Marketplace-Diagram-1

Fulfillment Orders

As orders are placed, the system automatically splits the order into “sub-orders” tied to each vendor.

Broadleaf provides the facilities for viewing all orders centrally, and provides portals for vendors to view and interact with just their portions of the order.

Marketplace-Diagram-2

Compatibility

Module Version Compatible Broadleaf Versions
1.0.0-GA 5.2.0-GA
2.0.0-GA 6.0.0-GA
2.2.0-GA 6.1.0-GA
2.3.0-GA 6.2.0-GA

Module Dependencies

Optional Dependencies

Module Installation

For detailed instructions on how to integrate the Gift Card and Customer Credit module into your project, please see Module Installation.