Skip to Content

Product

Describes a product with comprehensive details including variants, images, reviews, and related product information.

Type Definition

type Product { handle: String seoDescription: String seoTitle: String seoKeywords: String id: Int combinedListing: CombinedListing firstAvailableVariant: ProductVariant hasOnlyDefaultVariant: Boolean variants: [ProductVariant] options: [String] optionsWithValues: [ProductOption] optionsByHandle: [ProductOption] defaultOrSelectedVariant: ProductVariant tags: [String] customFields: [CustomField] inPreview: Boolean isAvailable: Boolean isDirectlyBuyable: Boolean title: String manufacturer: Manufacturer shortDescription: String description: String images: [Image] videos: [Video] featuredImage: Image featuredVideo: Video compatible: [Product] similar: [Product] related: [Product] deliverer: Deliverer productGroups: [ProductGroup] returnPolicyTimeLimit: Int rating: Float reviewCount: Int maxRating: Int reviews: [Review] attachments: [Attachment] reviewsAreEnabled: Boolean reviewsRequireAccount: Boolean reviewsRequirePurchase: Boolean reviewsRequireApproval: Boolean taxonomy: ProductTaxonomy createdAt: String updatedAt: String rate: String inCustomersWishlist: String customerHasReviewed: String customerCanReview: String customerHasPurchased: String }

Fields

FieldTypeDescription
handleStringReturns the handle.
seoDescriptionStringReturns description for search engines.
seoTitleStringReturns title for search engines.
seoKeywordsStringReturns keywords for search engines.
idIntReturns the id.
combinedListingCombinedListingReturns the combined listing.
firstAvailableVariantProductVariantReturns the first available variant.
hasOnlyDefaultVariantBooleanReturns true if product has only default variant.
variants[ProductVariant]Returns the variants.
options[String]Returns the options handles.
optionsWithValues[ProductOption]Returns array of options.
optionsByHandle[ProductOption]Returns array of options indexed by handle.
defaultOrSelectedVariantProductVariantReturn the selected variant or the default one if none is selected.
tags[String]Returns product tags.
customFields[CustomField]Returns product custom fields as CustomFieldDrop objects.
inPreviewBooleanReturns true if product is in preview.
isAvailableBooleanReturns true if product is available for purchase.
isDirectlyBuyableBooleanReturns true if product can be bought without selecting any attributes.
titleStringReturns the title.
manufacturerManufacturerReturns the manufacturer.
shortDescriptionStringReturns the short description.
descriptionStringReturns the description.
images[Image]Returns the images.
videos[Video]Returns the videos.
featuredImageImageReturns product featured (first available) image.
featuredVideoVideoReturns the featured (first available) video.
compatible[Product]Returns the compatible products.
similar[Product]Returns the similar products.
related[Product]Returns the related products.
delivererDelivererReturns the deliverer.
productGroups[ProductGroup]Returns the associated product groups.
returnPolicyTimeLimitIntReturns the product return policy time limit in days.
ratingFloatReturns the rating.
reviewCountIntReturns the review count.
maxRatingIntReturns the maximum rating.
reviews[Review]Returns the reviews.
attachments[Attachment]Returns the product attachments as AttachmentDrop objects.
reviewsAreEnabledBooleanReturns true if reviews are enabled for this product.
reviewsRequireAccountBooleanReturns true if creating a review for this product requires an account.
reviewsRequirePurchaseBooleanReturns true if product must be purchased before review can be made.
reviewsRequireApprovalBooleanReturns true if reviews are approved before published.
taxonomyProductTaxonomyReturns the taxonomy.
createdAtStringReturns the creation date.
updatedAtStringReturns the last updated date.
rateStringReturns the tax rate.
inCustomersWishlistStringReturns true if product is in customers wishlist.
customerHasReviewedStringReturns true if customer has reviewed the product.
customerCanReviewStringReturns true if customer can review the product.
customerHasPurchasedStringReturns true if customer has purchased the product.

Relationships

The Product type represents a core entity in the storefront catalog. It maintains relationships with:

  • Variants: Products contain multiple ProductVariant objects that represent different configurations or SKUs
  • Images and Videos: Rich media content is associated through Image and Video types
  • Related Products: Links to compatible, similar, and related products for product discovery
  • Reviews: Customer feedback through Review objects with configurable approval workflows
  • Taxonomy: Product categorization through ProductTaxonomy
  • Manufacturer: Product source information
  • Deliverer: Shipping and fulfillment details
  • ProductGroups: Product grouping and organization
  • CustomFields and Attachments: Extended product metadata

Example

{ product(id: 12345) { id title handle description shortDescription isAvailable isDirectlyBuyable rating reviewCount featuredImage { url } variants { id title } optionsWithValues { handle name } manufacturer { name } reviews { id title rating } taxonomy { category } } }

Implements

This type does not implement any interfaces.