Technical reference

Product Core v1

Product Core v1 defines the canonical product record exposed by Spyndl. It contains approved product facts, descriptions, categories, images, attributes, lifecycle status, and pack contents when relevant.

Purpose

This schema is the public contract for product facts returned by Spyndl product data endpoints. It omits internal database identifiers and includes only populated fields.

Stability

The v1 identifier is intended to remain stable for existing integrations. Additive fields may appear over time. Breaking changes require a new schema identifier.

Fields

schema
Schema identifier and canonical reference URL for this product record format.
provider
The system publishing the structured product record.
generatedAt
ISO timestamp for the generated record.
product
Approved product facts, including SKU, status, brand, category, descriptions, images, attributes, lifecycle information, and pack contents when relevant. Attribute units are included in the value string.

Example

{
  "schema": {
    "id": "spyndl.product.core.v1",
    "url": "https://spyndl.com/schemas/product-core-v1"
  },
  "provider": {
    "name": "Spyndl",
    "url": "https://spyndl.com"
  },
  "generatedAt": "2026-05-10T08:20:02.123Z",
  "product": {
    "sku": "EX-1000",
    "commercialStatus": "available",
    "brand": {
      "name": "Example Brand"
    },
    "category": [
      "Example Category",
      "Example Subcategory"
    ],
    "description": {
      "model": "EX-1000",
      "short": "Example product description approved for publication."
    },
    "isPack": true,
    "attributes": [
      {
        "label": "Example attribute",
        "value": "100 unit"
      }
    ],
    "packContents": [
      {
        "sku": "EX-1000-COMPONENT",
        "description": "Example component included in the pack.",
        "category": [
          "Example Category",
          "Example Component Category"
        ]
      }
    ]
  }
}

Related Schema

Product Graph v1 adds the relationship layer around the same product record.

View Product Graph v1