References
This section contains structured technical reference documentation for Shopware. Use it when you need precise specifications, XML schemas, CLI commands, event payloads, or implementation details. Step-by-step guides are in other sections.
Core and platform references
Behavior, parameters, and configuration:
- Security: Platform security features, configuration options, and hardening
- Commands Reference: Complete CLI command overview (
bin/console) - System & configuration details
App development reference
Authoritative reference documentation for building Shopware Apps and implementing or validating features:
- Manifest Reference:
manifest.xmlstructure and supported sections - CMS Reference:
cms.xmlblocks and slots definition - Entities Reference:
entities.xmlschema and relations - Flow Action Reference:
flow-action.xmldefinition - Payment Reference: App-based payment API contracts
- Webhook Events Reference: Available webhook events, payloads, and permissions
Script reference
Detailed reference for Twig-based App Scripts:
- Available services
- Cart manipulation
- Data loading
- Custom endpoints
- Hooks and extension points
Architecture Decision Records (ADRs)
The ADR folder documents architectural decisions made in Shopware:
- Rationale behind technical design choices
- Trade-offs and constraints
- Historical context for core architecture
Consult ADRs when you need to understand why something works the way it does.
