Documentation menu

Embed guide

Prepare, publish, and place schematic or collection embeds, then configure themes, access rules, language, currency, and supported deep links.

Overview

PartGrid embeds place a published schematic or collection inside a storefront or portal. Prepare and preview the customer-facing experience in the dashboard, then copy the generated iframe into the target page.

Embed types

Choose the customer experience

Prepare the content

Use the schematic or collection settings to review visibility, assigned content, language, and currency. Preview the experience and confirm that references, linked parts, prices, and customer-facing names are correct before copying the iframe.

Preparation checklist

Configure the embed workspace

Open Integrations → Embed. Overview shows the current embed status. Use Theme Library to create and edit themes, Theme selection to choose collection and dealer-collection overrides, and Behavior to manage public connectivity, price display, quotation settings, notification emails, and approved domains.

Copy the generated iframe

Copy the iframe from Schematic Settings or Collection Settings after the experience is ready. The generated URL contains the selected locale and currency. Prefer the generated code over constructing a public URL manually.

html

<iframe
  src="https://app.partgrid.ai/embed/en/collection/COLLECTION_UUID/schematic/SCHEMATIC_UUID?currency=USD"
  title="PartGrid parts catalog"
  style="width: 100%; min-height: 720px; border: 0;"
  loading="lazy"
></iframe>

Deep links

A collection embed selects the active schematic in the route path. Supported query parameters can focus the viewer on a specific hotspot or part. Use stable UUID parameters when they are available.

Supported route and parameters

Name: /embed/{locale}/collection/{collection_uuid}/schematic/{schematic_uuid}
Type: path
Description: Collection embed route for a selected schematic.

Name: currency
Type: string
Description: Currency code used by the customer-facing experience, for example USD or EUR.

Name: schematicHotspot
Type: uuid
Description: Selects a schematic reference by its stable UUID.

Name: schematicPart
Type: uuid
Description: Selects a linked part by its stable UUID when available.

Name: schematicPartNumber
Type: string
Description: Readable part-number fallback for an initial selection.

Name	Type	Description
/embed/{locale}/collection/{collection_uuid}/schematic/{schematic_uuid}	path	Collection embed route for a selected schematic.
currency	string	Currency code used by the customer-facing experience, for example USD or EUR.
schematicHotspot	uuid	Selects a schematic reference by its stable UUID.
schematicPart	uuid	Selects a linked part by its stable UUID when available.
schematicPartNumber	string	Readable part-number fallback for an initial selection.

Storefront communication

Use only browser events and payloads that PartGrid explicitly documents as a supported contract. Do not build an integration around message names or network payloads observed inside the managed embed runtime.