@misiki/shuup-connector

The Official TypeScript API Connector for connecting svelte-commerce to Shuup E-Commerce Backend.

@misiki/shuup-connector provides a production-ready, fully-typed API client and integration layer that seamlessly bridges svelte-commerce storefronts with Shuup headless e-commerce backends — part of the Litekart connector suite, mirroring the full 43-service surface of @misiki/litekart-connector.

Coverage: 19 of 43 services are wired to the live Shuup API. The remaining 24 have no Shuup equivalent and return empty placeholder data. Each placeholder says why in a comment at the top of its service file.

🚀 Step-by-Step Integration Guide

Follow these steps to connect svelte-commerce with shuup-connector and your Shuup backend.

1. Install the Connector

Inside your svelte-commerce project directory, run:

bun i @misiki/shuup-connector

(Or using npm / pnpm / yarn):

npm install @misiki/shuup-connector
# or
pnpm add @misiki/shuup-connector

2. Configure kitcommerce.config.ts

In svelte-commerce, open kitcommerce.config.ts and change the export * line to import from @misiki/shuup-connector:

// kitcommerce.config.ts
export * from '@misiki/shuup-connector';

3. Configure Credentials

Pass apiUrl (store URL), accessToken (DRF token). API docs: https://shuup.readthedocs.io/en/latest/api/index.html

import { ShuupConnector } from '@misiki/shuup-connector'

// Credentials are set once, statically — the constructor only takes an optional fetch.
ShuupConnector.setCredentials({
  apiUrl: 'https://store.example.com',
  accessToken: 'token'
})

const client = new ShuupConnector()

const products = await client.product.list({ page: 1, sort: '-createdAt' })

4. Build and Run the Project

Run the development server in svelte-commerce:

bun dev

To build and run the production application:

# Build the project
bun run build

# Preview the built application
bun run preview

Service coverage

| Service | Status | | --- | --- | | client.product | ✅ live | | client.category | ✅ live | | client.collection | ⚠️ placeholder (no Shuup equivalent) | | client.order | ✅ live | | client.coupon | ⚠️ placeholder (no Shuup equivalent) | | client.address | ✅ live | | client.review | ⚠️ placeholder (no Shuup equivalent) | | client.cart | ✅ live | | client.country | ⚠️ placeholder (no Shuup equivalent) | | client.state | ⚠️ placeholder (no Shuup equivalent) | | client.currency | ✅ live | | client.region | ✅ live | | client.page | ⚠️ placeholder (no Shuup equivalent) | | client.blog | ⚠️ placeholder (no Shuup equivalent) | | client.settings | ✅ live | | client.store | ✅ live | | client.paymentMethod | ✅ live | | client.search | ✅ live | | client.autocomplete | ⚠️ placeholder (no Shuup equivalent) | | client.user | ✅ live | | client.auth | ✅ live | | client.profile | ✅ live | | client.wishlist | ⚠️ placeholder (no Shuup equivalent) | | client.vendor | ✅ live | | client.checkout | ✅ live | | client.upload | ⚠️ placeholder (no Shuup equivalent) | | client.banner | ⚠️ placeholder (no Shuup equivalent) | | client.chat | ⚠️ placeholder (no Shuup equivalent) | | client.contact | ⚠️ placeholder (no Shuup equivalent) | | client.deal | ⚠️ placeholder (no Shuup equivalent) | | client.demoRequest | ⚠️ placeholder (no Shuup equivalent) | | client.enquiry | ⚠️ placeholder (no Shuup equivalent) | | client.faq | ⚠️ placeholder (no Shuup equivalent) | | client.feedback | ⚠️ placeholder (no Shuup equivalent) | | client.gallery | ⚠️ placeholder (no Shuup equivalent) | | client.home | ✅ live | | client.init | ✅ live | | client.meilisearch | ⚠️ placeholder (no Shuup equivalent) | | client.menu | ✅ live | | client.plugins | ⚠️ placeholder (no Shuup equivalent) | | client.popularSearch | ⚠️ placeholder (no Shuup equivalent) | | client.popularity | ⚠️ placeholder (no Shuup equivalent) | | client.reels | ⚠️ placeholder (no Shuup equivalent) |

Development

bun install && bun run typecheck && bun run build

License

MIT © misiki-in