Skip to content

Main NavigationDocs Apps Themes APIs Frontends

HTTP APIs

Meteor

Meteor Admin SDK

Meteor Icon Kit

Meteor Component Library

Releases

Learning

Appearance

Sidebar Navigation

Docs

Concepts

Commerce

Catalog

Products

Categories

Sales Channels

Checkout

Cart

Orders

Payments

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

Guides

Installation

Community Setups

Dockware

Requirements

Template

Devenv

Extensions

Plugins

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

Logging

Checkout

Cart

Add cart collector/processor

Add cart items

Add cart discounts

Add cart validator

Change price of items in cart

Customize price calculation

Tax provider

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

Prevent Deletion of Media Files Referenced in your Plugins

Add custom media extension

SEO

Add custom SEO URLs

Sitemap

Add custom sitemap entries

Modifying sitemap entries

Stock

Implementing your own stock storage

Loading Stock Information from a different Source

Reading and Writing Stock

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

Adding Data Indexer

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

Running actions inside transactions

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

Handling media

Injecting services

Modify dynamic product groups blacklist

The Sanitizer helper

Using Vuex Stores

Storefront

Customize templates

Add custom controller

Add caching to custom controller

Add dynamic content via AJAX calls

Add custom Javascript

Override existing Javascript

Add Javascript as script tag

Add custom assets

Add custom captcha

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

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

Add custom twig functions

Testing

End-to-end testing

Jest unit tests in Shopware's administration

Jest unit tests in Shopware's storefront

PHP unit testing

API

Custom Pricing

Multi Inventory

Plugin Base Guide

Plugins for Symfony developers

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 - Read and write data

Starter Guide - Add an API endpoint

Starter Guide - Create Admin Extensions

App SDKs

Official PHP SDK

Getting started

Lifecycle

Context

Signing

HTTP-client

Events

Official Symfony bundle

App Scripts

Cart manipulation

Data loading

Custom endpoints

Storefront

Apps as themes

Customize templates

Add cookies to the consent manager

Administration

Meteor Admin SDK

Add custom action button

Add custom module

Add CMS element

Add translations for apps

Flow Builder

Add custom flow action from app system

Add custom flow trigger from app system

Custom Data

Custom fields

Custom entities

Content

CMS

Add custom CMS blocks

Rule Builder

Add custom rule conditions

App Base Guide

Configuration

Tax provider

Payment

Webhook

Shipping methods

Client-side communication to the app backend

Overview

Hosting

Installation & Updates

Deployments

Deployment with Deployer

Deployment Helper

Building without Database

Cluster Setup

Extension Management

Configurations

Shopware

HTML sanitizer

Staging

Stock

Framework

SameSite protection

Observability

Logging

Profiling / Tracing

OpenTelemetry

Performance

Cache

Custom cache invalidation

Session

Increment Storage

Lock Storage

Number Ranges

Performance Tweaks

Infrastructure

Elasticsearch

Set up Elasticsearch

Debugging Elasticsearch

Filesystem

Rate Limiter

Database Cluster

Message Queue

Scheduled Task

Reverse HTTP Cache

Integrations / API

General Concepts

Search Criteria

Request Headers

Generated Reference

API Versioning

Partial Data Loading

Products

Extensions

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

Concept

Guides

B2B Suite

Concepts

System architecture

Basic conventions

Method structure

Line Item List

Guides

Core

Dependency injection

Store API

REST API

Listing service

CRUD service

Assignment service

Audit Log

Exception

Currency

Entity based ACL

Overloading classes

Storefront Authentication

Installation

Storefront

Ajax Panel

Product Search

Complex views

Modal component

Company

ACL and Routing

Extending the Storefront

Example Plugins

Administration

B2B Components

Employee Management

Concepts

Entities & Schema

API Route Restriction for Employees

Guides

Employee Invitation

B2B Roles

Create permissions via App

Create permissions via plugin

Quotes Management

Entities & Schema

Quotes conversion

Guides

Feature Toggles

Order Approval

Entities and workflow

Order approval permissions

Payment Process

How to add a new approval condition

Advanced Search

Installation

Define a custom Elasticsearch Definition

Add more fields to product search

Configure Searchable Fields

Language analyzers

Cross search

Extending search template

Modify search logic

Search and suggest routes

Completion

PaaS

CLI Setup

Repository

Build & Deploy

Setup Template

Theme Build

Elasticsearch

RabbitMQ

Fastly

Digital Sales Rooms

Installation

Admin installation

Front-end app installation

Realtime Video Call - Daily.co

Realtime Service - Mercure

Configuration

PWA

SaaS

Community Edition

Plugins

Commercial

Resources

References

API Reference

Core Reference

DAL Reference

Fields Reference

Flags Reference

Filters Reference

Aggregations Reference

Commands Reference

Flow Reference

Rules Reference

Actions Reference

App Reference

Script Reference

Cart manipulation services reference

Data loading services reference

Custom endpoint script services reference

Miscellaneous script services reference

Script hooks reference

Product script services reference

Manifest Reference

Webhook Events Reference

Payment Reference

CMS Reference

Entities Reference

Flow Action Reference

Administration Reference

Utils

Mixins

Directives

Upgrades

Administration

Vue 3 upgrade

