// Sitecore Marketplace SDK API reference. Use when the user asks about SDK methods, types, queries, mutations, subscriptions, or how to use any Sitecore Marketplace SDK API.
| name | marketplace-sdk-reference |
| description | Sitecore Marketplace SDK API reference. Use when the user asks about SDK methods, types, queries, mutations, subscriptions, or how to use any Sitecore Marketplace SDK API. |
You are the reference guide for the Sitecore Marketplace SDK (v0.4). Answer questions about API methods, types, queries, mutations, and subscriptions.
The SDK has 3 packages:
@sitecore-marketplace-sdk/client (required)The core client. Provides ClientSDK, queries, mutations, subscriptions, and type definitions.
@sitecore-marketplace-sdk/xmcXM Cloud APIs for Sites, Pages, Authoring, Content Transfer, Search, and Agent.
@sitecore-marketplace-sdk/aiAI Skills APIs for Brand Review.
import { ClientSDK } from "@sitecore-marketplace-sdk/client";
const client = await ClientSDK.init({
target: window.parent,
});
// Query — returns { data, unsubscribe? }
const { data } = await client.query("queryName", params);
// Mutation
const { data } = await client.mutate("mutationName", params);
// Subscription — use query() with subscribe: true
const { unsubscribe } = await client.query("queryName", {
subscribe: true,
onSuccess: (data) => console.log(data),
});
unsubscribe?.();
Adds AI Skills integration (Brand Review API) to a Sitecore Marketplace app. Use when the user wants to add AI-powered content analysis, brand review, or brand compliance checking.
Adds a new extension point route to a Sitecore Marketplace app. Use when the user wants to add a custom field, dashboard widget, context panel, fullscreen page, or standalone route.
Adds XM Cloud API integration to a Sitecore Marketplace app. Use when the user wants to access Sites, Pages, Authoring, Content Transfer, Search, or Agent APIs from XM Cloud.
Builds UI components using the Blok design system for Sitecore Marketplace apps. Use when the user wants to create UI, add components, build a page layout, or work with Blok/shadcn components in a marketplace app.
Scaffolds a new Sitecore Marketplace app using the official SDK. Use when the user wants to create a new marketplace app, start a new Sitecore project, or initialize a marketplace integration.
Deploys a Sitecore Marketplace app to Vercel with correct CSP headers and configuration.
