Skip to main content

Getting Started

The Org Hierarchy plugin adds B2B organizational structure to Vendure. It lets you model companies, business units, users with roles and permissions, addresses, and payment methods -- everything a multi-user corporate purchasing workflow needs.

Core Concepts

  • Company -- A business entity with a state machine lifecycle (Pending, Active, Suspended, Denied, Closed).
  • CompanyUser -- Links a Vendure Customer to a Company with its own state machine (Invited, Active, Suspended, Removed).
  • CompanyBusinessUnit -- Hierarchical departments/divisions within a company (configurable max depth, default 3).
  • CompanyRole -- Named roles scoped to a company, containing a set of permissions.
  • CompanyPermission -- Fine-grained permissions (built-in and custom) assigned to roles.
  • CompanyAddress -- Shipping/billing addresses at the company or business unit level.
  • CompanyPaymentMethod -- Payment methods available to one or more companies, optionally linked to a Vendure PaymentMethod.

Exclusive to Vendure Platform

This page is part of the Vendure Platform documentation. Access requires a valid Vendure Platform license.