Introduction
The Meteor Admin SDK is an npm library for building Shopware Administration UI extensions. It enables apps and plugins to extend the Shopware Administration through a stable, typed API that runs in the browser context.
What you can do with the SDK:
- Build custom Administration modules and context-aware UI extensions
- Extend the Administration UI with notifications, modals, tabs, and more
- Access and modify entity data through the Administration data layer
- Create entity-driven workflows and admin-driven integrations with external services
Why use the SDK
- Provides a stable, backwards-compatible API for extending the Administration and reducing complexity during Shopware updates
- Abstracts internal complexity, so deep knowledge of the Admin internals is not required
- Written in TypeScript with full type safety and auto-completion support
- Lightweight and tree-shakable, allowing granular imports and small bundle sizes
Prerequisites
Using the Meteor Admin SDK requires:
- A Shopware instance
- A working app or plugin installed in Shopware 6
- The SDK installed via npm (recommended) or CDN
Next steps
See the Getting Started guide to choose your setup and start building.
