PartGrid.ai
Documentation menu

Integration interface overview

Understand which PartGrid browser and server-side interfaces are supported and which internal routes must not be used as integration contracts.

Reference scope

This page describes the supported integration boundary without exposing internal application routes. Public browser implementations should use the generated iframe. Approved partner and server-side integrations receive their versioned endpoint documentation and credentials directly from PartGrid.

Generated embeds

The iframe URL generated by PartGrid is the supported browser-facing integration. It handles published schematic data, collection navigation, localization, pricing, theming, and supported customer actions without requiring direct access to underlying service endpoints. See the Embed guide for installation and supported deep-link behavior.

Customization

Theme creation, publishing, and assignment are managed in PartGrid. The complete theme JSON used in Advanced mode is a managed product format rather than a public API payload. For an approved custom styling contract, --pf-primary is the currently documented stable embed variable. See Embed theming.

Storefront events

Use only browser events and payloads that PartGrid explicitly documents as supported. The presence of a postMessage call in the managed viewer does not by itself make its event name or payload a public compatibility contract.

Quotes

Quote requests should be submitted through the supported PartGrid embed flow. The viewer applies the company configuration and validation required for the published experience. Direct calls to internal quote submission or tracking routes are not supported. See How quote management works for the customer and sales workflow.

Shopware integration

Use the official PartGrid Shopware integration for supported category, product, schematic, and storefront workflows. The plugin manages its authenticated communication with PartGrid; receiver paths, payloads, signatures, and synchronization internals are not public APIs.

API Reference