CustomerProductDetail

A product as a buyer sees it on its page.

type CustomerProductDetail {
  brandId: String
  brandName: String
  canAddToCart: Boolean
  categories: [String!]
  categoryCodes: [String!]
  createdAt: DateTime!
  description: String
  id: ID!
  imageUrls: [String!]
  inStock: Boolean!
  listPrice: Float
  name: String!
  showStockLevels: Boolean
  startingPrice: Float
  uom: String
  variants: [CustomerVariant!]!
}

Fields

CustomerProductDetail.brandId ● String scalar

The ID of the brand.

CustomerProductDetail.brandName ● String scalar

The name of the brand.

CustomerProductDetail.canAddToCart ● Boolean scalar

True when any variant can be added to the cart.

CustomerProductDetail.categories ● [String!] list scalar

The names of the categories the product is in.

CustomerProductDetail.categoryCodes ● [String!] list scalar

The codes of those categories, for finding similar products.

CustomerProductDetail.createdAt ● DateTime! non-null scalar

When the record was created.

CustomerProductDetail.description ● String scalar

What the product is.

CustomerProductDetail.id ● ID! non-null scalar

The unique ID of this record.

CustomerProductDetail.imageUrls ● [String!] list scalar

The URLs of the product images.

CustomerProductDetail.inStock ● Boolean! non-null scalar

True when any variant is in stock.

CustomerProductDetail.listPrice ● Float scalar

The undiscounted list price.

CustomerProductDetail.name ● String! non-null scalar

The name of the product.

CustomerProductDetail.showStockLevels ● Boolean scalar

False when the organization hides stock labels.

CustomerProductDetail.startingPrice ● Float scalar

The lowest price among the variants.

CustomerProductDetail.uom ● String scalar

The unit of measure the product is priced in.

CustomerProductDetail.variants ● [CustomerVariant!]! non-null object

The variants of the product.

Returned By

customerProductBySku query ● customerProductDetail query ● publicProductDetail query