Glossary¶
A single-source list of terms that recur across the marketplace suite. Most have fuller treatment on a specific page; this is the index.
| Term | One-line definition | See |
|---|---|---|
| Base | The mandatory FlyokaiMarketplace plugin. Runs the whole marketplace in-process inside Shopware. |
Architecture |
| Buy-box | The winning seller offer surfaced on a product page / cart when several sellers offer the same product. | Cart & checkout |
| Commission | The platform's cut of a sale; per-product (flyokaiCommissionPercent) or the global default, snapshotted onto each PO line. |
Domain model |
dataLocation |
Remote system-config selector — shopware or cluster — for which MySQL holds the data plane. Flip only via migrate commands. |
Going remote |
| Data plane | The marketplace business tables (flyokai_seller*, _offer*, _purchase_order*, finance, shipping, mail). Movable under Remote. |
Architecture |
flyok-portal route scope |
The custom Symfony route scope (FlyokPortalRouteScope) gating /flyok-portal/* behind portal-JWT validation. |
Seller portal |
flyokai_* tables |
The 23 declarative DTO-backed tables the Base plugin creates in Shopware MySQL on install. | Domain model |
| Hybrid (price mode) | priceDisplayMode=hybrid — native price kept; widget adds a synthetic "Platform" offer. |
Cart & checkout |
| Identity plane | flyokai_user, OAuth client/token tables, mail outbox. Always Shopware-side; never moves with dataLocation. |
Architecture |
LocalMarketplaceBackend |
Base's MarketplaceBackend binding — dispatches Requests in-process via marketplace-embedded. |
Architecture |
| Maintenance gate | The Remote flag set during a data migration; the backend rejects mutating Requests while reads continue. | Data migration |
MarketplaceBackend |
The single interface (sendRequest) every piece of marketplace logic travels through. Bound to Local or Remote. |
Architecture |
| Offer | One seller's proposition to sell one product/variant at a price (flyokai_seller_offer + price/stock). Per-variant. |
Domain model |
| Operator | Platform staff — a flyokai_user with an operator/admin role; works in the Shopware admin. |
Admin |
| Ownership | Whether a product is operator-owned (NULL) or seller-owned (product.flyokai_product_owner_id). Gates what a seller may touch. |
Domain model |
| Payout | A money movement to a seller against a closed statement (flyokai_payout). pending → executing → completed. |
Finance |
| Pending approval | The status new/edited seller products and offers sit in until an operator approves (unless auto-approve is on). | Domain model |
| Portal JWT | RS256 token the seller portal sends as a bearer on /flyok-portal/*; signed with var/marketplace/oauth.id_rsa. |
Seller portal |
| Price display mode | priceDisplayMode — marketplace / hybrid / native; how offers interact with Shopware's native price. |
Cart & checkout |
| Purchase order (PO) | The per-seller slice of a buyer order (flyokai_purchase_order + lines), with its own status and totals. |
Domain model |
| Remote | The optional FlyokaiMarketplaceRemote plugin — rebinds MarketplaceBackend to a Flyokai cluster. |
Going remote |
RemoteMarketplaceBackend |
Remote's binding — serializes Requests over amp-channel-dispatcher to a cluster worker. | Architecture |
| Seller | A marketplace account (flyokai_seller ↔ flyokai_user) that lists offers, fulfils orders and gets paid. |
Domain model |
| Service tier | A named shipping option (Standard / Expedited) sellers map their carriers onto. | Cart & checkout |
| Shipping mode | marketplaceShippingMode — aggregated (one cart-wide picker) or split (per seller). |
Cart & checkout |
| Snapshot | The freezing of offer + commission + price onto a PO line at order placement, so later edits don't change past orders. | Cart & checkout |
| Statement | A seller's POs over a closed date interval rolled into a payable figure (flyokai_statement + lines). |
Finance |
| Stock source | A seller warehouse (flyokai_seller_stock_source) an offer's stock is held against. |
Domain model |
| Transaction fee | A flat per-PO fee (defaultTransactionFeeAmount) deducted from a seller's payout, snapshotted at placement. |
Domain model |