Product Schema
Understand the standardized schema for your Shopify products to maximize search and browsing efficiency within Layers.
Product Schema Overview
The product schema is a standardized format that transforms your Shopify product data into an optimized structure for the search and browse engine.
Schema Fields
The following table outlines the key fields in the product schema, along with their data types, descriptions, and example values:
| Field Name | Type | Description | Example Value |
|---|---|---|---|
id | Integer | Unique identifier for the product | 7003338965178 |
title | String | Title of the product | "SUPREME SEALLINE SEE POUCH SMALL" |
body_html | String | HTML content describing the product | "The Supreme Sealline See Pouch Small is a versatile and..." |
vendor | String | The product’s vendor | "SUPREME" |
product_type | String | Type of the product | "Accessories" |
created_at | DateTime | DateTime when the product was created | 1644047925 |
handle | String | A unique human-friendly string for the product, used in the product’s URL | "supreme-pouch-44370ss18a32-sm" |
updated_at | DateTime | DateTime when the product was last updated | 1698280024 |
published_at | DateTime | DateTime when the product was published | 1644047925 |
tags | Array of Strings | Tags associated with the product | ["Collection: Best Seller", "Collection:Accessories", "Collection:Supreme Accessories"] |
images | Array of Objects | Images related to the product. | [{"alt": "SUPREME POUCH", "src": "https://cdn.shopify.com/...", "width": 800, "height": 534, "variant_ids": []}] |
metafields | Object | Configured metafields for the product | {"product": {"alias": "SEALLINE SEE POUCH SMALL", "colorway": "BLACK", "styleCode": "SS18A30 BLACK", "yearOfRelease": 2018}} |
available | Boolean | Availability status of the product | true |
price_range | Object | Price range of the product, including from and to fields | {"from": 7.97, "to": 7.97, "compare_at_price": 7.97} |
options | Object | Dynamically created object from product options (can be an array of any type, depending on the product configuration) | {"size": ["S", "M", "L"]} |
named_tags | Object | Dynamically created object of “key:value” tags on the product. Keys/values in this object are not included in the tags array | {"YearOfRelease": 2016} |
{key}:{type}:{value} tag format. Supported types: number, boolean.Example Product (JSON)
Data Types and Formatting
- Integer: Whole numbers without decimals.
- String: Textual data, often used for titles or descriptions.
- Decimal: Numbers with decimal points, typically used for prices.
- Array: A list of values, used for tags or features.
- Boolean: A true or false value, indicating binary states such as availability.
Supported Metafield Types
The product schema supports various Shopify metafield data types, ensuring that your product data is handled correctly for display and filtering purposes. The following metafield types are currently supported:
| Type | Description | Example |
|---|---|---|
| single_line_text_field | A single line of text used for titles, names, or other short descriptions. | "Limited Edition" |
| multi_line_text_field | Multiple lines of text, typically used for long descriptions or instructions. | "Care instructions: Machine wash cold, tumble dry low." |
| boolean | True or false value indicating binary states such as availability or inclusion. | true |
| number_integer | Whole numbers used for inventory counts, order limits, or other quantities. | 150 |
| number_decimal | Numbers with decimal places, often used for prices, weights, or measurements. | 29.99 |
| json | JSON objects used to store structured data such as configurations, specifications, or dynamic content. | {"alias": "SEALLINE SEE POUCH SMALL", "colorway": "BLACK"} |
| date | Date values formatted as YYYY-MM-DD, often used for production dates, release dates, or promotional periods. | "2023-09-30" |
| date_time | DateTime values formatted as ISO 8601, used for time-based events like product launches or sales end times. | "2024-01-01T00:00:00.000Z" |
| color | Color values formatted as hexadecimal strings, used for product colors or UI elements. | "#FF5733" |
| file_reference | Links to file assets, including images, PDFs, or other documents that can be referenced in product displays or additional resources. | "https://cdn.shopify.com/files/myfile.pdf" |
| product_reference | Links to other product IDs, allowing cross-referencing of related items. | "gid://shopify/Product/123456789" |
| variant_reference | References to specific product variants, allowing differentiation between product options like size or color. | "gid://shopify/ProductVariant/987654321" |
| collection_reference | References to collections, used for categorization and dynamic grouping of products. | "gid://shopify/Collection/456789123" |
| page_reference | Links to Shopify pages, typically used for additional information or storytelling about a product. | "gid://shopify/Page/654321987" |
| metaobject_reference | References to custom metaobjects that can extend product data with additional attributes or structured information. | "gid://shopify/Metaobject/321654987" |
| url | URLs pointing to external resources, used for additional product details or external documentation. | "https://example.com/extended-warranty" |
These metafield types allow for greater flexibility and precision when configuring and displaying product data within your search and browse engine.
Metaobject & Reference Handling
The schema supports reference types (e.g., product_reference, variant_reference, collection_reference, metaobject_reference) by capturing only the ID for these references. This ensures optimized storage and lookup during search and browse operations.
For a complete list of supported types and their properties, please refer to the official Shopify Metafield Data Types documentation.
Was this page helpful?