Sales

Deals, pipelines, POS, and storefront commerce. This guide follows version 3.1.7 (03acdf712c).

For the catalog, see Products. For the storefront app, see POS Client.

Backend

backend/plugins/sales_api/src/:

  • modules/sales/: deals, boards, pipelines, stages, checklists, labels.
  • modules/pos/: POS configs, orders, covers, with segment and automation hooks.
  • modules/ecommerce/: wishlist, reviews, addresses, last-viewed.
  • meta/{permissions,automations,segments,documents,notifications}.ts, trpc/ (deal, POS, document routers plus agentMeta.ts).

The service starts as startPlugin({ name: 'sales', port: 3305 }) with subscriptions enabled. tRPC procedures opt into agent tools via .meta({ agent }); see GraphQL & tRPC.

Frontend

frontend/plugins/sales_ui/src/: modules/{deals,payments,pos}/, pages/, widgets/ (relation, notification, automation entries). Dev remote port is 3005. config.tsx declares navigation, relationWidgets, propertyInputs, and search providers.

Verify

  1. Create a board, pipeline, and deal, then move the deal across stages.
  2. Configure a POS, place an order, and confirm inventory and payment hooks fire.
  3. Confirm permissions: a viewer role cannot mutate deals or POS config.

Source references

Was this helpful?