Storefront Reference

Shopware's twig functions

Storefront plugins

Testing Reference

Custom E2E Commands

E2E Commands

Adr

Implement architecture decision records

Get control of association clone behavior as developer

Implement sales channel context token requirement for store-api and sales-channel-api

Implement new changelog

Feature flag system

Document template refactoring

Implement app system inside platform

Implement individual sorting

Merchant registration

Handling feature flags

Notification titles are pre-defined and make use of the global namespace

Import ACL privileges from other roles

CustomField label loading in storefront

The best-practice to always re-fetch the data after saving

Creating events in Shopware

DAL join filter

Add the login required annotation

Decoration pattern

API version removal

Deprecation strategy

Processing of nested line items

When to use plain SQL or the DAL

Vue administration app has ESLint support

Introduce jest-fail-on-console

Move storefront script to head with defer

Storefront coding standards

Make shopware/shopware stand-alone for development and testing

Refactor admin build process to webpack-multi-compiler mode

Make Core mail templates independent from Storefront urls

Technical concept custom entities

Refactor theme inheritance

Payment Flow

Refund handling

App scripts

Preparing data for rule evaluation

Adjust ADR approval rules for the new org structure

Introduce increment pattern

Merge E2E projects into a single project

Add possibility for plugins to add a HTML file

Admin extension API standards

Add feature flag support for Storefront SCSS

Allow apps to define custom api endpoints

Feature flags for major versions

Move controller level annotation into Symfony route annotation

Rule Scripting in apps

Domain exceptions

Consistent deprecation notices in Core

Use `ResetInterface` to reset instance state during requests

Extract data handling classes to extension sdk

New templates for line items and nested line items

Available stock improvements

Base context factory

Cache stampede protection

Initial state id loader

Prevent mail updates

Profiler integrations

Redis cart persister

Specify priority of translations in DAL write payloads

Add default cms pages to products and categories

Integrate an app into flow action

Introducing tax providers

Remove static analysis with psalm

Rule condition field abstraction

Integrate an app into the flow event

Add typescript support for storefront javascript

Providing the admin extension SDK

Concept for blogs using Shopping Experiences

Adding the `StorableFlow` instead of the `FlowEvent` for implementing the flow DelayAction in flow builder

Add bootstrap JS-plugin initialization utility to storefront JS

Mapping of product area

Hide and show CMS content

Deprecation handling during PHPUnit test execution

Test structure

Composer-based web updater

Deprecate the storefront CSRF implementation

Replace drop-shadow with box-shadow

Run Lighthouse tests in E2E env

Vue 2.7 update

Atomic theme compilation

Npm packages pre-release versions

Add native lazy loading for images to the storefront

App script product pricing

Deprecate autoloading associations in DAL entity definitions

Flow storer with scalar values

Follow test pyramid

Unstructured ADRs

Native extension system with vue

Admin text editor evaluation

Mocking repositories

Disable the CSS autoprefixer in the Storefront by default

New language inheritance mechanism for opensearch

Jest test files should be JavaScript only

Optimize cart cleanup

Experimental features

Stock Manipulation API

Use PHP 8.1 Enums

Symfony Dependency Management

Switch to UUIDv7

Exception Log Level configuration

Client side communication to App Server

Default handling for non specified salutations

Flow Builder Preview

Collecting and dispatching entity data

Media path rewrite

Post updater

Add Feature property to `@experimental` annotation

Catalog Import API

Introduction of Unique Identifiers for Checkout Methods

Make more use of Bootstrap tooling and remove !important from Bootstrap CSS utils

Make feature flags toggleable on demand

New acceptance test suite

Introduce transactional flow actions

Disable Vue compat mode per component level

Implementation of Meteor Component Library

Config Reference

Server

Apache

Nginx

Security

Guidelines

Code

Core

2023-05-16 - PHP 8.1 & Symfony 6.1 new features

ADR

Benchmarks

Decorator pattern

Domain exceptions

Extendability

Final and internal annotation

Internal

Unit tests

Writing code for static analysis

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

Test

Testing guidelines for extensions

Quality guidelines for apps in app system

Quality guidelines for apps in plugin system

Best practices on writing end-to-end tests

Document

Fonts & Formats

Text

Code

General

Methodize Assets

Conceptual Structure

Doc Process

Language & Grammar

Tooling

CLI

Hot Module Reloading using watchers

IDE

Shopware Toolbox

Administration Reference

Resources
References

On this page

Table of Contents for current page

docsmainResources

Administration Reference

This section covers concepts on Utils, Mixins and Directives.

Ask a question on StackOverflow

Edit this page on GitHub

Previous pageFlow Action Reference

info@shopware.com
00 800 746 7626 0

Product

APIs
SDKs
B2B Suite
Extensions
Headless Storefront

Resources

User Documentation
Design Documentation
E-commerce knowledge
Jump into development
Training & Certification

Community

Forum
Community Day
Stack Overflow
Feedback & Issues

GitHub Channels

Shopware 5
Shopware 6
Development Template
Contribute to the docs
Contribute to platform

News & Updates

Blog
Shopware TV
Announcements
Product Changelog

Newsletter

Copyright © shopware AG - All rights reserved

Terms & Conditions
Privacy policy
Legal notice
Cookie settings