Skip to main content

PublicVariant

This is the child entity to a Product, and is a variation, such as a color, size, etc.

type PublicVariant {
barcode: String
casePack: Int
contentItemIds: [ID]
contentItems: [PublicProductContentItem]
deliveryMethod: VariantDeliveryMethod
demandHqId: ID!
manufacturer: String
mapPrice: Float
mpn: String
msrp: Float
optionValues: [String!]!
position: Int
price: Float
product: PublicProduct
productId: ID!
shippingDimensions: VariantShippingDimensions
sku: String
standardizedColor: VariantStandardizedColor
taxCode: String
title: String!
variantId: ID!
variantMetrics: PublicVariantMetrics
weight: VariantWeight
}

Fields​

PublicVariant.barcode ● String scalar​

UPC, ISBN, GTIN, etc.

PublicVariant.casePack ● Int scalar​

Quantity in one variant (i.e. 12-pack). Must be a positive integer.

PublicVariant.contentItemIds ● [ID] list scalar​

Associates contentItems with this variant

PublicVariant.contentItems ● [PublicProductContentItem] list object​

Get a list of productContentItems for the variant.

Requires productcontentitem/read permission on the DemandHq for the requesting identity.

PublicVariant.deliveryMethod ● VariantDeliveryMethod enum​

PublicVariant.demandHqId ● ID! non-null scalar​

PublicVariant.manufacturer ● String scalar​

Often same as vendor, but not always.

PublicVariant.mapPrice ● Float scalar​

Minimum Advertised Price. Must be a positive number.

PublicVariant.mpn ● String scalar​

Manufacturer Part Number

PublicVariant.msrp ● Float scalar​

Manufacturer's Suggested Retail Price. Must be a positive number.

PublicVariant.optionValues ● [String!]! non-null scalar​

An array of the option values that make up this variant. For example, a product with a color and size option would have two option values, one for each of the color and size options, i.e. ["Red", "Small"] Must have 1-3, and it should match the number of options in the product, but there is no validation to do so. Set this to "No Option" if you don't want to use options for this product and this is the only variant. See https://docs.buildresonance.com/concepts/products/#no-option-products for more info.

PublicVariant.position ● Int scalar​

Used to determine what order the content comes out in. Positive Integers are allowed, up to 9,999,999,999, and it does not have to be unique or sequential.

PublicVariant.price ● Float scalar​

Price for the defaultCurrency, can be any positive float number value.

PublicVariant.product ● PublicProduct object​

Get the product associated with the variant.

Requires the publicproduct/read scope.

PublicVariant.productId ● ID! non-null scalar​

PublicVariant.shippingDimensions ● VariantShippingDimensions object​

PublicVariant.sku ● String scalar​

Stock Keeping Unit

PublicVariant.standardizedColor ● VariantStandardizedColor enum​

PublicVariant.taxCode ● String scalar​

Sales Tax Related Code, can match your chosen sales tax provider

PublicVariant.title ● String! non-null scalar​

Get the title of this variant (combo of optionValues)

PublicVariant.variantId ● ID! non-null scalar​

PublicVariant.variantMetrics ● PublicVariantMetrics object​

Get variantMetrics for a Variant

Requires variant/read permission

PublicVariant.weight ● VariantWeight object​

Member of​

CartItem object ● CheckoutOrderItem object ● PublicProduct object ● PublicVariantConnection object ● PublicVariantEdge object ● SavedForLaterItem object