Product

OBJECT

Definition

type Product implements Node {
  id: String!
  entityId: Int!
  sku: String!
  path: String!
  name: String!
  description: String!
  plainTextDescription(characterLimit: Int): String!
  warranty: String!
  minPurchaseQuantity: Int
  maxPurchaseQuantity: Int
  addToCartUrl: String!
  addToWishlistUrl: String!
  isPriceHidden: Boolean!
  prices(includeTax: Boolean, currencyCode: currencyCode): Prices
  priceRanges(includeTax: Boolean): PriceRanges
  weight: Measurement
  height: Measurement
  width: Measurement
  depth: Measurement
  options(before: String, after: String, first: Int, last: Int): OptionConnection!
  productOptions(before: String, after: String, first: Int, last: Int): ProductOptionConnection!
  reviewSummary: Reviews!
  type: String!
  availability: String!
  availabilityDescription: String!
  availabilityV2: ProductAvailability!
  categories(sortBy: ProductCategorySort, before: String, after: String, first: Int, last: Int): CategoryConnection!
  brand: Brand
  variants(before: String, after: String, first: Int, last: Int, isPurchasable: Boolean, entityIds: [Int!], optionValueIds: [OptionValueId!], skus: [String!]): VariantConnection!
  customFields(names: [String!], before: String, after: String, first: Int, last: Int): CustomFieldConnection!
  images(before: String, after: String, first: Int, last: Int): ImageConnection!
  defaultImage: Image
  relatedProducts(before: String, after: String, first: Int, last: Int, hideOutOfStock: Boolean): RelatedProductsConnection!
  inventory: ProductInventory!
  metafields(namespace: String!, keys: [String!], before: String, after: String, first: Int, last: Int): MetafieldConnection!
  upc: String
  mpn: String
  gtin: String
  createdAt: DateTimeExtended!
  reviews(sort: ProductReviewsSortInput, filters: ProductReviewsFiltersInput, before: String, after: String, first: Int, last: Int): ReviewConnection!
  seo: SeoDetails!
  giftWrappingOptions(before: String, after: String, first: Int, last: Int): GiftWrappingConnection!
  condition: ProductConditionType
  showCartAction: Boolean!
  videos(before: String, after: String, first: Int, last: Int): VideoConnection!
  featuredPromotions(before: String, after: String, first: Int, last: Int): FeaturedPromotionConnection!
  locales(before: String, after: String, first: Int, last: Int): LocaleAlternateConnection!
}

Product

Fields

idStringRequired

The ID of an object

entityIdIntegerRequired

Id of the product.

skuStringRequired

Default product variant when no options are selected.

pathStringRequired

Relative URL path to product page.

nameStringRequired

Name of the product.

descriptionStringRequired

Description of the product.

plainTextDescriptionStringRequired

Description of the product in plain text.

warrantyStringRequired

Warranty information of the product.

addToCartUrlStringRequired

Absolute URL path for adding a product to cart.

isPriceHiddenBooleanRequired

Indicates whether the product’s price is hidden on storefront pages. Defaults to false. This is true when “Show ‘Call for pricing’ message instead of the price” is enabled for the product. It does not take store-wide product price display settings into account.

productOptionsProductOptionConnectionRequired

Product options.

reviewSummaryReviewsRequired

Summary of the product reviews, includes the total number of reviews submitted and summation of the ratings on the reviews (ratings range from 0-5 per review).

typeStringRequired

Type of product, ex: physical, digital

availabilityV2ProductAvailabilityRequired

The availability state of the product.