Skip to main content

CustomerProduct

A product as a buyer sees it in a list.

type CustomerProduct {
  availabilityState: String
  brandId: ID
  brandName: String
  canAddToCart: Boolean
  categories: [String!]
  categoryCodes: [String!]
  categoryIds: [String!]
  description: String
  discountPercentage: Float
  id: ID!
  imageUrl: String
  inStock: Boolean!
  isVeg: Boolean
  leadTimeDays: Float
  listPrice: Float
  lowStockCount: Float
  maxOrderQty: Float
  minOrderQty: Float
  name: String!
  orderMultiple: Float
  originalPrice: Float
  packLabel: String
  price: Float
  pricePerUnit: Float
  pricePerUnitBase: Float
  pricePerUnitDisplay: String
  pricePerUnitUom: String
  prices: [CustomerVariantSlabPrice!]
  promotionLabel: String
  showStockLevels: Boolean
  sku: String
  uom: String
  uomId: ID
  variantCount: Float
  variantId: ID
  variantLabel: String
  variants: [CustomerVariant!]
}

Fields

`CustomerProduct.availabilityState` ● `String` scalar

IN_STOCK, LOW_STOCK or OUT_OF_STOCK.

`CustomerProduct.brandId` ● `ID` scalar

The ID of the brand.

`CustomerProduct.brandName` ● `String` scalar

The name of the brand.

`CustomerProduct.canAddToCart` ● `Boolean` scalar

True when this row can be added to the cart. Clients should use this to allow adding, not work it out from inStock. It is true when stock is not tracked for the variant.

`CustomerProduct.categories` ● `[String!]` list scalar

The names of the categories the product is in.

`CustomerProduct.categoryCodes` ● `[String!]` list scalar

The codes of those categories, for navigation.

`CustomerProduct.categoryIds` ● `[String!]` list scalar

The IDs of those categories, in the same order as the codes.

`CustomerProduct.description` ● `String` scalar

What the product is.

`CustomerProduct.discountPercentage` ● `Float` scalar

The discount, in percent.

`CustomerProduct.id` ● `ID!` non-null scalar

The unique ID of this record.

`CustomerProduct.imageUrl` ● `String` scalar

The URL of the main image. Empty when neither the variant nor the product has one.

`CustomerProduct.inStock` ● `Boolean!` non-null scalar

True when the product is in stock.

`CustomerProduct.isVeg` ● `Boolean` scalar

True when the product is flagged vegetarian.

`CustomerProduct.leadTimeDays` ● `Float` scalar

The expected days from order to delivery.

`CustomerProduct.listPrice` ● `Float` scalar

The undiscounted list price.

`CustomerProduct.lowStockCount` ● `Float` scalar

The quantity at or below which the product shows as low stock.

`CustomerProduct.maxOrderQty` ● `Float` scalar

The largest quantity for one line in the same unit. Empty means no cap, and 0 means the pack cannot be ordered.

`CustomerProduct.minOrderQty` ● `Float` scalar

The smallest quantity for one line in the unit the row is priced in. The stricter of the variant's minimum and the pack's own wins.

`CustomerProduct.name` ● `String!` non-null scalar

The name of the product.

`CustomerProduct.orderMultiple` ● `Float` scalar

Quantities step by this, counted from 0. 1 or less means no whole-number step.

`CustomerProduct.originalPrice` ● `Float` scalar

The price before any discount.

`CustomerProduct.packLabel` ● `String` scalar

The label of the pack the price is for.

`CustomerProduct.price` ● `Float` scalar

The price the buyer pays.

`CustomerProduct.pricePerUnit` ● `Float` scalar

The price per base unit, worked out from the sales unit of measure, so bulk items can be compared.

`CustomerProduct.pricePerUnitBase` ● `Float` scalar

The price per base unit as a number.

`CustomerProduct.pricePerUnitDisplay` ● `String` scalar

The price per unit as text for display.

`CustomerProduct.pricePerUnitUom` ● `String` scalar

The unit the price per unit is for.

`CustomerProduct.prices` ● `[CustomerVariantSlabPrice!]` list object

The volume tier prices of the default variant.

`CustomerProduct.promotionLabel` ● `String` scalar

The names of any active discount schemes applied at quantity 1, for a promotion badge.

`CustomerProduct.showStockLevels` ● `Boolean` scalar

False when the organization hides stock labels, so no in-stock or out-of-stock label may be shown.

`CustomerProduct.sku` ● `String` scalar

The SKU of the default variant.

`CustomerProduct.uom` ● `String` scalar

The unit of measure the price is for.

`CustomerProduct.uomId` ● `ID` scalar

The ID of the unit of measure.

`CustomerProduct.variantCount` ● `Float` scalar

How many active variants the product has, so a card can offer a variant picker.

`CustomerProduct.variantId` ● `ID` scalar

The ID of the product variant.

`CustomerProduct.variantLabel` ● `String` scalar

The name of the default variant.

`CustomerProduct.variants` ● `[CustomerVariant!]` list object

Every active variant with its own units of measure and discounted tier prices.

Member Of

CustomerProductConnection object

Fields
Member Of