product object
Information about a product.
Properties
| Name | Type | Description |
|---|---|---|
id | string | Product identifier |
name | string | Product name |
slug | string | Product slug |
description | string | Product full description |
price | number | Product price |
visible | boolean | Product visibility |
compare_at_price | number | Compare at price |
categories | array of category object | Product categories |
images | array | Product images |
variants | product_variant[] | The variants of the product |
available | boolean | Product is available for purchase |
selected_or_first_available_variant | product_variant or null | Default selected variant "or" the first available product for purchase |
first_available_variant | product_variant or null | First available product for purchase |
selected_variant | product_variant or null | Default selected variant |
has_only_default_variant | boolean | If a product only has the default variant |
structured_data | string | A schema.org structured data representation of the product and its variants |
url | string | The product page URL |
thumbnail | string | Product thumbnail image URL |
options | array | Variant option definitions (name and values) |
meta | array | SEO meta title and description |
metafields | array | Product metafields, by namespace and key. See metafield |
related_products | array of product object | Products related to this one |
averageRating | number | Average review rating, from 0 to 5 |
isTrackingInventory | boolean | Whether stock is tracked for this product |
skip_to_checkout | boolean | Whether adding to cart sends the customer straight to checkout |
preview_image | preview_image object or null | The thumbnail image in several sizes, or nil when the product has no image |