Svelte Commerce × Shopware
Svelte Commerce on Shopware
Shopware’s Store API is one of the cleanest headless surfaces of the 26. The connector carries the cart and the customer’s session in the sw-context-token header, captured and replayed like a cookie.
- 28/43 services wired
- @misiki/shopware-connector 0.4.0
- Cart wired
- Checkout wired
- Sign-in (auth) wired
What works on Shopware today
Cart, checkout and sign-in are wired; coupons are the one recorded gap. The connector found Store API routes to apply and remove a promotion code on a cart, but none to list or validate a code on its own.
Cart
Wired: issues a real request to Shopware.
Checkout
Wired: issues a real request to Shopware.
Sign-in (auth)
Wired: issues a real request to Shopware.
Known gaps: coupon — each is explained under Limitations below.
28 of 43 services wired, read from CONNECTORS.md on , where the package version is recorded too; npm may carry a newer patch. Coverage is traced by a script in the Svelte Commerce repository: a service counts as wired only if it transitively issues an HTTP request, or delegates to one that does. It is not hand-asserted. Some services are Litekart-native concepts with no equivalent elsewhere (reels, deals, chat, gallery, popularity, demo-request, feedback, plugins, banner). They stay documented placeholders on every connector and are excluded from known gaps.
Quick start
From nothing to a Svelte Commerce storefront reading Shopware. You need Node.js and a Shopware to point it at; the storefront holds no data of its own.
Clone it, choose the connector, point it at Shopware
# 1 — get the storefront
git clone https://github.com/itswadesh/svelte-commerce
cd svelte-commerce
# 2 — one connector at a time: remove the two the storefront ships with, add this one
npm uninstall @misiki/litekart-connector @misiki/vendure-connector
npm i @misiki/shopware-connector
# 3 — point it at your Shopware shop
echo PUBLIC_SHOPWARE_API_URL=https://your-store.example.com >> .env
# 4 — run it
npm run dev The guide removes only @misiki/litekart-connector. A fresh clone’s package.json also lists @misiki/vendure-connector, and with two connectors installed and neither of them Litekart’s, the build stops and asks for PUBLIC_CONNECTOR — so this removes both.
Environment variables
| Variable | Required | What it does |
|---|---|---|
PUBLIC_SHOPWARE_API_URL | Yes | Your Shopware shop’s URL; the connector calls its Store API. Boot fails, naming this variable, if it is missing. |
PUBLIC_SHOPWARE_ACCESS_KEY | No | The sales channel’s access key, sent as sw-access-key. It chooses the sales channel and is meant for storefront use. If it is unset, PUBLIC_SHOPWARE_API_KEY or PUBLIC_SHOPWARE_ACCESS_TOKEN is read in its place. |
PUBLIC_CONNECTOR | No | Only when more than one connector is installed: @misiki/shopware-connector names the one this build runs on. |
init.ts hands the connector every PUBLIC_SHOPWARE_* variable that is set, camel-cased. The guide also lists PUBLIC_SHOPWARE_API_SECRET, PUBLIC_SHOPWARE_STORE_ID and PUBLIC_SHOPWARE_CHANNEL_ID; the connector’s source does not read them — the sales channel is chosen by the access key alone.
Every variable here begins PUBLIC_, and SvelteKit sends PUBLIC_ variables to the browser: treat each value you set as published.
What to set up on Shopware
- Use a sales channel’s access key: the Store API chooses the sales channel by the
sw-access-keyheader, and there is no route that picks a store by ID. - Let the storefront’s origin make cross-origin requests to Shopware (CORS): in production the browser calls
PUBLIC_SHOPWARE_API_URLdirectly, not only the server.
How the integration works
The connector speaks Shopware’s Store API, the shopper-facing half of Shopware’s API. Every request carries the sales channel’s sw-access-key; the cart and the signed-in customer live in the sw-context-token header, which the connector captures from responses and replays like a cookie.
Installing the package is the whole switch. vite.config.ts resolves whichever @misiki/*-connector is installed, and src/lib/core/connectors/init.ts hands it every PUBLIC_SHOPWARE_* variable that is set, camel-cased, at boot — in the server hook for server rendering and in the client hook for the browser, which must reach the same URL in production.
There is no Litekart API behind the storefront here, so store identity — name, logo, currency, menus, plugin toggles, theme colours — comes from src/lib/core/connectors/default-store.json merged under the default export of kitcommerce.config.ts. Until you override it, the store is called “Test”. Any Litekart REST path the connector still inherits is answered from that local data, or resolved empty, rather than requested.
Limitations
- Coupons: not wired — the connector found Store API routes to apply and remove a promotion code on a cart, but none to list or validate a code on its own.
- Pages that depend on a service that is not wired render their empty state rather than failing.
- Homepage sections other than the live product list come from the active theme’s static content — the standing rule for themes.
- The Conversational Shopping assistant is Litekart-only; its widget stays hidden when another connector is active.
Troubleshooting
| When you see | What to do |
|---|---|
| Boot fails with “the shopware connector is active but PUBLIC_SHOPWARE_API_URL is not set” | Add PUBLIC_SHOPWARE_API_URL to .env. A production Node build and Docker read PUBLIC_* from the process environment rather than .env, so set it on your deploy platform too. |
| The build stops with “Several commerce connectors are installed … Set PUBLIC_CONNECTOR to pick one” | More than one @misiki/*-connector is in package.json and none is Litekart’s. Uninstall the ones you do not run — a fresh clone also lists @misiki/vendure-connector — or set PUBLIC_CONNECTOR='@misiki/shopware-connector'. |
| Boot fails with “PUBLIC_…_API_URL is set, but it configures a different backend than the one this build runs on” | Another backend’s variable is still set, usually left over from the one you switched from. Remove it, or install that backend’s connector. PUBLIC_LITEKART_API_URL is exempt: it only points the dev proxy. |
| The store is called “Test”, or shows the wrong name and logo | Store identity is static on this backend. Set name, logo, currencyCode and the rest in the default export of kitcommerce.config.ts; src/lib/core/connectors/default-store.json lists every field. |
[shopware] no native implementation for get /api/... in the console | The connector’s REST guard caught a path inherited from Litekart and answered it empty instead of requesting it. Each path is reported once. Harmless if Shopware has no such feature; if it has one, the fix belongs in the connector’s matching service. |
http proxy error: api/... ECONNREFUSED in dev | A Litekart REST path was requested from outside the connector, so its guard never saw it. Vite proxies /api to PUBLIC_LITEKART_API_URL, or to localhost:7000. |
The build fails on @misiki/litekart-connector | @misiki/kitcommerce-core declares it as a peer, and vite.config.ts redirects that specifier to whichever connector is installed. Make sure exactly one @misiki/*-connector is listed in package.json. |
Before you rely on it
The one caveat that matters
Read this before choosing
Every connector was written by reading its platform’s authoritative source — an OpenAPI spec, a RAML file, a router registration or the controller source — rather than by running against a store. No connector has been exercised against a live production instance of its platform.
An open question for Shopware’s maintainers: Is there a Store API route for promotion or voucher lookup — not just applying one to a cart? The connector found apply and remove, but no way to list or validate a code on its own.
Offer a sandbox or a correctionFAQ
Questions about Svelte Commerce on Shopware
Can I run a Shopware store on Svelte Commerce today?
Cart, checkout and sign-in are wired against Shopware’s Store API, and coupons are the only recorded gap. Like every connector, it has not been run against a live production Shopware store.
How do I switch Svelte Commerce to Shopware?
Remove the connectors the storefront ships with, install @misiki/shopware-connector, set PUBLIC_SHOPWARE_API_URL in .env and start the dev server. vite.config.ts resolves whichever connector is installed, so no file in the storefront changes.
How does the cart keep its session on Shopware?
Through the sw-context-token header. Shopware returns it with the cart and the customer session; the connector captures it and sends it back on later requests, the way a browser replays a cookie.
Has the Shopware connector been run against a real Shopware store?
Not against a live production instance — no Svelte Commerce connector has been. It was written by reading Shopware’s authoritative API source, and the Svelte Commerce maintainers ask Shopware’s own maintainers for a sandbox to run it against.
Sources
This page summarises SHOPWARE.md in the Svelte Commerce repository and the Shopware connector’s source, read on , and the coverage in CONNECTORS.md, read on . Where they disagree with this page, they are right and this page is out of date. Shopware is a trademark of its owner, named here only to describe compatibility; no endorsement or affiliation is implied — see trademarks.
Read the whole guide
The storefront is the same on every backend; the connector is what changes. SHOPWARE.md has the Shopware setup in full, beside the connector’s source.