Clear contract ownership
Each integration surface links to the human workflow 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 human-readable guides, machine-readable OpenAPI contracts, and clear access boundaries for 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 human planning links from public machine contracts so developers, search engines, and AI assistants can cite the right surface.
Use it when you need storefront embeds, supplier operations, enterprise identity, or a versioned OpenAPI contract before moving into implementation.
API and integration surfaces
| Surface | Human guide | Machine contract | Access |
|---|---|---|---|
| API docsReview human-readable docs and machine-readable OpenAPI contracts for planning, testing, and versioned release management. | Read API docs | OpenAPI JSON/api/docs/openapi.json | public Public machine-readable OpenAPI JSON for client generation and contract review. |
| Community embed APIImplement locale-safe storefront embeds, community workflows, and authenticated handoffs with a versioned public contract. | Explore community workflows | Open community contract/api/v1/community/public/openapi/v1 | public 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. | Explore partner workflow | Open supplier contract/api/v1/supplier/openapi/v1 | public 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. | Explore enterprise platform | Open enterprise identity contract/api/v1/enterprise/identity/openapi/v1 | protected 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 contracts are described without implying anonymous production access.
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?
Core OpenAPI, community, and supplier contracts are public. Enterprise identity contracts are protected and require approved enterprise 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.