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

Orangecat_PricesCompany

Per-company, per-SKU, quantity-aware custom pricing rules for Magento 2 B2B.

Module: Orangecat_PricesCompany Version: 1.0.0 License: OSL-3.0 Author: Oliverio Gombert [email protected]

Table of Contents

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

Overview

Orangecat_PricesCompany attaches company-specific pricing rules directly to a company entity. Each rule targets a single SKU at a minimum purchase quantity and applies one of three discount strategies: a fixed final price, a flat amount off, or a percentage off. Rules are quantity-tiered: the highest-matching threshold applies, enabling volume pricing per company.

The module registers a PricesCompanyCalculator into the Orangecat_Prices orchestrator pool. The orchestrator calls every registered calculator in sequence; this module's calculator returns a price (or null if no rule matches) and the orchestrator applies it to the product.

Responsibilities:

• Store per-company, per-SKU, per-quantity pricing rules in a dedicated flat table
• Register a price calculator into the Orangecat_Prices orchestrator pool
• Expose an Admin UI grid to browse companies and manage their pricing rules
• Support adding products via an interactive AJAX modal with per-row discount configuration
• Expose a REST API for programmatic bulk upsert, search, calculation, and deletion
• Support bulk CSV import/export via Magento's native ImportExport framework

Position in the Orangecat B2B Dependency Chain

Price Resolution Strategy

When the Prices orchestrator resolves the final price for a product, it passes a $basePrice to each registered calculator. This module's behavior depends on the Price Resolution Strategy setting:

Discount Types

For fixed_amount and percentage, the base_price used is determined by the resolution mode (see above). The calculated price is floored at 0.0 and never goes negative.

Tier Pricing

Multiple rules for the same company + SKU at different qty thresholds create volume tiers. The calculator picks the rule with the highest qty that is ≤ the requested quantity. The getTiers() method returns all tier breakpoints (qty > 1) for display on the product page.

Theme Compatibility

This module has no frontend views. All pricing logic runs server-side inside the orchestrator pool and surfaces through the standard catalog price layer, making it theme-agnostic.

Requirements

Installation

This module ships as a git submodule of the main B2B SDK repository.

What Gets Installed

Database Tables

pricescompany_item — Flat table storing per-company pricing rules.

Constraints and indexes:

• Unique: (company_id, sku, qty) — only one rule per company/SKU/quantity combination
• Index: company_id (btree), sku (btree)
• Foreign key: company_id → mycompany.entity_id with ON DELETE CASCADE

EAV Attributes

None.

Data Patches

None. No default records are created on install.

Configuration

Settings live under Stores > Configuration > Prices > Company Custom Prices.

Company Custom Prices (prices/pricescompany)

The resolution_mode field accepts two values: overwrite and stack.

Store Admin Guide

Navigation

Catalog > Manage Company Prices

This menu item opens the Company Prices index, a grid listing all companies from the mycompany table.

Company Prices Index

The grid shows every company with columns for company name and ID. From here you can:

• Click a company row (or the Edit action) to open that company's pricing rules.
• Use the grid's search and filter tools to locate a specific company.

Company Edit Screen — Pricing Rules Grid

Opening a company shows its item grid: all custom pricing rules for that company.

Available columns in the item grid:

Adding rules — "Add Products" button:

1. Click Add Products. A product selector modal opens (standard Magento catalog grid).
2. Select one or more products and click the Add button.
3. A pricing dialog appears with one row per selected product, pre-filled with the catalog price.
4. For each row, choose the Discount Type and enter the Amount. Optionally adjust the Qty threshold (defaults to 1).
5. Click Confirm & Add. The rules are saved immediately via AJAX and the item grid reloads.

Inline editing:

Double-click any cell in the Qty, Amount, or Discount Type columns to edit it inline. Changes save automatically on blur.

Deleting rules:

• Click the Delete action on a single row.
• Select multiple rows and use Actions > Delete for mass deletion.

