Svelte Commerce × Shuup

Svelte Commerce on Shuup

Solid core coverage for a smaller API: cart, checkout and sign-in are wired against Shuup’s REST API. Coupons, reviews, CMS pages, countries, states and wishlist are the recorded gaps.

What works on Shuup today

Cart, checkout and sign-in are wired; coupons, reviews, CMS pages, countries, states and wishlist are not.

Cart

Wired: issues a real request to Shuup.

Checkout

Wired: issues a real request to Shuup.

Sign-in (auth)

Wired: issues a real request to Shuup.

Known gaps: coupon, review, page, country, state, wishlist — each is explained under Limitations below.

19 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 Shuup. You need Node.js and a Shuup to point it at; the storefront holds no data of its own.

Clone it, choose the connector, point it at Shuup

# 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/shuup-connector

# 3 — point it at your Shuup shop
echo PUBLIC_SHUUP_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

What Svelte Commerce reads to reach Shuup
VariableRequiredWhat it does
PUBLIC_SHUUP_API_URLYesYour Shuup shop’s URL. Boot fails, naming this variable, if it is missing.
PUBLIC_SHUUP_ACCESS_TOKENNoA JWT, sent as Authorization: JWT <token> — Shuup accepts neither Token nor Bearer.
PUBLIC_SHUUP_API_KEYNoHTTP Basic username, used when no token is set; meant for server-to-server calls. See the limitations.
PUBLIC_SHUUP_API_SECRETNoHTTP Basic password, with the username above.
PUBLIC_CONNECTORNoOnly when more than one connector is installed: @misiki/shuup-connector names the one this build runs on.

init.ts hands the connector every PUBLIC_SHUUP_* variable that is set, camel-cased. The guide also lists PUBLIC_SHUUP_ACCESS_KEY, PUBLIC_SHUUP_STORE_ID and PUBLIC_SHUUP_CHANNEL_ID; the connector’s source does not read them.

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 Shuup

How the integration works

Shuup’s REST API accepts HTTP Basic, session and JWT authentication. The connector sends a JWT as Authorization: JWT <token> — the header prefix Shuup’s JWT library expects — and falls back to HTTP Basic when it has a username and password instead.

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_SHUUP_* 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

Troubleshooting

Errors you may meet running Svelte Commerce on Shuup, and what fixes them
When you seeWhat to do
Boot fails with “the shuup connector is active but PUBLIC_SHUUP_API_URL is not set”Add PUBLIC_SHUUP_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/shuup-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 logoStore 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.
[shuup] no native implementation for get /api/... in the consoleThe 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 Shuup has no such feature; if it has one, the fix belongs in the connector’s matching service.
http proxy error: api/... ECONNREFUSED in devA 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.

Offer a sandbox or a correction

FAQ

Questions about Svelte Commerce on Shuup

Can I run a Shuup shop on Svelte Commerce today?

Cart, checkout and sign-in are wired; coupons, reviews, CMS pages, countries, states and wishlist are not. Like every connector, it has not been run against a live production Shuup shop.

How do I switch Svelte Commerce to Shuup?

Remove the connectors the storefront ships with, install @misiki/shuup-connector, set PUBLIC_SHUUP_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 connector authenticate with Shuup?

With a JWT, sent as Authorization: JWT <token>. Shuup does not install token authentication, so Token and Bearer headers are both refused. HTTP Basic is the fallback, meant for server-to-server calls.

Has the Shuup connector been run against a real Shuup store?

Not against a live production instance — no Svelte Commerce connector has been. It was written by reading Shuup’s authoritative API source, and the Svelte Commerce maintainers ask Shuup’s own maintainers for a sandbox to run it against.

Sources

This page summarises SHUUP.md in the Svelte Commerce repository and the Shuup 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. Shuup 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. SHUUP.md has the Shuup setup in full, beside the connector’s source.

Chat on WhatsApp