commercetools-platform
/commercetools-platform
Opisuje podstawowe wzorce API i SDK commercetools: konfigurację SDK TypeScript, uwierzytelnianie ClientBuilder, model danych projektu, GraphQL i REST, predykaty zapytań, optymistyczną współbieżność i limity.
- Autor
- commercetools ↗
- Repozytorium
- commercetools-ai-plugins ↗
- Licencja
- CC-BY-4.0
- Ostatnia zmiana repozytorium
- 26.10.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 6
- Skrypty
- 3
- Komentarze HTML
- 2
- Adresy URL w SKILL.md
- 0
Brak sygnałów. Repozytorium zmienione 26.10.2026, bez odwołań do wycofanych modeli i API.
CC-BY-4.0, otwarta.
- 3 skrypty w paczce. Przejrzyj je przed instalacją, bo Claude może je uruchomić.
- SKILL.md zawiera komentarze HTML (2). Nie widać ich w podglądzie Markdown, a model je czyta.
Skrypty: scripts/docs-search.mjs, scripts/graphql-schemata.mjs, scripts/openApi-schemata.mjs
Co robi i kiedy
Opisuje podstawowe wzorce API i SDK commercetools: konfigurację SDK TypeScript, uwierzytelnianie ClientBuilder, model danych projektu, GraphQL i REST, predykaty zapytań, optymistyczną współbieżność i limity.
Oryginalny opis (EN)
Core commercetools API and SDK patterns — TypeScript SDK setup, ClientBuilder authentication, project data model (products, customers, orders, types, channels, stores), GraphQL vs REST patterns, query predicates, optimistic concurrency, rate limits, and platform observability. Foundational layer that storefront, MC app, Connect, and integration skills all reference. Use for any commercetools project regardless of surface.
Jak działa
- Workflow
- SDK Setup
- Product Search API
Podgląd SKILL.md
---
name: commercetools-platform
description: Core commercetools API and SDK patterns — TypeScript SDK setup, ClientBuilder authentication, project data model (products, customers, orders, types, channels, stores), GraphQL vs REST patterns, query predicates, optimistic concurrency, rate limits, and platform observability. Foundational layer that storefront, MC app, Connect, and integration skills all reference. Use for any commercetools project regardless of surface.
when_to_use:
- "Setting up a new commercetools project in TypeScript"
- "Connecting to the commercetools API from any surface (storefront, MC app, Connect, serverless function)"
- "Implementing product search with the Product Search API"
- "Implementing a spec/plan/tasks.md task annotated [SKILL: commercetools-platform]"
- "An implementation-plan step that sets up commercetools SDK clients, auth, or API access"
metadata:
contentType: SKILL
area:
- Foundations
docsSearch:
products:
- Composable Commerce
- Checkout
- Connect
- InStore
- AI Hub
---
# commercetools TypeScript SDK
Foundational patterns for connecting to the commercetools API from TypeScript. These patterns are project-type agnostic — they apply whether you are building a Next.js storefront, a serverless function, or a CLI script.
## Workflow
When this skill is invoked, always follow these steps:
1. <!-- ct:docs-search:begin -->
**Docs search (required, run first)** — The first time you use this skill in a session you must run this before answering. It gathers the latest verified documentation as your primary grounding, filtered to the products this skill covers. Use this script for documentation search while working with this skill; the Knowledge MCP covers everything else. Always confirm details against retrieved documentation rather than the skill text alone:
```bash
node "<this skill's directory>/scripts/docs-search.mjs" \
--query "<extract key terms from user's question>" \
--app-name "<host app: claude-code, claude-chat, cursor, codex, copilot — or the host's own name>" \
--model "<current-model>" \
--commercetools-project-key "<if known>" \
--commercetools-region "<if known>" \
--limit 10
```
Pass the commercetools project key and region (as in `api.{region}.commercetools.com`) only if already in your context; otherwise omit both. Never search files or ask the user for them.
<!-- ct:docs-search:end -->
2. **Combine with skill references** — Cross-reference the analysis output with local references in `./references/` for complete context.
3. **Provide implementation guidance** — Synthesize the documentation with the specific integration mode the user is targeting.
### Optional scripts
**Fetch GraphQL schema** — Run this when you need context about a commercetools GraphQL query or mutation — for example, to inspect a resource's fields, types, and available operations before writing a query, or to verify a GraphQL query/mutation you have just generated against the real schema. It fetches the partial GraphQL SDL for a single commercetools resource:
```bash
node scripts/graphql-schemata.mjs \
--resource-name "<commercetools resource, e.g. Cart, Product, Order>" \
--app-name "<host app: claude-code, claude-chat, cursor, codex, copilot — or the host's own name>" \
--model "<current-model>"
```
The output is the GraphQL SDL for that resource. If the resource name is not recognized, the script prints the list of valid resource names — pick the correct one and re-run. **Note:** the SDL may contain *stubbed types* — referenced resources rendered as stubs, with their real type name given in a comment. Fetch any you need separately by re-running this script with that type name as `--resource-name`.
**Fetch OpenAPI (REST) schema** — Run this when you need context about a commercetools REST endpoint, request/response payload, or update action — for example, to inspect a resource's REST operations before constructing a request, or to verify a REST request/payload you have just generated against the real specification. It fetches the partial OpenAPI specification for a single commercetools resource:
```bash
node scripts/openApi-schemata.mjs \
--resource-name "<commercetools resource, e.g. api-Cart-write, api-Customer-read, checkout-Application>" \
--app-name "<host app: claude-code, claude-chat, cursor, codex, copilot — or the host's own name>" \
--model "<current-model>"
```
The output is the OpenAPI specification (YAML) for that resource. REST resources use a read/write-split naming form (e.g. `api-Cart-read`, `api-Cart-write`). If the resource name is not recognized, the script prints the list of valid resource names — pick the correct one and re-run. **Note:** the spec does not include reference-expansion schemas — fetch a referenced resource's schema separately by re-running this script with that resource as `--resource-name`.
## SDK Setup
See [sdk-setup.md](./references/sdk-setup.md) for:
- Package installation (`@commercetools/platform-sdk` + `@commercetools/ts-client`)
- `ClientBuilder` singleton with Client Credentials flow
- Required environment variables and auth URLs by region
- Required API client scopes
## Product Search API
See [product-search.md](./references/product-search.md) for:
- Official docs and why the legacy `productProjections` search is deprecated
- Full-text + filter + sort + facets example
- Category filter, SKU lookup, price selection, discount expansion, BOPIS channel filtering
Pliki w paczce (6)
- SKILL.md 5 KB
- references/product-search.md 8 KB
- references/sdk-setup.md 5 KB
- scripts/docs-search.mjs 26 KB
- scripts/graphql-schemata.mjs 25 KB
- scripts/openApi-schemata.mjs 25 KB
Wersje
W bazie nie ma innych skilli o nazwie commercetools-platform.
Migawka bazy z 13.11.2026 · wersja paczki 9d7fc47e0058 (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 0 · ranking
Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.
Podobne skille
- 100commercetools-checkout
Opisuje integrację commercetools Checkout: tryb tylko płatności, pełny hostowany checkout, widżet @commercetools/checkout-browser-sdk, konfigurację, konektory PSP (Stripe, Adyen, Mollie) i webhooki. - 100commercetools-integration-layer
Buduje i publikuje rozszerzenia dla commercetools Commerce Integration Layer (BFF projektu): rozszerzenie schematu GraphQL oraz Managed API Extension zatwierdzające, modyfikujące lub blokujące zapisy. - 90api-patterns
Podpowiada wybór REST, GraphQL lub tRPC oraz odpowiedzi, wersjonowanie, uwierzytelnianie i limity zapytań. - 90api-patterns
Wybiera REST, GraphQL lub tRPC i ustala wersjonowanie, stronicowanie, uwierzytelnianie oraz limity zapytań dla API. - 96typescript-sdk
Opisuje wzorce SDK TypeScript dla Opik i pomaga przy pracy w katalogu sdks/typescript. - 100bigcommerce
Pomaga budować sklepy na BigCommerce z API REST i GraphQL: sklepy headless z Storefront GraphQL lub Catalyst Next.js, zarządzanie produktami i zamówieniami oraz migrację ze Shopify.