Sublogin Documentation

Welcome to the Sublogin extension documentation. This comprehensive B2B solution allows business customers to create and manage multiple sub-accounts with granular permissions and access control.

Quick Links

Getting Started

Core Features

Add-Ons

Use Cases

Troubleshooting

Overview

The Sublogin extension is a complete B2B solution that enables sophisticated user management within your Magento store. Business customers can create multiple sub-accounts for employees, departments, or branches, each with their own credentials and permissions.

Core Concept

Main Account (Customer)

The primary business customer account that owns all sublogins. This account has full control over creating, editing, and managing sublogins.

Sublogins (Sub-Accounts)

Individual accounts created under the main customer account. Each sublogin has:

Own email address and password
Own profile information
Assigned role and permissions (optional)
Budget limits (optional)
Address restrictions
Order history

Hierarchical Organization

Sublogins can be organized into groups with parent-child relationships, creating a complete organizational structure:

Customer Account ├── General (Group) │ ├── Branch A (Group) │ │ ├── Department 1 (Group) │ │ └── Department 2 (Group) │ └── Branch B (Group) └── Sublogins assigned to groups

Key Features

1. Unlimited Sub-Accounts

Create as many sublogins as needed for your organization. No limits on the number of sub-accounts.

2. Granular Permissions

Control exactly what each sublogin can do with role-based permissions (requires Roles add-on):

View products and prices
Add to cart and checkout
Place orders
View orders (own or all)
Manage other sublogins
And 30+ more permissions

3. Budget Control

Set spending limits per sublogin or department (requires Budget add-on):

Daily, monthly, yearly budgets
Per-order limits
Automatic tracking and enforcement

4. Approval Workflows

Implement multi-level order approval processes (requires Order Approval add-on):

Amount-based thresholds
Role-based approvers
Email notifications

5. Flexible Address Management

Three address modes:

Shared: Sublogins use customer addresses
Restricted: Sublogins can only use assigned addresses
Own: Sublogins create their own addresses

6. Impersonation

Main account holders and admins can "login as" sublogins to:

Test permissions
Assist with orders
Troubleshoot issues

Modular Architecture

The Sublogin system is modular with optional add-ons:

Core Module (Required)

Basic sublogin management
Address handling
Email system
Session management

Optional Add-Ons

Roles & Permissions: Advanced ACL system with 30+ permissions
Budget Management: Spending limits and tracking
Order Approval: Multi-level approval workflows
Catalog Visibility: Product restrictions per sublogin
API: Web API (REST/SOAP) endpoints for integrations
Import/Export: CSV export from admin grid + CLI import
Reports: Orders/products reporting in customer account + admin
Hyvä Compatibility: Layout/template compatibility for Hyvä storefronts
Mageplaza OSC Compatibility: Ensures checkout compatibility with Mageplaza One Step Checkout
Sample Data: Demo data for staging/dev environments

Common Scenarios

B2B Company

Main account: Company
Sublogins: Employees in Purchasing, Sales, Warehouse
Each department has own budget and permissions

Franchise

Main account: Franchise owner
Sublogins: Individual store locations
Each store has own addresses and order approval

Multi-Location Business

Main account: Head office
Sublogins: Branch offices
Shared catalog, separate budgets per location

Educational Institution

Main account: University
Sublogins: Departments/Faculties
Budget management with approval workflow

Database Structure

The extension uses several database tables:

customer_sublogin - Main sublogin accounts
customer_sublogin_address - Address assignments
customer_sublogin_payment - Payment method restrictions
customer_sublogin_shipping - Shipping method restrictions
customer_sublogin_role - Roles (add-on)
customer_sublogin_role_permission - Permissions (add-on)
customer_sublogin_group - Hierarchical groups (add-on)
customer_sublogin_budget - Budgets (add-on)

Integration Points

Customer ID Extension

Sublogins can have auto-generated customer IDs in format: {customer_id}-{number}

Sales Staff Extension

Assign sales representatives to sublogins for commission tracking

Price System Extensions

Customer-specific prices apply to all sublogins of that customer

Payment Profiles Extension

Combine with sublogin payment restrictions for advanced control