New Semantics

English

Deutsch

English

Deutsch

Theme

Schema overview ​

The spec contains 230+ components/schemas. The Scalar reference under API Reference renders all of them — this page provides a thematic navigation aid.

Manually maintained

This overview is not generated automatically from the spec. On schema changes (added / renamed / removed), this page has to be updated along with them.

Auth + User ​

User, UserProfile, ProfileUpdateRequest, ProfileEmailUpdateRequest, ProfilePasswordUpdateRequest, ProfilePrivacyUpdateRequest, ProfileDeleteImageRequest, ProfileImageUploadResponse, UserOverview, UserFavoriteFile, UserFavoriteCalendar, UserFavoriteMedia, UserShortcut, Address.

Backend auth: BackendAuthLoginRequest, BackendAuthLogoutRequest, BackendAuthStatusRequest, BackendAuth2faSetupRequest, BackendAuth2faVerifySetupRequest, BackendAuth2faVerifyRequest, BackendAuth2faRecoveryRequest, BackendAuth2faPending, BackendAuth2faSetupRequired, BackendAuth2faSetupResponse, BackendAuth2faVerifySetupResponse, BackendAuthFull, BackendAuthLoggedOut.

Pagebuilder ​

Frontend shape: Page, PageRow, PageColumn, PageWidget, PageMeta, Visibility, ColumnWidth, AbTestMeta, PageRedirect.

Backend atoms (Pagebuilder editor): PagebuilderRow, PagebuilderColumn, PagebuilderWidget, PagebuilderWidgetItem, Spacing, FlexSettings, AnimationData.

Versions: PageVersion, PageVersionList, DraftStatus, ClipboardPayload.

AI layout job: AiLayoutStartResponse, AiLayoutStatus.

Shop (native) ​

ShopProduct, ShopProductDetail, ShopCategory, ShopPromotedCategory, ShopTrailer, ShopEpisode, ShopProductFile, ShopProductCalendar, CartItem, CartResponse, CartAddRequest, CartUpdateRequest, CartDeleteRequest, Order, OrderArticle, Subscription, SubscriptionProduct, SubscriptionInvoice, CourseProgress.

Checkout: CheckoutSummary, CheckoutAddress, PayPalCreateResponse, PayPalCaptureRequest, StripeConfirmRequest, OrderCreatedResponse, AboBookingRequest, AboBookingResponse.

Shopware 6 (headless) ​

Sw6Product, Sw6ProductListingRequest, Sw6ProductListingResponse, Sw6Cart, Sw6CartLineItem, Sw6CartResponse, Sw6ShopConfig, Sw6ShippingMethod, Sw6PaymentMethod, Sw6OrderCreatedResponse, Sw6PaypalOrderResponse, Sw6Customer, Sw6Address, Sw6LoginResponse, Sw6Category, Sw6CategoryTreeResponse, Sw6SearchResponse, Sw6BackendConfig, Sw6TestConnectionResponse.

E-Learning ​

Public: ElearningCategory, ElearningCourse, ElearningEpisode, ElearningCatalogResponse, ElearningDetailResponse, ElearningStreamResponse, ElearningAccessStatus, ElearningExamStatus, ElearningCertificateStatus, ElearningTrackingEvent, ElearningTrackingRequest, ElearningTrackingResponse, ElearningExamQuestion, ElearningExamAnswer, ElearningExamStartResponse, ElearningExamSubmitRequest, ElearningExamResult, ElearningCertificate, ElearningCertificateList, ElearningCertificateVerifyResponse, ElearningCertificateIssueRequest.

Public: MenuEditorMenuPublic, MenuEditorItemPublic, MenuEditorVisibility, MegaWidget.

Backend: MenuEditorMenu, MenuEditorItemBackend, MenuEditorTree.

Legacy (/api/menu, /api/backend/menu/save): MenuItem, BackendLegacyMenuItem.

Frontend core ​

Settings, SettingsAnalytics, Language.

Media ​

MediaTreeNode, MediaItem, MediaContentResponse, MediaUploadResponse.

Plugin management ​

AI: AiConnection, AiConnectionList, AiFeatureConfig, AiFeature, AiFeatureList, AiUsageEntry, AiUsageSummary, AiCreateConnectionRequest, AiUpdateConnectionRequest, AiTestConnectionRequest, AiTestConnectionResponse, AiSaveFeatureRequest, AiGenerateRequest, AiGenerateResponse.

Update Manager / deployment: MigrationEntry, UpdateManagerStatus, UpdateChangelogEntry, UpdateCheckResponse, DeploymentTarget, DeploymentTargetList, TargetTestResult, DeployStartResponse, DeployStatusResponse.

A/B testing: AbTest, AbTestVariant, AbTestList, AbTestDetail, AbTestStatsVariant, AbTestStats, AbTestActiveResponse, AbTestTrackRequest.

Task Manager + webhook queue: TaskQueueJob, ScheduledTask, TaskManagerStatus, WebhookQueueEntry, WebhookDelivery.

API keys + webhook subscriptions: ApiKey, ApiKeyCreateResponse, ApiKeyList, ApiKeyRightsTemplate, AllowedOrigin, AllowedOriginList, WebhookSubscription, WebhookSubscriptionList, WebhookEvent, WebhookEventList, WebhookCreateResponse, WebhookTestResponse, WebhookRotateSecretResponse.

Email marketing: EmailConnection, EmailConnectionList, EmailList, EmailListsResponse, EmailSubscriber, EmailSubscribersResponse, EmailFormField, EmailFormConfig, EmailForm, EmailFormList, EmailBlacklistEntry, EmailBlacklistResponse, EmailTestConnectionResponse.

Elasticsearch: ElasticHealth, ElasticIndex, ElasticIndicesResponse, ElasticSettings, ElasticTestConnectionResponse, ElasticReindexResponse, ElasticSearchResult, ElasticSearchResponse.

Design + CSV export: DesignLoadLessResponse, DesignSaveLessResponse, DesignResetLessResponse.

Backend actions ​

BackendNavigationItem, BackendNavigationResponse, ChecklistChildNode, ChecklistGroup, ChecklistResponse, ModuleListResponse, CustomContentResponse.

Form + webhooks ​

Form: FormSubmitRequest, FormSubmitCourseBlock, FormSubmitCourseBlockRow.

Shop users: ShopUserSummary, ShopUsersResponse.

Provider webhook events: StripeWebhookEvent, PayPalWebhookEvent.

Wrapper ​

ErrorResponse, SuccessResponse.