Download the PHP package orangecat/module-company-methods without Composer

Orangecat_CompanyMethods

Restrict the payment and shipping methods available to each company at checkout.

Module: Orangecat_CompanyMethods | Version: 1.0.0 | License: OSL-3.0 | Author: Oliverio Gombert

Table of Contents

1. Overview
2. Theme Compatibility
3. Requirements
4. Installation
5. What Gets Installed
6. Configuration
7. Store Admin Guide
8. Buyer Guide (Frontend)
9. Developer Guide
10. REST API
11. Frontend Routes Reference
12. DevOps & Integrator Notes

1. Overview

Orangecat_CompanyMethods lets store administrators define which payment and shipping methods are available to each company. At checkout, the module intercepts Magento's native method-resolution pipeline via plugins and filters the returned lists against the allowed methods stored for the active customer's company.

Responsibilities:

• Stores per-company payment and shipping method allowlists in the mycompany_methods database table.
• Injects a Sales Methods fieldset into the Company admin edit form, exposing multiselect pickers for payment and shipping methods.
• Filters available payment methods at checkout via an after plugin on Magento\Payment\Model\MethodList::getAvailableMethods.
• Filters available shipping methods at checkout via after plugins on Magento\Quote\Model\ShippingMethodManagement::estimateByExtendedAddress and estimateByAddressId.
• Persists method assignments when a company is saved in the admin via an after plugin on Orangecat\Company\Api\CompanyRepositoryInterface::save.
• Loads stored assignments back into the admin form via an after plugin on the Company DataProvider.

Position in the Orangecat B2B Dependency Chain

Empty Assignment Semantics

When no methods are stored for a company, the module applies no restriction — all store-level payment and shipping methods remain available at checkout. A restriction takes effect only when at least one method code is explicitly saved for that company and type. This is an intentional pass-through default: newly created companies inherit no limits without any admin action required.

2. Theme Compatibility

Because the module operates exclusively through backend plugins on Magento's checkout APIs, the method lists presented to the storefront are already filtered before any theme-specific rendering occurs. No theme-specific templates, layout files, or JS components are needed.

3. Requirements

4. Installation

Step 1 — Add as a git submodule (if working from the B2B SDK development environment):

Step 2 — Enable the module (run inside reward shell):

5. What Gets Installed

Database Tables

mycompany_methods — Company Payment and Shipping Method Assignments

Constraints:

• PRIMARY KEY (entity_id)
• FOREIGN KEY (company_id) → mycompany (entity_id) ON DELETE CASCADE
• UNIQUE KEY (company_id, method_type, method_code) — prevents duplicate assignments

EAV Attributes

None.

Data Patches

None. No default records, roles, CMS pages, or seed data are created on install.

6. Configuration

This module has no system.xml and therefore no global or store-scoped configuration stored in core_config_data.

All configuration is per-company and is stored directly in the mycompany_methods table (see Store Admin Guide).

7. Store Admin Guide

Accessing the Sales Methods Settings

1. In the Magento Admin, navigate to Companies (the main Companies grid provided by Orangecat_Company).
2. Click Edit on the target company.
3. Scroll to the Sales Methods fieldset near the bottom of the form.

Sales Methods Fieldset

The Payment Methods picker is populated from Magento\Payment\Api\PaymentMethodListInterface::getActiveList. The Shipping Methods picker lists all active carriers from Magento\Shipping\Model\Config::getActiveCarriers, displayed as Carrier Title - Method Title.

Workflow: Restrict a Company to Specific Methods

Example: Allow only Purchase Order and Company Credit for payment; restrict shipping to flat rate only.

1. Open the company edit form.
2. In Payment Methods, hold Ctrl/Cmd and select Purchase Order and Company Credit.
3. In Shipping Methods, select Flat Rate - Fixed.
4. Click Save Company.

From this point, buyers belonging to that company will see only those methods at checkout. All other methods are hidden, regardless of store-level configuration.

Removing All Restrictions

To re-allow all store methods for a company, open the company form, clear all selections in both multiselects (click each selected item to deselect, or use your browser's multiselect clear mechanism), and save. When no items are stored, the module applies no filtering.

8. Buyer Guide (Frontend)

There are no dedicated frontend pages or routes in this module. The module's effect is fully transparent to the buyer — restricted methods simply do not appear in the checkout shipping step or payment step.

What buyers experience:

• During checkout, only the payment and shipping methods allowed for their company are shown.
• If their company has no restrictions configured, all store-level methods appear as normal.
• If a previously saved cart or session references a method that has since been restricted, the buyer will need to select an available method before completing the order.

No frontend login, dashboard, or URL is associated with this module.

9. Developer Guide

Module Structure

Key Classes

Orangecat\CompanyMethods\Api\Data\CompanyMethodsInterface

Data object for a single method assignment row.

Constants: TYPE_PAYMENT = 'payment', TYPE_SHIPPING = 'shipping'.

Orangecat\CompanyMethods\Api\CompanyMethodsRepositoryInterface

Observers

None — this module registers no event observers.

Plugins

Filtering logic (both checkout plugins): If the company has zero stored methods of a given type, the original result is returned unchanged. If at least one method is stored, only methods whose code appears in the stored list are kept; all others are removed. Errors during lookup are caught, logged, and the original list is returned as a safe fallback.

JS Components

None — this module ships no JavaScript files.

Email Templates

None.

ACL Resources

None — this module does not register ACL resources. Access to the Sales Methods fieldset is governed by the existing Company edit ACL from Orangecat_Company.

Adding Custom Logic

• Custom filtering logic: Decorate Orangecat\CompanyMethods\Api\CompanyMethodsRepositoryInterface via di.xml preference or add a before plugin on PaymentMethodListPlugin::afterGetAvailableMethods to modify the allowed list before filtering is applied.
• Custom persistence logic: Add an after plugin on Orangecat\CompanyMethods\Api\CompanyMethodsRepositoryInterface::save or override CompanyRepositoryPlugin::saveMethodsByType via a preference to add validation or side-effects when assignments change.
• Extending the admin form: Add additional fields to the sales_methods fieldset by extending mycompany_company_form.xml in your own module's view/adminhtml/ui_component/ directory.

10. REST API

This module exposes no REST endpoints. There is no etc/webapi.xml. Method assignment is performed exclusively through the admin UI.

11. Frontend Routes Reference

This module has no frontend controllers or routes. There is no etc/frontend/routes.xml. All functionality is backend-only.

12. DevOps & Integrator Notes

Deployment Checklist

Integration Token Scope

This module has no dedicated ACL resources. An integration token with access to the Company entity (via Orangecat_Company ACL resources) is sufficient for any programmatic use. No additional minimum ACL permissions are required.

Disabling Without Uninstalling

When disabled, the checkout filter plugins are deactivated — all store-level payment and shipping methods become available to all companies again. The mycompany_methods table and its data persist in the database. Re-enabling the module immediately restores all previously configured restrictions without data loss.

Data Integrity Notes

• Cascade delete: Rows in mycompany_methods are automatically deleted when the referenced company (mycompany.entity_id) is deleted. No orphan cleanup is needed.
• Unique constraint: The (company_id, method_type, method_code) unique key prevents duplicate assignments. The CompanyRepositoryPlugin performs a delete-then-insert strategy on each save, so stale entries are always replaced cleanly.
• Method code stability: Stored method codes are raw Magento codes (checkmo, flatrate_flatrate, etc.). If a payment or shipping provider is removed from the store, its codes remain in mycompany_methods as orphaned strings — they will simply never match any available method and have no visible effect. Clean them up manually if needed.