OrderingOrderProduct

An object representing a product in an order.

type OrderingOrderProduct {
  sku: String!
  quantity: Int!
  unitOfMeasure: String!
  quantityPerUnit: Float! @deprecated(reason: "Use quantityPerBaseUnit instead.")
  quantityPerBaseUnit: Float!
  baseUnitOfMeasure: String!
  name: String!
  subtitle: String
  imageUrl: String!
  priceCents: Int!
  availabilityStatus: OrderingProductAvailabilityStatus!
  addons: [OrderingProductAddon!]!
  availableAddons: [OrderingProductAddon!]!
  options: [OrderingProductOption!]!
  attributes: [OrderingProductAttribute!]!
  availableWarranties: [OrderingProductWarranty!]!
  selectedWarranty: OrderingProductWarranty
}

sku

string - The SKU of the product. Is defined by the manufacturer or distributor.

quantity

number - The quantity of the product being purchased in the order.

unitOfMeasure

string - The unit of measure for the product (e.g. “each”, “case”).

quantityPerUnit (deprecated)

number - Deprecated. Use quantityPerBaseUnit instead. Returns the same value under a less explicit name.

quantityPerBaseUnit

number - The number of baseUnitOfMeasure contained in each unitOfMeasure (e.g. 23.77 sq ft per box). Multiply by quantity to get the total in the base unit. Replaces the deprecated quantityPerUnit.

baseUnitOfMeasure

string - The base unit of measure for the product (e.g. “each”).

name

string - The human readable name of the product.

subtitle

string | undefined - The subtitle of the product. Usually contains a brief description.

imageUrl

string - The URL of the product’s image.

priceCents

number - The price in cents, per base unit (denominated in baseUnitOfMeasure).

availabilityStatus

OrderingProductAvailabilityStatus - The availability status of the product in the chosen distribution center, or the automatically chosen distribution center if none was specified.

addons

OrderingProductAddon[] - An array of addons that are included with the product.

availableAddons

OrderingProductAddon[] - An array of addons that are available for the product.

options

OrderingProductOption[] - The option values (e.g. paint color) selected for this product line. The available values for a product are listed on the products API — see OrderingProduct.options.

attributes

OrderingProductAttribute[] - The catalog attributes of this product that are relevant to ordering it, as { name, value } pairs — e.g. sheen or color. Which attributes a product carries varies by product; empty when it has none.

availableWarranties

OrderingProductWarranty[] - The extended-warranty products that can be purchased alongside this equipment line. Empty when no warranty coverage is available for the product.

selectedWarranty

OrderingProductWarranty | null - The warranty attached to this product on this request — either from an explicit warrantySku on the product input or the auto-pick when the per-product applyWarrantyCoverage is true. null when no warranty is attached to this line. At most one warranty per product.

OrderingProductAvailabilityStatus

enum OrderingProductAvailabilityStatus {
  IN_STOCK
  OUT_OF_STOCK
  SUBSTITUTION_ONLY
  UNAVAILABLE
  UNKNOWN
}

IN_STOCK

The product is in stock and available for ordering.

OUT_OF_STOCK

The product is currently out of stock.

SUBSTITUTION_ONLY

The product is only available as a substitution.

UNAVAILABLE

The product is unavailable for ordering.

UNKNOWN

The availability status is unknown, typically because no address was provided.

OrderingProductOption

type OrderingProductOption {
  key: String!
  value: String!
  name: String!
  title: String! @deprecated(reason: "Use name instead.")
  hex: String
}

The same type lists the available option values on the products API — see OrderingProduct.options. Here it carries the values selected for this product line.

key

string - The option identifier (e.g. "ppg-paint-color").

value

string - The selected value identifier (e.g. the PPG color code "PPG1105-3").

name

string - The human readable name of the value (e.g. the paint color name “Delicate White”).

title (deprecated)

string - Deprecated. Use name instead.

hex

string | null - The CSS hex color (#RRGGBB) of this value, for values that represent a color (e.g. a paint color). Will be null when the value has no color representation.

OrderingProductAddon

type OrderingProductAddon {
  id: ID!
  title: String!
  priceCents: Int!
  products: [OrderingProductAddonProduct!]!
}

id

string - Sibi identifier for the addon.

title

string - The human readable name of the addon.

priceCents

number - The price of the addon in cents.

products

OrderingProductAddonProduct - The individual products that are included with each addon. These are the skus that the distributor will reference on their invoices.

OrderingProductAddonProduct

type OrderingProductAddonProduct {
  sku: String!
  title: String!
  category: String!
  priceCents: Int!
}

sku

string - The sku that the distributor will reference on their invoices. For addons within the GE shop, these skus will generally have the format of MXXX where XXX is numeric.

title

string - The human readable name of the product.

category

string - The broad category this product falls into.

priceCents

number - The price of the product in cents.