Simplio3D

Simplio3D SDK Reference

The official TypeScript SDK for the Simplio3D 3D CPQ platform. Full headless support for option blocks, conditional logic, pricing formulas, contact forms, 3D viewer, animations, and more.

IntroductionOverview of the @simplio3d/sdk headless TypeScript client — what it does and how it talks to the Simplio3D platform.InstallationInstall @simplio3d/sdk from npm and add it to a browser or Node.js project.Quick StartCreate a client, load a project, and render a configurator in a few lines of TypeScript.Client SetupConfigure the SDK client with an access token (browser) or API token (server) and the API URL.ProjectsList, read, create, update, and delete projects, with automatic decompression of large scenes.Option BlocksCreate and manage the 16 option block types and their variants from headless code.Conditional LogicAuthor and evaluate show / hide / disable rules across blocks, variants, and 3D parts.Pricing & CPQBuild CPQ pricing — base prices, price groups, tables, unique modular prices, variables, and formulas.Contact FormsManage contact forms and their 12 field types for lead capture and orders.Quote SubmissionsList and read quote and contact-form submissions captured from configurators.3D ViewerControl the embedded 3D viewer — camera, lighting, scene presets, and runtime selections.AnimationsCreate and play animation blocks: move, rotate, float, scale-pulse, swing, and orbit.Project SettingsRead and update the 140+ project settings covering display, branding, AR, e-commerce, email, and PDF.AssetsUpload, list, update, and delete 3D model, texture, and image assets.MaterialsCreate and manage PBR materials and their texture maps.CategoriesOrganize assets and materials into categories for filtering and bulk material blocks.TeamInvite, update, and remove team members on an account.SharingEnable sharing, manage tokens, and build embeddable share URLs.Email LogsList email logs and resend failed notifications.WebhooksRegister webhooks for quote.submitted, form.submitted, option.changed, and configuration.saved events.Augmented RealityEnable and configure surface and wearable AR experiences.TypeScriptBuilt-in TypeScript types and error classes (AuthenticationError, ValidationError, NotFoundError).ExamplesEnd-to-end recipes — headless embeds, binding external UI to SDK events, and more.ChangelogVersion history and notable changes to the Simplio3D SDK.