OBJECT

Product

The Product entity

link GraphQL Schema definition

  • type Product {
  • # The product id
  • id: Int
  • # The product type - simple, configurable, virtual, downloadable, grouped
  • type_id: String
  • # The product visibility. Customers use this visibility to identify the product.
  • visibility: Int
  • # The product status. Customers use this status to identify the product.
  • status: Int
  • # The product name. Customers use this name to identify the product.
  • name: String
  • # A number or code assigned to a product to identify the product, options, price,
  • # and manufacturer
  • sku: String
  • # Detailed information about the product. The value can include simple HTML tags.
  • description: String
  • # A short description of the product. Its use depends on the theme.
  • short_description: String
  • # The price of an item
  • price: Float
  • # The price of an item
  • price_incl_tax: Float
  • # The price of an item
  • price_tax: Float
  • # The final price of an item
  • final_price: Float
  • # The price of an item
  • final_price_incl_tax: Float
  • # The price of an item
  • final_price_tax: Float
  • # The price of an item
  • original_price: Float
  • # The price of an item
  • original_price_incl_tax: Float
  • # The price of an item
  • original_price_tax: Float
  • # The numeric minimal price of the product. Do not include the currency code.
  • min_price: Float
  • # The numeric maximal price of the product. Do not include the currency code.
  • max_price: Float
  • # The discounted price of the product
  • special_price: Float
  • # The discounted price of the product
  • special_price_incl_tax: Float
  • # The discounted price of the product
  • special_price_tax: Float
  • # The beginning date that a product has a special price
  • special_from_date: String
  • # The end date that a product has a special price
  • special_to_date: String
  • # The weight of the item, in units defined by the store
  • weight: Float
  • # A number representing the product's manufacturer
  • manufacturer: String
  • # A string that is displayed in the title bar and tab of the browser and in search
  • # results lists
  • meta_title: String
  • # A comma-separated list of keywords that are visible only to search engines
  • meta_keyword: String
  • # A brief overview of the product for search results listings, maximum 255
  • # characters
  • meta_description: String
  • # The relative path to the main image on the product page
  • image: String
  • # The relative path to the small image, which is used on catalog pages
  • small_image: String
  • # The relative path to the product's thumbnail image
  • thumbnail: String
  • # The price when tier pricing is in effect and the items purchased threshold has
  • # been reached
  • tier_price: Float
  • # Product tier prices
  • tier_prices: [ProductTierPrice]
  • # The beginning date for new product listings, and determines if the product is
  • # featured as a new product
  • news_from_date: String
  • # The end date for new product listings
  • news_to_date: String
  • # Indicates whether the product has required options
  • required_options: Boolean
  • # Indicates whether additional attributes have been created for the product
  • has_options: Boolean
  • # The label assigned to a product image
  • image_label: String
  • # The label assigned to a product's small image
  • small_image_label: String
  • # The label assigned to a product's thumbnail image
  • thumbnail_label: String
  • # The product's country of origin
  • country_of_manufacture: String
  • # Indicates whether a gift message is available
  • gift_message_available: Boolean
  • # Timestamp indicating when the product was created
  • created_at: String
  • # Timestamp indicating when the product was updated
  • updated_at: String
  • # The product size. Customers use this size to identify the product.
  • size: String
  • # The product sizes for all configurable_children variants. Customers use this
  • # size to identify the product.
  • size_options: [String]
  • # The product color. Customers use this color to identify the product.
  • color: String
  • # The product colors for all configurable_children variants. Customers use this
  • # color to identify the product.
  • color_options: [String]
  • # Category ID the product belongs to
  • category_ids: [String]
  • # The product categories. It executes additional query to fetch full category
  • # objects
  • categories: [Category]
  • # The product categories. This is just a simplified object with no structure
  • category: [CategoryBinding]
  • # Configurable product childrens
  • configurable_children: [Product]
  • # The product stock. Customers use this stock to identify the product.
  • stock: StockItem
  • # Is product in stock
  • is_in_stock: Boolean
  • # keyword filter input
  • keyword: String
  • # Media items assigned to this specific product
  • media_gallery: [MediaGalleryItem]
  • # Configurable attributes for this product
  • configurable_options: [ConfigurableOption]
  • # Custom options for this product
  • custom_options: [CustomOption]
  • # Bundle options for this product
  • bundle_options: [BundleOption]
  • # Get the product reviews
  • #
  • # Arguments
  • # search: Performs a full-text search using the specified key
  • # words.,
  • # filter: An array of categories that match the specified search
  • # criteria,
  • # pageSize: Specifies the maximum number of results to return at
  • # once. This attribute is optional.,
  • # currentPage: Specifies which page of results to return. The
  • # default value is 1.,
  • # _sourceIncludes: Specifies which attribute we include in
  • # result.
  • # _sourceExcludes: Specifies which attribute we exclude in
  • # result.
  • reviews(
  • search: String,
  • filter: ReviewFilterInput,
  • pageSize: Int,
  • currentPage: Int,
  • _sourceIncludes: [String],
  • _sourceExcludes: [String]
  • ): Reviews
  • }