CSV Import

Navigate to System > Import, select entity type Company Custom Prices, and upload a CSV file.

Required CSV columns: company_id, sku, qty, discount_type, amount.

A sample file is available at Files/Sample/pricescompany_item.csv:

Supported behaviors: Add/Update (append), Replace, Delete.

Validation checks:

• company_id must exist in the mycompany table.
• sku must exist in the product catalog.
• discount_type must be one of fixed_price, fixed_amount, percentage.
• company_id, sku, qty, and amount are all required.

Developer Guide

Module Structure

Key Classes

Service Contracts

Calculator

Model\Calculator\PricesCompanyCalculator implements Orangecat\Prices\Api\PriceCalculatorInterface:

Selects the highest-matching quantity rule (qty <= $qty, ordered DESC) and applies the discount. Returns null if the module is disabled or no rule matches (the orchestrator then tries other calculators or falls back to the catalog price).

Returns all quantity tiers (qty > 1) as [['qty' => float, 'price' => float], ...] for storefront display.

Config

Model\Config provides typed access to the two system settings:

Observers

This module registers no observers.

Plugins

This module registers no plugins.

JS Components (Admin)

Email Templates

This module sends no email notifications.

ACL Resources

Adding Custom Logic

• New discount strategy: Add a constant to Model\Config\Source\DiscountType, add the label to toOptionArray(), and add a case branch in PricesCompanyCalculator::calculate() and ::getTiers().
• Custom calculator priority: Adjust the di.xml CalculatorPool injection order or weight to control when this calculator runs relative to other pool members (e.g., PricesList).
• Post-save hook: Add an observer for Magento\Framework\App\ResourceConnection-level events, or use a plugin on PricesCompanyItemRepository::save() to trigger downstream logic (cache invalidation, ERP sync) after a rule is saved.

REST API

All endpoints except /calculate require the ACL resource Orangecat_PricesCompany::manage. The /calculate endpoint is anonymous — apply token-based access control at the integration level if needed.

Endpoints

Authentication

Generate an integration token with the Orangecat_PricesCompany::manage ACL resource, then pass it as a Bearer token.

Examples

Search rules for company 1:

Calculate final price:

Response: float — the resolved final price (falls back to catalog base price if no rule matches).

Bulk upsert:

Response: true on success.

Delete all rules for company 2:

Delete all rules for a SKU:

Frontend Routes Reference

This module has no frontend routes. All user-facing functionality (price display, tier prices) is delivered transparently through the catalog pricing layer managed by Orangecat_Prices.

DevOps & Integrator Notes

Deployment Checklist

Integration Token Scope

Minimum ACL permission required for API access: Orangecat_PricesCompany::manage (under Magento_Catalog::catalog). The /calculate endpoint is anonymous and does not require a token, but should be protected at the API gateway level in production if price data is sensitive.

Disabling Without Uninstalling

When disabled, the PricesCompanyCalculator is still registered in the DI graph but Config::isEnabled() returns false, causing calculate() and getTiers() to return early without touching the database. No pricing rules are lost.

Data Integrity Notes

• Cascade delete: Deleting a company from mycompany automatically removes all its pricing rules from pricescompany_item via the ON DELETE CASCADE foreign key. There is no soft-delete — removals are permanent.
• Unique constraint: (company_id, sku, qty) is enforced at the database level. The bulk upsert uses INSERT ON DUPLICATE KEY UPDATE, so re-importing the same combination updates the existing rule rather than creating a duplicate.
• SKU integrity: The module does not enforce a foreign key to the catalog. Deleting a product does not automatically remove its pricing rules. Orphan rules (rules referencing deleted SKUs) are harmless but should be cleaned up manually or via the DELETE /V1/pricescompany/items/sku/:sku endpoint.
• Module data persists after disable: The pricescompany_item table and its data survive module:disable. To fully remove all data, run setup:uninstall or drop the table manually after disabling.