Skip to main content
An object representing a product in an order.
type OrderingOrderProduct {
  sku: String!
  quantity: Int!
  unitOfMeasure: String!
  quantityPerUnit: Float!
  baseUnitOfMeasure: String!
  name: String!
  subtitle: String
  imageUrl: String!
  priceCents: Int!
  availabilityStatus: OrderingProductAvailabilityStatus!
  addons: [OrderingProductAddon!]!
  availableAddons: [OrderingProductAddon!]!
  options: [OrderingProductOption!]!
}

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

number - The number of base units contained in each unit of measure.

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 of the product in cents.

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[] - An array of product options (e.g. color, size) selected for this 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!
  title: String!
  value: String!
}

key

string - The key identifying this option (e.g. “color”, “size”).

title

string - The human readable title of the option.

value

string - The selected value for this option.

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.