Index of every page on this site: llms.txt
Unhead
TypeScript
Schema

Product Schema

Copy for LLMs
On this page

Schema.org Product

  • Type: defineProduct<T extends Record<string, any>>(input?: Product & T)
    Describes a Product on a WebPage.

Useful Links

For a Google product snippet, name and at least one of review, aggregateRating, or offers are required. Google supports product rich results on pages focused on one product or variants of that product; see the product snippet requirements.

Unhead input properties

The Product TypeScript interface requires name and image when you pass an object. defineProduct() itself accepts no argument, and the resolver can inherit both values from page metadata. Unhead does not check Google's eligibility requirements at runtime.

  • name string
    Provide the product name through the title route metadata or set name explicitly.
  • image NodeRelations<ImageObject | string>
    Link a primary image or a collection of images to the product.

Recommended Properties

  • offers NodeRelations<Offer | number>
    Add Offer properties.

Google's merchant and product variant documentation also uses audience, category, color, GTIN variants, hasAdultConsideration, hasCertification, inProductGroupWithID, isVariantOf, material, pattern, size, and subjectOf. Unhead types their nested CategoryCode, Certification, PeopleAudience, ProductGroup, SizeSpecification, and 3DModel values.

Offer price specifications cover active prices, struck-through prices, unit pricing, member prices, and loyalty points. The type prevents priceType and validForMemberTier from appearing together.

Defaults

  • @type: Product
  • @id: ${canonicalUrl}#product
  • name: page title from resolved metadata
  • image: resolved page image
  • description: resolved page description
  • brand: id reference of the identity
  • mainEntityOfPage: ID reference of the WebPage

Resolves

See Global Resolves for full context.

  • when image is a single string, it is resolved to a root ImageObject node with an absolute URL; arrays are left as the supplied image values
  • audience, brand, hasCertification, isVariantOf, and subjectOf resolve as typed nested nodes
  • untyped brand objects resolve as Brand; set @type: Organization for an organization brand

Examples

Minimal Example

defineProduct({
  name: 'Guide To Vue.js',
  image: '/vuejs-book.png',
})

Product with an offer, rating, and review

defineProduct({
  name: 'Ergonomic Desk Chair',
  image: '/product.png',
  offers: [
    { price: 50 },
  ],
  aggregateRating: {
    ratingValue: 88,
    bestRating: 100,
    ratingCount: 20,
  },
  review: [
    {
      name: 'Comfortable and easy to assemble.',
      author: {
        name: 'Harlan Wilton',
      },
      reviewRating: {
        ratingValue: 5,
      },
    },
  ],
})

Types

/**
 * Any offered product or service.
 * For example: a pair of shoes; a concert ticket; the rental of a car;
 * a haircut; or an episode of a TV show streamed online.
 */
export interface ProductSimple extends Thing {
  /**
   * The name of the product.
   */
  name: string
  /**
   * A reference-by-ID to one or more ImageObjects which represent the product.
   * Google eligibility has separate image guidelines; see the Product guide above.
   */
  image: NodeRelations<ImageObject | string>
  /**
   *  An array of references-by-ID to one or more Offer or aggregateOffer pieces.
   */
  offers?: NodeRelations<Offer | number>
  /**
   * A Brand or Organization associated with the Product.
   */
  brand?: NodeRelation<Brand | Organization>
  /**
   * A reference to an Organization piece which represents the seller/merchant.
   */
  seller?: NodeRelation<Organization>
  /**
   * A text description of the product.
   */
  description?: string
  /**
   * An array of references-by-id to one or more Review pieces.
   */
  review?: NodeRelations<Review>
  /**
   * A merchant-specific identifier for the Product.
   */
  sku?: string
  /**
   * The Global Trade Item Number (GTIN) of the product.
   */
  gtin?: string
  /**
   * The Manufacturer Part Number (MPN) of the product.
   */
  mpn?: string
  /**
   * The condition of the product (e.g., New, Used, Refurbished).
   */
  itemCondition?: string
  /**
   * An AggregateRating object.
   */
  aggregateRating?: NodeRelation<AggregateRating>
  /**
   * An AggregateOffer object.
   */
  aggregateOffer?: NodeRelation<AggregateOffer>
  /**
   * A reference to an Organization piece, representing the brand which produces the Product.
   */
  manufacturer?: NodeRelation<Organization>
  audience?: NodeRelations<PeopleAudience>
  category?: Arrayable<NodeRelation<CategoryCode> | string>
  color?: Arrayable<string>
  gtin8?: string
  gtin12?: string
  gtin13?: string
  gtin14?: string
  isbn?: string
  hasAdultConsideration?: Arrayable<AdultConsideration>
  hasCertification?: NodeRelations<Certification>
  inProductGroupWithID?: string
  isVariantOf?: NodeRelation<ProductGroup>
  material?: Arrayable<string | Thing>
  pattern?: Arrayable<string>
  size?: NodeRelation<SizeSpecification | string>
  subjectOf?: NodeRelation<ThreeDModel>
}

Related Schemas

Edit this page
Markdown For LLMs
Did this page help you?

Podcast Series Schema

Use definePodcastSeries() to describe a podcast show, including its host, RSS feed, episodes, seasons, dates, and cover image.

Question Schema

Use defineQuestion() to add Question and Answer structured data and connect FAQPage mainEntity references.