Product

Describes a product.

Type Definition

type Product {
  handle: String
  minQuantity: Int
  maxQuantity: Int
  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
  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

Relationships

• combinedListing: Links to a CombinedListing object representing combined product listings.
• firstAvailableVariant, defaultOrSelectedVariant, variants: Connect to one or more ProductVariant objects representing product variants.
• optionsWithValues, optionsByHandle: Arrays of ProductOption objects providing detailed option data.
• manufacturer: Links to a Manufacturer object providing manufacturer details.
• compatible, similar, related: Arrays of related Product objects indicating compatibility, similarity, or relatedness.
• deliverer: Links to a Deliverer object representing the product’s deliverer.
• productGroups: Array of ProductGroup objects representing associated product categories or groups.
• reviews: Array of Review objects containing product reviews.
• attachments: Array of Attachment objects representing product attachments.
• taxonomy: Links to a ProductTaxonomy object representing product classification.

Usage Examples

Basic Query

{
  product(id: 12345) {
    id
    title
    handle
    isAvailable
    minQuantity
    maxQuantity
  }
}

Field Selection

{
  product(id: 12345) {
    title
    description
    seoTitle
    seoDescription
    seoKeywords
    tags
    rating
    reviewCount
  }
}

Nested Queries

{
  product(id: 12345) {
    title
    manufacturer {
      id
      name
    }
    firstAvailableVariant {
      id
      sku
      price
    }
    reviews {
      id
      rating
      comment
      createdAt
    }
    productGroups {
      id
      title
    }
  }
}

Filtering and Sorting

{
  products(filter: { tags: ["summer", "sale"] }, sort: { field: "rating", direction: DESC }, first: 10) {
    edges {
      node {
        id
        title
        rating
        reviewCount
      }
    }
  }
}

Implements

This type does not explicitly implement any interfaces.

Connections

• variants returns a list of ProductVariant objects representing the different variants of the product.
• reviews returns a list of Review objects associated with the product.
• productGroups returns a list of ProductGroup objects categorizing the product.
• compatible, similar, and related return lists of Product objects representing relationships to other products.

Related Types

• CombinedListing
• ProductVariant
• ProductOption
• CustomField
• Manufacturer
• Product
• Deliverer
• ProductGroup
• Review
• Attachment
• ProductTaxonomy

Best Practices

• Use the id field to uniquely identify products in queries and mutations.
• When querying variants, prefer firstAvailableVariant or defaultOrSelectedVariant to efficiently retrieve a single relevant variant.
• Use filtering and sorting on fields like tags, rating, and reviewCount to optimize product listings.
• Leverage nested queries to fetch related data such as manufacturer details, reviews, and product groups in a single request.
• Use isAvailable and isDirectlyBuyable to determine product purchase eligibility before displaying purchase options.
• Utilize SEO-related fields (seoTitle, seoDescription, seoKeywords) to enhance search engine optimization.
• Check review-related flags (reviewsAreEnabled, reviewsRequireAccount, etc.) to conditionally display review UI elements.
• Use customFields to access additional product metadata for advanced customization.

Notes

• All fields are optional and may return null if data is unavailable.
• The API currently requires no authentication, but this may change in future versions.
• When querying lists such as variants or reviews, consider implementing pagination to manage large datasets efficiently.
• The createdAt and updatedAt fields are ISO 8601 formatted strings representing timestamps.
• Fields such as inCustomersWishlist, customerHasReviewed, customerCanReview, and customerHasPurchased return string values indicating boolean states; handle accordingly in your client.
• Performance can be improved by selecting only the fields you need, especially when querying nested relationships.
• Use caching strategies on frequently accessed fields like id, title, and rating to reduce server load.

For more information on related object types, refer to their respective documentation sections.