Schema Documentation

product

Description

A product object

Response

Returns a Product

Arguments
NameDescription
id - ID! The ID for identifying the product
idType - ProductIdTypeEnum Type of ID being used identify product

Example

Query
query product(
  $id: ID!,
  $idType: ProductIdTypeEnum
){
  product(
    id: $id,
    idType: $idType
  ){
    attributes {
      ...ProductToProductAttributeConnectionFragment
    }averageRatingcatalogVisibilitydatabaseIddatedateOnSaleFromdateOnSaleTodescriptionfeaturedgalleryImages {
      ...ProductToMediaItemConnectionFragment
    }globalAttributes {
      ...ProductToGlobalProductAttributeConnectionFragment
    }idimage {
      ...MediaItemFragment
    }linklocalAttributes {
      ...ProductToLocalProductAttributeConnectionFragment
    }menuOrdermetaData {
      ...MetaDataFragment
    }modifiednameonSaleparent {
      ...ProductFragment
    }productCategories {
      ...ProductToProductCategoryConnectionFragment
    }productTags {
      ...ProductToProductTagConnectionFragment
    }productTypes {
      ...ProductToProductTypeConnectionFragment
    }purchasablepurchaseNoterelated {
      ...ProductToProductConnectionFragment
    }reviewCountreviews {
      ...ProductToCommentConnectionFragment
    }reviewsAllowedshippingClasses {
      ...ProductToShippingClassConnectionFragment
    }shortDescriptionskuslugstatustotalSalestypeupsell {
      ...ProductToUpsellConnectionFragment
    }visibleProducts {
      ...ProductToVisibleProductConnectionFragment
    }
  }
}
Variables
{"id":4,"idType":"DATABASE_ID"}
Response
{"data":{"product":{"attributes":ProductToProductAttributeConnection,"averageRating":987.65,"catalogVisibility":"CATALOG","databaseId":123,"date":"xyz789","dateOnSaleFrom":"abc123","dateOnSaleTo":"abc123","description":"abc123","featured":true,"galleryImages":ProductToMediaItemConnection,"globalAttributes":ProductToGlobalProductAttributeConnection,"id":4,"image":MediaItem,"link":"xyz789","localAttributes":ProductToLocalProductAttributeConnection,"menuOrder":987,"metaData":[MetaData],"modified":"abc123","name":"xyz789","onSale":true,"parent":Product,"productCategories":ProductToProductCategoryConnection,"productTags":ProductToProductTagConnection,"productTypes":ProductToProductTypeConnection,"purchasable":false,"purchaseNote":"abc123","related":ProductToProductConnection,"reviewCount":987,"reviews":ProductToCommentConnection,"reviewsAllowed":false,"shippingClasses":ProductToShippingClassConnection,"shortDescription":"xyz789","sku":"xyz789","slug":"abc123","status":"abc123","totalSales":123,"type":"EXTERNAL","upsell":ProductToUpsellConnection,"visibleProducts":ProductToVisibleProductConnection}}}