Skip to main content

CustomerVariant

A variant of a product as a buyer sees it.

type CustomerVariant {
  QRCode: String
  attributes: String
  availableQuantity: Float!
  barcode: String
  canAddToCart: Boolean
  dimensions: String
  id: ID!
  imageUrls: [String!]
  inStock: Boolean!
  isDefault: Boolean!
  maxOrderQuantity: Float
  minOrderQuantity: Float!
  name: String
  price: Float
  prices: [CustomerVariantSlabPrice!]
  salePrice: Float
  showStockLevels: Boolean
  sku: String!
  uom: String
  uomId: ID
  uoms: [ProductUOMType!]
  weight: Float
}

Fields

`CustomerVariant.QRCode` ● `String` scalar

The QR code of the variant.

`CustomerVariant.attributes` ● `String` scalar

The variant's attributes, such as colour or size, as JSON text.

`CustomerVariant.availableQuantity` ● `Float!` non-null scalar

The quantity available.

`CustomerVariant.barcode` ● `String` scalar

The barcode of the variant.

`CustomerVariant.canAddToCart` ● `Boolean` scalar

True when the variant can be added to the cart.

`CustomerVariant.dimensions` ● `String` scalar

JSON-stringified { length?, width?, height? }

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

The unique ID of this record.

`CustomerVariant.imageUrls` ● `[String!]` list scalar

The URLs of the variant images.

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

True when the variant is in stock.

`CustomerVariant.isDefault` ● `Boolean!` non-null scalar

Whether this is the default.

`CustomerVariant.maxOrderQuantity` ● `Float` scalar

The largest quantity that can be ordered.

`CustomerVariant.minOrderQuantity` ● `Float!` non-null scalar

The smallest quantity that can be ordered.

`CustomerVariant.name` ● `String` scalar

The name of the variant.

`CustomerVariant.price` ● `Float` scalar

The price the buyer pays.

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

The volume tier prices.

`CustomerVariant.salePrice` ● `Float` scalar

The sale price.

`CustomerVariant.showStockLevels` ● `Boolean` scalar

False when the organization hides stock labels.

`CustomerVariant.sku` ● `String!` non-null scalar

The SKU of the variant.

`CustomerVariant.uom` ● `String` scalar

The unit of measure.

`CustomerVariant.uomId` ● `ID` scalar

The ID of the unit of measure.

`CustomerVariant.uoms` ● `[ProductUOMType!]` list object

The units of measure the variant is sold in.

`CustomerVariant.weight` ● `Float` scalar

The weight of one unit.

Member Of

CustomerProduct object ● CustomerProductDetail object

Fields
Member Of