Page Metadata
Page metadata controls page-level settings. Add a metadata table to your document to configure SEO, caching, social sharing, and structured data — and to pass commerce properties like sku to blocks that need them.
What is page metadata?
Section titled “What is page metadata?”Page metadata is a special table that controls page-level properties. Unlike section metadata, which styles sections, page metadata affects the entire page — its SEO, caching behavior, social sharing appearance, and commerce-specific settings such as which product to display.
Page vs. Section metadata
Section titled “Page vs. Section metadata”- Page metadata — Controls SEO, caching, and page structure (added to the
metadatatable) - Section metadata — Controls section styling and visual presentation (added to the
section-metadatatable)
Both can be used on the same page but serve different purposes.
How to use page metadata
Section titled “How to use page metadata”Create or open your document
Section titled “Create or open your document”Open the document in the Universal Editor or the Document Authoring tool.
Add the metadata table
Section titled “Add the metadata table”At the top of your document (typically before any commerce blocks), add a new table with exactly two columns.
Set the table header
Section titled “Set the table header”In the first row, merge both cells and enter: metadata
Add metadata properties
Section titled “Add metadata properties”In subsequent rows, add your desired properties:
- First column: Property name (e.g.,
Title) - Second column: Property value (e.g.,
My Product Name)
Save and publish
Section titled “Save and publish”Save your document. The metadata applies when you publish the page.
Examples
Section titled “Examples”These examples show common page metadata configurations for different types of commerce pages. Each example demonstrates how the metadata table appears in your document and explains why specific properties are used.
Basic page metadata
Section titled “Basic page metadata”For a standard product page:
| metadata | |
| Title | Premium Running Shoes |
| Description | Lightweight running shoes with advanced cushioning for maximum comfort and performance. |
| Keywords | running shoes, athletic footwear, sports shoes |
Cart or checkout page metadata
Section titled “Cart or checkout page metadata”For pages with sensitive content that should not be cached or indexed:
| metadata | |
| Title | Shopping Cart |
| Robots | noindex, nofollow |
| Cache Control | no-store |
Page with social sharing
Section titled “Page with social sharing”For pages optimized for social media sharing:
| metadata | |
| Title | Premium Running Shoes |
| Description | Lightweight running shoes with advanced cushioning. |
| og:type | product |
| og:title | Premium Running Shoes - Best Athletic Footwear |
| og:description | Experience ultimate comfort with our premium running shoes. |
| og:image | https://example.com/images/shoes-hero.jpg |
Product on a marketing page
Section titled “Product on a marketing page”For a campaign or landing page that features one specific product, add a sku row so the product-details block knows which product to render. Without this row the block has no SKU to work with and the page will not display a product.
| metadata | |
| Title | New Arrivals |
| sku | HOODIE-001 |
Page with custom template
Section titled “Page with custom template”For account pages using the Columns layout template:
| metadata | |
| Title | My Addresses |
| Template | Addresses, Columns |
| Robots | noindex, nofollow |
Available metadata properties
Section titled “Available metadata properties”The metadata table accepts two kinds of properties: commerce properties that blocks read directly, and standard page properties for SEO, caching, and social sharing.
Commerce properties
Section titled “Commerce properties”| Property | Purpose | Example value |
|---|---|---|
sku | Tells the product-details block which product to display on pages where the SKU is not in the URL, for example a campaign or landing page | HOODIE-001 |
Page properties
Section titled “Page properties”| Property | Purpose | Common values |
|---|---|---|
Title | Page title in browser tab and search results | Cart, Checkout, Product Name |
Description | Page description for search results | Product or page description (150-160 characters) |
Keywords | SEO keywords (optional) | shoes, running, athletic |
Robots | Search engine indexing | noindex, nofollow, index, follow |
Cache Control | Page caching behavior | no-store, max-age=3600 |
Template | Page layout template | Columns, Addresses, Columns |
Theme | Visual theme | dark, light |
og:type | Social media content type | product, website |
og:title | Social sharing title | Product or page name |
og:description | Social sharing description | Product or page description |
og:image | Social sharing image URL | Full URL to product or page image |
json-ld | Structured data for search engines | JSON-LD string for products, breadcrumbs |