Skip to content

Single Product

About

The product query retrieves a single product by its unique identifier, SKU, or URL key. Use this query to:

  • Fetch individual products for detail pages
  • Look up products by different identifier types (ID, SKU, URL)
  • Display complete product information including images, variants, and attributes
  • Show product pricing, descriptions, and SEO metadata
  • Retrieve inventory and availability status
  • Build product-specific API integrations
  • Generate product detail pages with all metadata

This query supports multiple lookup methods (ID, SKU, or URL key) and can return minimal data for previews or comprehensive data for full product detail pages, making it flexible for various use cases.

Arguments

ArgumentTypeDescription
idIDProduct's unique system identifier. Use this for direct lookups.
skuStringStock Keeping Unit. Alternative identifier for product lookup.
urlKeyStringURL-friendly product slug. Alternative lookup method.
include_variantsBooleanInclude product variants (colors, sizes, options). Default: false
include_imagesBooleanInclude product images. Default: false
include_attributesBooleanInclude custom product attributes. Default: true
image_resolutionStringImage quality: thumbnail, medium, large, original. Default: large
include_recommendationsBooleanInclude related and recommended products. Default: false

Possible Returns

FieldTypeDescription
idID!Unique product identifier.
nameString!Product display name.
skuString!Stock Keeping Unit for inventory tracking.
urlKeyString!URL-friendly product slug for SEO.
typeString!Product type (simple, configurable, grouped, bundle).
descriptionStringFull product description with formatting.
shortDescriptionStringBrief product summary.
priceFloat!Base product price.
specialPriceFloatPromotional/discounted price if applicable.
taxClassStringTax classification for the product.
images[ProductImage!]Array of product images with URLs and metadata.
images.urlString!Image URL.
images.altTextStringImage alt text for accessibility.
images.positionIntImage order in gallery.
images.widthIntImage width in pixels.
images.heightIntImage height in pixels.
attributes[ProductAttribute!]Custom product attributes and values.
variants[ProductVariant!]Product variants (colors, sizes, options).
variants.skuString!Variant SKU.
variants.priceFloat!Variant-specific price.
inventoryInventoryInfo!Stock availability information.
inventory.stockInt!Current stock quantity.
inventory.statusString!Stock status (in_stock, out_of_stock, low_stock).
categories[Category!]!Categories this product belongs to.
tags[String!]Product tags and labels.
seoProductSEO!SEO metadata.
statusString!Product status (active, draft, inactive).
visibilityString!Visibility status (visible, not visible, search only).
createdAtDateTime!Product creation date.
updatedAtDateTime!Last modification date.

Released under the MIT License.