Skip to main content

ProductMetrics

Metrics for a product including msrp min/max, price min/max, and discount metrics

type ProductMetrics {
countOfVariants: Int!
demandHqId: ID!
discountMaximum: Float!
discountMaximumInStock: Float
discountMinimum: Float!
discountMinimumInStock: Float
discountPercentageMaximum: Float!
discountPercentageMaximumInStock: Float
discountPercentageMinimum: Float!
discountPercentageMinimumInStock: Float
inventoryStatus: InventoryStatus!
msrpMaximum: Float!
msrpMaximumInStock: Float
msrpMinimum: Float!
msrpMinimumInStock: Float
priceMaximum: Float!
priceMaximumInStock: Float
priceMinimum: Float!
priceMinimumInStock: Float
productId: ID!
standardizedColors: [VariantStandardizedColor!]!
standardizedColorsInStock: [VariantStandardizedColor!]!
updatedAt: String!
}

Fields

ProductMetrics.countOfVariants ● Int! non-null scalar

This number is mostly useful in tallying other numbers, averages, etc.

ProductMetrics.demandHqId ● ID! non-null scalar

ProductMetrics.discountMaximum ● Float! non-null scalar

The maximum discount for all of the variants

ProductMetrics.discountMaximumInStock ● Float scalar

The maximum discount for all in stock variants (null if no variants are in stock)

ProductMetrics.discountMinimum ● Float! non-null scalar

The minimum discount for all of the variants

ProductMetrics.discountMinimumInStock ● Float scalar

The minimum discount for all in stock variants (null if no variants are in stock)

ProductMetrics.discountPercentageMaximum ● Float! non-null scalar

The maximum discount percentage for all of the variants

ProductMetrics.discountPercentageMaximumInStock ● Float scalar

The maximum discount percentage for all in stock variants (null if no variants are in stock)

ProductMetrics.discountPercentageMinimum ● Float! non-null scalar

The minimum discount percentage for all of the variants

ProductMetrics.discountPercentageMinimumInStock ● Float scalar

The minimum discount percentage for all in stock variants (null if no variants are in stock)

ProductMetrics.inventoryStatus ● InventoryStatus! non-null enum

In Stock if any Variant inventoryStatus is In Stock

ProductMetrics.msrpMaximum ● Float! non-null scalar

The maximum MSRP from all of the variants

ProductMetrics.msrpMaximumInStock ● Float scalar

The maximum MSRP from all in stock variants (null if no variants are in stock)

ProductMetrics.msrpMinimum ● Float! non-null scalar

The minimum MSRP from all of the variants

ProductMetrics.msrpMinimumInStock ● Float scalar

The minimum MSRP from all in stock variants (null if no variants are in stock)

ProductMetrics.priceMaximum ● Float! non-null scalar

The maximum price from all of the variants

ProductMetrics.priceMaximumInStock ● Float scalar

The maximum price from all in stock variants (null if no variants are in stock)

ProductMetrics.priceMinimum ● Float! non-null scalar

The minimum price from all of the variants

ProductMetrics.priceMinimumInStock ● Float scalar

The minimum price from all in stock variants (null if no variants are in stock)

ProductMetrics.productId ● ID! non-null scalar

Id of the associated Product

ProductMetrics.standardizedColors ● [VariantStandardizedColor!]! non-null enum

All of the variants standardizedColors

ProductMetrics.standardizedColorsInStock ● [VariantStandardizedColor!]! non-null enum

The standardizedColors of only in stock variants

ProductMetrics.updatedAt ● String! non-null scalar

Returned by

productMetrics query ● productMetricses query

Member of

Product object