API Reference
The Meteor Admin SDK provides APIs for extending the Shopware Administration UI and interacting with Administration data.
These APIs allow extensions to add user interface elements, access and modify entity data, register CMS blocks and elements, and share state between components.
Use the sections below to navigate the available APIs.
Extending the UI
These components allow extensions to add UI elements to the Shopware Administration. They can be used to register modules, add navigation entries, extend existing pages, and display dialogs or side panels.
Typical use cases include:
- Creating custom modules in the Administration
- Extending entity detail pages
- Adding navigation or settings entries
- Displaying modals or contextual UI elements
UI extension components in this section include:
- Main Module
- Menu
- Settings Item
- Action Button
- Notification
- Toast
- Tabs
- Component Sections
- Sidebars
- Modals
- Media Modal
Purchases and payments
- In-App Purchases: Start an in-app purchase flow
- Payment Overview Card: Customize payment method cards
Working with Data
These tools allow extensions to access and manipulate Shopware entity data from within the Administration.
They follow the same repository-based data access pattern used internally by the Administration.
Typical workflows include:
- Accessing entity repositories
- Retrieving entity data
- Subscribing to changes
- Updating or persisting entities
Tools this section include:
- Repository: Access Shopware entity repositories
- Get
- Subscribe
- Update
Composable APIs
Composable APIs provide reusable helpers for working with the Administration state and data layer inside extensions.
They simplify common patterns such as accessing repositories or sharing state between components.
APIs in this section include:
Extending the CMS
These APIs allow extensions to add new CMS blocks and elements to the Shopware Shopping Experiences editor.
They can be used to introduce custom content components that merchants can use when building storefront pages.
APIs in this section include:
Shared Options
Some SDK APIs support shared configuration options that control how actions are executed in the Administration.
