{"pageKey":"Developers","slug":"developers-api-integrations","locale":"en-US","localeResolved":"en-US","fallbackApplied":false,"version":"developers-api-integrations@2026-10-04T23:38:10.496Z","lastModified":null,"canonicalUrl":"https://www.merchandaise.com/en-us/developers/api-integrations","payload":{"slug":"developers-api-integrations","purpose":"llm-developers-api-integrations","title":"Merchandise API Docs & OpenAPI Integrations | MerchandAise","description":"Explore MerchandAise API docs and OpenAPI specifications for custom merchandise, community embeds, supplier workflows and enterprise identity.","sections":[{"heading":"Choose the connection your project needs","paragraphs":["Use the references below to evaluate endpoints, request formats and authorization requirements. Public specifications support planning and client generation; operational access depends on the API, account and environment.","Where MerchandAise processes the buyer transaction, Hutter Products GmbH is the contracting seller and Merchant of Record under the MerchandAise brand. Supplier identity and contact details stay private except where disclosure is required, and production still requires digital-proof approval, confirmed producibility, mandatory technical checks, and the sample approvals applicable to the exact accepted order."]},{"heading":"API and integration surfaces","items":[{"title":"API docs & OpenAPI","description":"Find the API reference for assistant tooling and design sessions, then choose the community, supplier or enterprise contract for your workflow. Human guide: Read assistant tooling docs (/api/docs). Machine-readable contract: Assistant tooling OpenAPI JSON (/api/docs/openapi.json). Access: Public. Public reference for assistant and tooling APIs. Production access and order-affecting operations still require the applicable authorization. Canonical page: /developers/api-integrations. Canonical section: /developers/api-integrations#api-docs."},{"title":"Community API","description":"Connect a club or community website to public community information, design submissions, voting and order approval handoffs. What the contract covers: Public community context, design posts and votes, listing publication, pending orders, and community-owner approval or rejection. A practical starting point: Read public community context for a club website. Then map which actions require a member session or owner permissions before adding design submissions or checkout handoffs. Access: The specification is public. Public reads, member actions and owner-only operations have different authorization requirements; use the security rules on each endpoint. Human guide: Explore the Community API (/en-us/developers/api-integrations#community-integrations). Machine-readable contract: Community OpenAPI JSON (/api/v1/community/public/openapi/v1). Access: Public. Public versioned contract for storefront embeds, community discovery, and locale-aware handoffs. Canonical page: /developers/api-integrations. Canonical section: /developers/api-integrations#community-integrations."},{"title":"Supplier API","description":"Connect approved supplier systems to released production packages, onboarding status and ERP or PLM webhook workflows. What the contract covers: Supplier onboarding state, released production packages, audited artifact downloads, analytics, webhook subscriptions and sync checkpoints. A practical starting point: Plan a connection between your ERP or product lifecycle management system and Supplier Center. Review webhook payloads, retries and sync status before handling an assigned order. Access: Read the OpenAPI specification without signing in. Operational requests require the appropriate supplier account and permissions; public documentation does not enroll a supplier or grant access to another supplier’s data. Human guide: Explore the Supplier API (/en-us/developers/api-integrations#supplier-integrations). Machine-readable contract: Supplier OpenAPI JSON (/api/v1/supplier/openapi/v1). Access: Public. Public contract for planning and client generation. Operational supplier access remains permissioned. Canonical page: /developers/api-integrations. Canonical section: /developers/api-integrations#supplier-integrations."},{"title":"Enterprise Identity API","description":"Connect approved company workspaces to single sign-on, user and group provisioning, and identity audit records. What the contract covers: OpenID Connect (OIDC) single sign-on, SCIM user and group lifecycle operations, SCIM token rotation, and provisioning audit events. A practical starting point: Map your identity provider to the approved workspace. Plan sign-in, user provisioning and deprovisioning, then verify group mappings and audit records in the agreed test environment. Access: The enterprise identity specification is protected. Contact the integrations team to review the workspace and access requirements before implementation. Enterprise identity is optional for ordinary product purchases. Human guide: Explore enterprise identity (/en-us/developers/api-integrations#enterprise-integrations). Machine-readable contract: Enterprise identity OpenAPI JSON (/api/v1/enterprise/identity/openapi/v1). Access: Protected. Protected contract for approved enterprise workspaces; request access before using this endpoint. Canonical page: /developers/api-integrations. Canonical section: /developers/api-integrations#enterprise-integrations."}]},{"heading":"Choose the contract before the code","items":[{"title":"Step 1: Map the user journey","description":"Decide who enters the workflow and where: a buyer in an embedded storefront, an approved supplier, an enterprise user, or an assistant operating with explicit authorization."},{"title":"Step 2: Confirm the access boundary","description":"Use public contracts for evaluation and client generation, then confirm credentials, scopes, environments, callbacks, and protected endpoints before implementation."},{"title":"Step 3: Prove state continuity","description":"Test that designs, quotes, approvals, errors, and order handoffs stay version-current across the integration, including retries and rollback paths."}]},{"heading":"What every integration must preserve","items":[{"title":"One versioned state","description":"Design, commerce intent, supplier-backed quote, approval, and order status stay connected. Stale changes must trigger a visible re-quote or review state."},{"title":"Commercial and supplier privacy","description":"MerchandAise remains the buyer-facing merchant and support owner. Supplier identities, contacts, and internal data are not exposed through public integrations."},{"title":"Approval before production","description":"A 3D view is not physical evidence. The confirmed quote explains any available customer-sample choices, costs, limitations, and timing. Approve the exact digital proof and complete mandatory technical checks and any required or selected sample approval before mass production. Existing accepted-order requirements remain binding."}]},{"heading":"Before production traffic","paragraphs":["A published OpenAPI file is a planning surface, not a promise of anonymous production access. We review environments, credentials, failure handling, and operational ownership before go-live."],"items":[{"title":"Access and environments","description":"Confirm the contract version, approved workspace, authentication scopes, sandbox, production credentials, and callback destinations."},{"title":"Failure and recovery","description":"Define retries, idempotency, timeouts, customer-visible errors, observability, support ownership, and rollback before release."},{"title":"End-to-end evidence","description":"Verify the intended journey in staging from entry and state mutation through quote, approval, handoff, and recovery behavior."}]},{"heading":"FAQ","items":[{"title":"Which merchandise API should I start with?","description":"Start with the person and state transition. Use community embeds for buyer-facing club or community journeys, supplier operations for approved supply-side workflows, enterprise identity for SSO and SCIM, and assistant tooling only for explicitly authorized AI-led flows."},{"title":"Does a public contract mean public production access?","description":"No. A public OpenAPI contract supports discovery, architecture review, and client generation. Production credentials, write operations, supplier workflows, enterprise identity, and assistant execution can still require an approved workspace and scoped authorization."},{"title":"Can an integration expose suppliers or bypass approvals?","description":"No. Supplier identity and contact details remain private except where disclosure is required, MerchandAise owns the buyer relationship, and order-affecting actions must preserve the configured digital-proof, technical, and order-specific sample approval requirements."}]},{"heading":"Plan your integration with us.","paragraphs":["Tell us who will use the integration, which state they need to read or change, and where the experience will live. We will map the contract, access model, and safest rollout path with you."],"items":[{"title":"Plan an integration","description":"/en-us/contact?intent=api-integration-review"},{"title":"Explore AI agents and MCP","description":"/en-us/developers/ai-agents-mcp"}]}],"source":{"type":"page-copy","id":"Developers"}},"metadata":{"source":"route-owned-source","schema":"2025-11-05"}}