Clear contract ownership
Each integration surface links to an implementation guide and the machine-readable contract separately, reducing ambiguity during implementation and reviews.
Developer platform
API and integrations for custom merchandise workflows
Plan, test, and launch MerchandAise integrations with implementation guides, machine-readable OpenAPI contracts, and clear access boundaries for assistant tooling, community, supplier, and enterprise workflows.
What this page covers
This is the crawlable entry point for teams evaluating MerchandAise API and integration work. It separates implementation guides from machine contracts so developers, search engines, and AI assistants can cite the right surface.
Use it when you need assistant tooling docs, storefront embeds, supplier operations, enterprise identity, or a versioned OpenAPI contract before moving into implementation.
API and integration surfaces
| Surface | Implementation guide | Machine contract | Access |
|---|---|---|---|
| Assistant tooling API docsRead the assistant/tooling OpenAPI docs that support design sessions, tool use, and integration reviews. Community, supplier, and enterprise contracts are listed separately. | Implementation guideRead assistant tooling docs | Machine contractAssistant tooling OpenAPI JSON/api/docs/openapi.json | Accesspublic Public machine-readable OpenAPI for assistant/tooling APIs; use the domain-specific contracts below for community, supplier, and enterprise implementation. |
| Community embed APIImplement locale-safe storefront embeds, community workflows, and authenticated handoffs with a versioned public contract. | Implementation guideReview community integration guide | Machine contractCommunity OpenAPI JSON/api/v1/community/public/openapi/v1 | Accesspublic Public contract for storefront embeds, community discovery, and locale-aware handoffs. |
| Supplier APIConnect onboarding, catalog, and supplier-side operations through versioned endpoints built for fulfillment workflows. | Implementation guideReview supplier integration guide | Machine contractSupplier OpenAPI JSON/api/v1/supplier/openapi/v1 | Accesspublic Public versioned contract for supplier onboarding, catalog, and fulfillment workflows. |
| Enterprise identity APIIntegrate SSO, SCIM provisioning, and audit-ready identity flows for enterprise rollouts and governance through a protected contract for approved enterprise access. | Implementation guideReview enterprise integration guide | Machine contractEnterprise identity OpenAPI JSON/api/v1/enterprise/identity/openapi/v1 | Accessprotected Protected contract for approved enterprise workspaces; request access before using this endpoint. |
Production implementation checklist
- 01
Choose the right contract surface
Match the integration to the user journey first: community embeds for public storefronts, supplier APIs for fulfillment workflows, and enterprise identity for SSO, SCIM, and governed rollouts.
- 02
Generate and test against versioned contracts
Use the published OpenAPI JSON for client generation, contract review, staging validation, and regression testing before production traffic is enabled.
- 03
Confirm access, callbacks, and rollback paths
Document authentication scopes, callback URLs, environment boundaries, observability, and rollback ownership before launch.
Production safeguards
Locale-safe discovery
The page is localized, included in locale sitemaps, and linked from global navigation so teams and search engines can discover it directly.
Access boundaries
Public contracts are linked directly. Protected enterprise and assistant-authorized contracts are described without implying anonymous production access.
Before this API integration goes live
Use this checklist to turn the public contracts into a supported integration plan with clear access, rollout, and rollback ownership.
Request sandbox and credential review
Route your use case through integrations review so public, supplier, and protected enterprise surfaces are scoped correctly.
Document auth and callback boundaries
Record required scopes, callback URLs, environment names, webhook ownership, and customer-visible failure handling.
Verify contract health before release
Check OpenAPI JSON, protected access behavior, staging requests, and monitoring alerts before the first production handoff.
FAQ
Which MerchandAise API should I start with?
Start with the surface that matches the user journey: community embeds for storefront experiences, supplier APIs for fulfillment workflows, and enterprise identity APIs for SSO or SCIM rollouts.
Are the API contracts public?
Assistant tooling, community, and supplier OpenAPI contracts are public. Enterprise identity and MCP tools-list contracts are protected and require approved access before use.
Can AI assistants use this page?
Yes. The page exposes a dedicated LLM feed, canonical metadata, structured data, and stable links to human guides and machine-readable contracts.
Need an integration review?
Share the workflow, target environment, authentication needs, and launch timeline. The integrations team will recommend the correct contract surface and rollout path.