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

V6.4

Concepts

API

Store API

Admin API

Commerce

Catalog

Products

Categories

Sales Channels

Checkout

Cart

Orders

Payments

Content

Shopping Experiences \(CMS\)

Core

Shopping Experiences (CMS)

Extensions

Apps

Plugins

Framework

Architecture

Storefront

Administration

Data Abstraction Layer

Messaging

Migrations

Rules

HTTP Cache

Elasticsearch

Flow

Guides

Hosting

Infrastructure

Elasticsearch

Set up Elasticsearch

Debugging Elasticsearch

Filesystem

Rate Limiter

Database Cluster

Message Queue

Reverse HTTP Cache

Installation & Updates

Deployments

Deployment with Deployer

Building without Database

Cluster Setup

Versioning & Dependencies

Performance

Cache

Session

Increment Storage

Lock Storage

Number Ranges

Performance Tweaks

Installation

Legacy Setups

Docker

Installation from scratch

Valet+

MAMP

Community Setups

Dockware

Requirements

Template

Devenv

Integrations / API

General Concepts

Search Criteria

Request Headers

Generated Reference

API Versioning

Extensions

Apps

Administration

Add custom action button

Add custom module

Custom Data

Custom fields

Custom entities

Flow Builder

Add custom flow action from app system

Hosting Guide

Platform.sh Deployment

Local development

App development with docker

App development with platform.sh

Rule Builder

Add custom rule conditions

App Starter Guides

Starter Guide - Reading and writing data

Starter Guide - Add an API endpoint

Starter Guide - Admin Extensions

Storefront

Apps as themes

Add cookies to the consent manager

App Scripts

Cart manipulation

Data loading

Custom endpoints

Content

CMS

Add custom CMS blocks

App Base Guide

Configuration

Payment

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

Plugins

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

API

Customer Specific Pricing

Multi Inventory

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 CMS element via AdminExtensionSDK

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

Custom Fields

Add custom field

Fetching data from "entity selection" custom field

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

Event

Add custom event

Finding events

Filesystem

Filesystem - Flysystem

Flow

Add Flow Builder action

Add Flow Builder trigger

Message Queue

Add message to queue

Add message handler

Add middleware

Rate Limiter

Add Rate Limiter to API Route

Rule

Add custom rules

Store API

Add store API route

Add caching for Store API route

Override existing route

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

Working with viewports in js

Testing

End-to-end testing

Jest unit tests in Shopware's administration

Jest unit tests in Shopware's storefront

PHP unit testing

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

Plugin Base Guide

Plugins for Symfony developers

Overview

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

Advanced Search

Installation

Field Configuration

Extensibility

Boosting

Completion

Relevance

Synonyms

B2B Suite

Concepts

System architecture

Basic conventions

Method structure

Line Item List

Guides

Administration

Installation

Storefront

Ajax Panel

Product Search

Complex views

Modal component

Company

Acl Routing

Extending the storefront

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

Example Plugins

B2B Suite

PaaS

CLI Setup

Repository

Build & Deploy

Setup Template

Theme Build

Elasticsearch

RabbitMQ

Fastly

Guided Shopping

Guided Shopping installation

Self-hosted Mercure installation

Developers' checklist

Sample Mercure Configuration on StackHero

PWA

SaaS

Community Edition

Plugins

Commercial

Resources

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

Document

Fonts & Formats

Text

Code

General

Methodize Assets

Conceptual Structure

Doc Process

Language & Grammar

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

References

Administration Reference

Utils

General

Admin

Flow builder

Adding the StorableFlow to implement DelayAction in Flow Builder

Unified notification titles

Import acl privileges from other roles

The best practice to always re fetch the data after saving

Introduce eslint on vue admin

Introduce jest fail on console

Refactor admin build process to webpack multi compiler mode

Merge e2e projects into a single project

Add possibility for plugin to add a html file

Admin extension API standards

Extract data handling classes to extension sdk

Providing the admin extension sdk

Hide and show cms content

Test structure

Replace drop shadow with box shadow

Run lighthouse test ine2e env

Vue 2.7 update

Npm packages pre release versions

API

Implement sales channel context token requirement

Add login required annotation

Removing API version

Controller configuration route defaults

App

Implement app system inside platform

Technical concept custom entities

App scripting

Custom app API endpoints

Rule scripting in apps

Integrate app into flow action

Cache

Reset class state during requests

Cache stampede protection

Checkout

Document template refactoring

Merchant registration

Nested line items

Make core mail templates independent from storefront urls

Payment flow

Refund handling

New nested line items

Tax providers

Content-management

Blog concept

DAL

Control clone behavior

DAL join filter

When to use plain sql or DAL

Specify priority of translations in DAL write payloads

Deprecate autoload true in DAL associations

Deployment

Make platform stand alone

Composer based web updater

Extension

Custom field label loading in storefront

Creating events

Decoration pattern

Inventory

Implement individual sorting

Available stock

Performance

Increment pattern

Base context factory

Initial state id loader

Prevent mail updates

Profiler integrations

Redis cart persister

Rule

Preparing data for rule evaluation

Rule condition field abstraction

Storefront

Move storefront scripts to head

Storefront coding standards

Refactor theme inheritance

Add feature flag support for storefront scss

Add typescript support for storefront js

Add bootstrap util

Deprecate csrf

Atomic theme compilation

Image lazy loading

Testing

Deprecation handling during phpunit test execution

Mocking repositories

Workflow

Implement architecture decision records

Implement New Changelog

Feature flag system

Handling feature flags

Deprecation strategy

Adjust ADR approval rules

Feature flags for major versions

Consistent deprecation notices in core

Remove static analysis with psalm

Mapping of product area

Assets

Domain exceptions

Add default cms layouts to products and categories

YYYY MM DD template

API 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

Manifest Reference

Webhook Events Reference

Payment Reference

CMS Reference

Entities Reference

Flow Action Reference

Core Reference

Administration Reference

Utils

Mixins

Directives reference

DAL Reference

Fields Reference

Flags Reference

Filters Reference

Aggregations Reference

Commands Reference

Flow Reference

Rules Reference

Storefront Reference

Shopware's twig functions

Testing Reference

Custom E2E Commands

PSH E2E Commands

Config Reference

Server

Apache

Nginx

Tooling

CLI

Hot Module Reloading using watchers

IDE

Shopware Toolbox

Config Reference

Resources
References

On this page

Table of Contents for current page

docsv6.4Resources

Config Reference

Ask a question on StackOverflow

Edit this page on GitHub

Previous pagePSH E2E Commands

Next pageServer

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