SUMMARY.md

Table of contents

• Home

Concepts

• Commerce
  • Catalog
    • Categories
    • Products
    • Sales Channels
  • Checkout
    • Cart
    • Payments
    • Orders
  • Content
    • Shopping Experiences (CMS)
• Framework
  • Architecture
    • Storefront
    • Administration
  • Data Abstraction Layer
  • Messaging
  • Migrations
  • Rules
  • HTTP Cache
  • Elasticsearch
  • Flow
• Extensions
  • Apps
  • Plugins
• API
  • Store API
  • Admin API

Products

• Editions
  • Community Edition
  • Professional Edition
  • Enterprise Edition
    • B2B Suite
      • Concepts
        • System architecture
        • Basic conventions
        • Method structure
        • Line Item List
      • Guides
        • Installation
        • Core
          • Dependency injection
          • Store API
          • REST API
          • Listing service
          • CRUD service
          • Assignment service
          • Audit Log
          • Exception
          • Currency
          • Entity based ACL
          • Overloading classes
          • Store Front Authentication
        • Storefront
          • Ajax Panel
          • Product Search
          • Complex views
          • Modal component
          • Company
          • Acl Routing
          • Extending the storefront
        • Administration
        • Example Plugins
    • Search
      • Installation
      • Field Configuration
      • Extensibility
      • Boosting
      • Completion
      • Relevance
      • Synonyms
• Plugins
  • Migration Assistant
    • Concept
      • Profile and Connection
      • DataSelection and DataSet
      • Migration Context
      • Premapping
      • Gateway and Reader
      • Convert and Mapping
      • Logging
      • Writer
      • Media Processing
    • Guides
      • Extending a Shopware migration profile
      • Extending the Migration Connector
      • Decorating a Shopware Migration Assistant converter
      • Creating a new migration profile
• Cloud
• Enterprise Cloud
  • CLI Setup
  • Repository
  • Build & Deploy
  • Setup Template
  • Theme Build
  • Elasticsearch
  • RabbitMQ
  • Fastly
• PWA

Guides

• Installation
  • Installation overview
  • Dockware
  • Docker
  • Installation from scratch
  • Valet+
  • MAMP
• Extensions
  • Overview
  • Plugins
    • Plugin Base Guide
    • Plugins for Symfony developers
    • Plugin fundamentals
      • Add plugin configuration
      • Use plugin configuration
      • Database migrations
      • Dependency injection
      • Listening to events
      • Add custom service
      • Adjusting a service
      • Add plugin dependencies
      • Add custom CLI commands
      • Add scheduled task
      • Using custom fields of type media
      • Adding NPM dependencies
      • Adding Composer dependencies
      • Plugin lifecycle methods
    • Checkout
      • Cart
        • Add cart collector/processor
        • Add cart items
        • Add cart discounts
        • Add cart validator
        • Change price of items in cart
        • Customize price calculation
      • Document
        • Add custom document
        • Add custom document type
      • Order
        • Using the state machine
        • Listen to order changes
      • Payment
        • Add payment plugin
        • Customize payment provider
    • Content
      • CMS
        • Add CMS block
        • Add CMS element
        • Add data to CMS element
      • Mail
        • Add data to mails
        • Add mail templates
      • Media
        • Add custom media extension
      • SEO
        • Add custom SEO URLs
      • Sitemap
        • Add custom sitemap entries
        • Modifying sitemap entries
    • Elasticsearch
      • Add product entity extension to elasticsearch
    • Framework
      • Data Handling / DataAbstractionLayer
        • Reading data
        • Writing data
        • Adding custom complex data
        • Adding complex data to existing entities
        • Replacing associated data
        • Removing associated data
        • Adding data associations
        • Adding data translations
        • Using database events
        • Using flags
        • Field inheritance
        • Versioning entities
      • Custom Fields
        • Add custom field
        • Fetching data from "entity selection" custom field
      • Event
        • Add custom event
        • Finding events
      • Message Queue
        • Add message to queue
        • Add message handler
        • Add middleware
      • Rule
        • Add custom rules
      • Store API
        • Add store API route
        • Add caching for Store API route
        • Override existing route
      • Filesystem
        • Filesystem - Flysystem
      • Flow
        • Add Flow Builder action
        • Add Flow Builder trigger
      • Rate Limiter
        • Add Rate Limiter to API Route
    • Administration
      • Add custom module
      • Add custom component
      • Add custom route
      • Add menu entry
      • Writing templates
      • Adding snippets
      • Adding Mixins
      • Using Mixins
      • Adding Services
      • Extending Services
      • Adding permissions
      • Using the data handling
      • Adding error handling
      • Customize modules
      • Override existing routes
      • Add tab to existing module
      • Customizing components
      • Using assets
      • Using Directives
      • Add custom input field to existing component
      • Using base components
      • Add custom styles
      • Using the data grid component
      • Extending Webpack
      • Using Utility functions
      • Adding responsive behavior
      • The Shopware object
      • Add filter
      • Using filter
      • Using custom fields
      • Add custom data to the search
      • Add shortcuts
      • Add rule assignment configuration
    • Storefront
      • Customize templates
      • Add custom controller
      • Add caching to custom controller
      • Add dynamic content via AJAX calls
      • Add custom Javascript
      • Override existing Javascript
      • Add custom assets
      • Add custom styling
      • Add custom icons
      • Add custom page
      • Add custom pagelet
      • Add translations
      • Add custom listing filters
      • Fetching data with Javascript
      • Add data to storefront page
      • Add cookie to manager
      • Reacting to cookie consent changes
      • Reacting to javascript events
      • Use CSRF protection
      • Working with media and thumbnails
      • Remove Javascript plugin
      • Add custom field in the storefront
      • Add custom sorting for product listing
      • Add SCSS variables
      • Add SCSS variables via Subscriber
      • Using a modal window
      • Using the datepicker plugin
      • Use nested line items
    • Testing
      • End-to-end testing
      • Jest unit tests in Shopware's administration
      • Jest unit tests in Shopware's storefront
      • PHP unit testing
  • Themes
    • Theme base guide
    • Create a first theme
    • Differences Plugins and Apps vs Themes
    • Theme configuration
    • Add SCSS Styling and JavaScript to a Theme
    • Override Bootstrap variables in a Theme
    • Add assets to a Theme
    • Add custom icons
    • Theme inheritance
    • Theme with Bootstrap styling
    • Theme inheritance configuration
  • Apps
    • App Starter Guides
      • Starter Guide - Reading and writing data
      • Starter Guide - Add an API endpoint
      • Starter Guide - Admin Extensions
    • App Base Guide
    • App Scripts
      • Cart manipulation
      • Data loading
      • Custom endpoints
    • Hosting Guide
      • Platform.sh Deployment
    • Platform.sh template
    • Local development
      • App development with docker
      • App development with platform.sh
    • Storefront
      • Apps as themes
      • Add cookies to the consent manager
    • Administration
      • Add custom action button
      • Add custom module
    • Flow Builder
      • Add custom flow action from app system
    • Custom Data
      • Custom fields
      • Custom entities
    • Configuration
    • Payment
    • Content
      • CMS
        • Add custom CMS blocks
    • Rule Builder
      • Add custom rule conditions
