Home

Selldone Community SDK

The Community SDK (@selldone/sdk-community) is the JavaScript client for communities on Selldone®. Every Selldone shop can run a white-label community where customers discuss products in categories and topics, write posts, comment, react, vote in polls and follow each other. This wiki shows how to read and build on that community from your own front end or admin tools.

Start here

1. Getting Started: install the package, configure the community API and make your first calls.
2. JavaScript SDK: the window.$community reference.
3. Community API URL Builders: everything else the community API can do.

Page map

Page	What you'll learn
Getting Started	Prerequisites, setup, authentication and a first working example
JavaScript SDK	getInfo, post.searchPosts, getCommunityID and routes
Community API URL Builders	The full window.CAPI catalog with request examples
Links and Routes	Share links with CommunityURLs and Vue Router route names
FAQ	Common questions and troubleshooting

How a Selldone community is organized

Level	What it is	Example route
Community	One per shop (the main Selldone community has ID 1)	GET /communities/{community_id}
Category	A section of the community	GET /communities/{community_id}/categories/{category_id}
Topic	A discussion thread inside a category	GET /communities/{community_id}/topics/{topic_id}
Post	A message in a topic	GET /communities/{community_id}/topics/{topic_id}/posts
Comment	A reply to a post	GET /communities/{community_id}/topics/{topic_id}/posts/{post_id}/comments

At a glance

import { CapiCommunity } from "@selldone/sdk-community";

CapiCommunity.Setup(); // window.CAPI + window.$community

const communityId = window.$community.getCommunityID(shop);
const { community, categories } = await window.$community.getInfo(communityId);
const { posts, more } = await window.$community.post.searchPosts(communityId, 0, 20, "shipping");

Where it fits

The Community SDK works next to the Storefront SDK, which provides the customer session. The ready-made community UI lives in Components, and the Storefront serves it under /community.

Related projects

• Storefront: complete storefront with community pages
• Storefront SDK: customer session and shop data
• Components: Vue 3 community UI
• Core: community models and helpers
• Backoffice SDK: shop administration API
• All Selldone repositories