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.3

Concepts

API

Store API

Commerce

Catalog

Categories

Products

Sales Channels

Checkout

Cart

Orders

Payments

Content

Shopping Experiences (CMS)

Extensions

Apps

Plugins

Framework

Architecture

Storefront

Administration

Data Abstraction Layer

Messaging

Migrations

Rules

HTTP Cache

Guides

Hosting

Infrastructure

Filesystem

Message Queue

Elasticsearch

Installation & Updates

Deployments

Deployment with Deployer

Versioning & Dependencies

Performance

HTTP Cache

Installation

Installation overview

Dockware

Docker

Installation from scratch

Valet+

Vagrant

MAMP

Integrations / API

Admin API Guide

Writing entities

Associations

Bulk Payloads

Product Data

Action Routes

Authentication

Reading entities

General Concepts

Search Criteria

Request Headers

Generated Reference

Store API Guide

Registering a customer

Searching for products

Working with the cart

Handling the payment

FAQ

Extensions

Apps

Administration

Add custom action button

Add custom module

Local development

App development with docker

App development with platform.sh

App Base Guide

Custom Data

Storefront

Configuration

Platform.sh template

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

Plugins

Administration

Add custom module

Add custom component

Add custom route

Add menu entry

Writing templates

Adding snippets

Adding Mixins

Using Mixins

Adding Services

Adding permissions

Using the data handling

Customize modules

Override existing routes

Add tab to existing module

Customizing components

Using assets

Using Directives

Add tab to existing module

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

Adding Shortcuts

Extending services

Handling media

Injecting services

Modify dynamic product groups blacklist

The Sanitizer helper

Using Vuex Stores

Checkout

Cart

Add cart items

Add cart discounts

Add cart validator

Change price of items in cart

Add cart validator

Add cart collector / processor

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

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

Using database events

Versioning entities

Event

Add custom event

Message Queue

Add message to queue

Add message handler

Add middleware

Rule

Add custom rules

Store API

Add store API route

Override existing route

Storefront

Customize templates

Add custom controller

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

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

Editions

Enterprise Edition

Search

Installation

Field Configuration

Extensibility

Boosting

Completion

Relevance

Synonyms

B2B Suite

Community Edition

Professional Edition

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

Concept

Guides

Cloud

PWA

Pwa 1

Quick Setup

Resources

Guidelines

Code

Contribution Guidelines

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

Testing

Best practises on writing end-to-end tests

References

Administration Reference

Utils

API Reference

Store API Reference

Product

Category

Admin API Reference

App Reference

Manifest Reference

Config Reference

Server

Apache

Nginx

Core Reference

Administration Reference

Utils

Mixins

Directives reference

DAL Reference

Fields Reference

Flags Reference

Filters Reference

Aggregations Reference

Commands Reference

Rules Reference

Storefront Reference

Shopware's twig functions

Testing Reference

Custom E2E Commands

PSH E2E Commands

App Reference

Resources
References

On this page

Table of Contents for current page

docsv6.3.0Resources

App Reference

Manifest Reference

Ask a question on StackOverflow

Edit this page on GitHub

Previous pageAdmin API Reference

Next pageManifest 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