• Hosting
  • Installation & Updates
    • Deployments
      • Deployment with Deployer
      • Building without Database
    • Cluster Setup
    • Versioning & Dependencies
  • Performance
    • Cache
    • Session
    • Increment Storage
    • Lock Storage
    • Number Ranges
    • Performance Tweaks
  • Infrastructure
    • Filesystem
    • Message Queue
    • Reverse Http Cache
    • Elasticsearch
      • Set up Elasticsearch
      • Debugging Elasticsearch
    • Rate Limiter
    • Database Cluster
• Integrations / API
  • General Concepts
    • Search Criteria
    • Request Headers
    • Generated Reference
    • API Versioning

Resources

• References

  • API Reference

    • Store API Reference
    • Admin API Reference

  • Core Reference

    • DAL Reference
      • Fields Reference
      • Flags Reference
      • Filters Reference
      • Aggregations Reference
    • Administration Reference
      • Utils
      • Mixins
    • Commands Reference
    • Flow Reference
    • Rules Reference

  • Architecture Reference

    • Admin
      • Unified notification titles
      • Introduce eslint on vue admin
      • The best practice to always re fetch the data after saving
      • Introduce jest fail on console
      • Import acl privileges from other roles
      • Providing the admin extension sdk
      • Admin extension API standards
      • Merge e2e projects into a single project
      • Add possibility for plugin to add a html file
      • Refactor admin build process to webpack multi compiler mode
      • Extract data handling classes to extension sdk
    • API
      • Controller configuration route defaults
      • Add login required annotation
      • Removing API version
      • Implement sales channel context token requirement
    • App
      • Implement app system inside platform
      • App scripting
      • Rule scripting in apps
      • Custom app API endpoints
      • Technical concept custom entities
      • Integrate app into flow action
    • Cache
      • Cache stampede protection
      • Reset class state during requests
    • Checkout
      • Tax providers
      • Make core mail templates independent from storefront urls
      • Merchant registration
      • Nested line items
      • Payment flow
      • New nested line items
      • Document template refactoring
      • Refund handling
    • DAL
      • Specify priority of translations in DAL write payloads
      • Control clone behavior
      • When to use plain sql or DAL
      • DAL join filter
    • Deployment
      • Make platform stand alone
    • Extension
      • Decoration pattern
      • Custom field label loading in storefront
      • Creating events
    • Inventory
      • Available stock
      • Implement individual sorting
    • Performance
      • Redis cart persister
      • Prevent mail updates
      • Profiler integrations
      • Increment pattern
      • Base context factory
      • Initial state id loader
    • Rule
      • Preparing data for rule evaluation
      • Rule condition field abstraction
    • Storefront
      • Add feature flag support for storefront scss
      • Move storefront scripts to head
      • Refactor theme inheritance
      • Storefront coding standards
    • Workflow
      • Deprecation strategy
      • Handling feature flags
      • Implement architecture decision records
      • Remove static analysis with psalm
      • Feature flag system
      • Consistent deprecation notices in core
      • Adjust ADR approval rules
      • Implement New Changelog

  • App Reference

    • Manifest Reference
    • Webhook Events Reference
    • Payment Reference
    • CMS Reference
    • Entities Reference
    • Flow Action Reference
    • Script Reference
      • Cart manipulation services reference
      • Data loading services reference
      • Custom endpoint script services reference
      • Miscellaneous script services reference
      • Script hooks reference

  • Administration Reference

    • Utils

  • Storefront Reference

    • Shopware's twig functions

  • Testing Reference

    • Custom E2E Commands
    • PSH E2E Commands
• Guidelines
  • Code
    • Contribution Guidelines
    • Backward Compatibility
    • Cart Process
    • Context Rules & Rule Systems
    • Dependency Injection & Dependency Handling
    • Document Code
    • Events
    • Page Loader
    • Platform Domains
    • Public APIs
    • Routing
    • Session and State
    • Store API
    • Storefront Controller
  • Documentation
    • Structure
    • Writing
    • Templates
      • Guide Documentation Template
  • Testing
    • Best practises on writing end-to-end tests
• Tooling
  • IDE
    • Shopware Toolbox