Docs

Shop modules

uticms.shop.overview · verified 2026-07-14

Overview

Scope
Shop commerce core, ShopB2C storefront, and OneCBridge integration

Key concepts

Shop
Installable commerce-core module with catalog, pricing, stock, orders, payments, receipts, and API integration.
Shop B2c
Optional Shop-dependent B2C storefront/template module.
One C Bridge
Shop-dependent CommerceML/1C exchange module.

Structure

  • Shop
    • Modulemodules/Shop
    • Api Routesmodules/Shop/Routes/api.php
    • Models
      • Catalog
      • Product
      • Offer
      • Price
      • PriceType
      • Stock
      • StockReservation
      • Warehouse
      • Order
      • PaymentTransaction
      • Receipt
      • Brand
    • AdminFilament resources, settings, widgets, and console commands under modules/Shop
  • Storefront
    • Modulemodules/ShopB2C
    • Web Routesmodules/ShopB2C/Routes/web.php
    • Layout Drivershop_b2c
  • One C
    • Modulemodules/OneCBridge
    • Api Routesmodules/OneCBridge/Routes/api.php

Facts

  • Shop is installable, exposes API routes, declares schema tables, migrations and an install seeder, and has priority 200. authoritative
  • Shop sources define catalog, product, offer, prices, warehouses, stock reservations, search index, facets, orders, payment transactions, and receipts. authoritative
  • Shop includes acquiring abstractions with cash and YooKassa systems and a receipt listener for paid orders. authoritative
  • ShopB2C requires Shop ^1.0, is installable, provides web routes and views, contributes site layout driver shop_b2c, and contains catalog/cart/checkout/account controllers. authoritative
  • OneCBridge requires Shop ^1.0, has API routes and migrations, and is not marked as installable by its manifest. authoritative

How-to guides

Add Storefront Feature

  1. verify compatible active Shop and ShopB2C modules
  2. identify whether the change belongs to Shop API/domain or ShopB2C web/layout layer
  3. preserve declared route, view, and layout-driver boundaries
  4. verify catalog, cart, checkout, or account flow affected by the change

Rules

Architectural rule

Keep Shop business-domain behavior in Shop; treat ShopB2C as storefront/template integration.

Examples

Module Layers

Shop (modules/Shop) — domain, admin, API, order placement
ShopB2C (modules/ShopB2C) — web routes, layout driver shop_b2c, cart/checkout UI
OneCBridge — CommerceML API; manifest install=false

modules/Shop/README.md

Shop Dependency

"dependencies": { "required": { "shop": "^1.0" } }

modules/ShopB2C/module.json