This table should include all products, product variants and unique identifier information. We use this as a source of truth for all skus in your store. Each product can contain an attributes field which is an object of additional product attributes.

Time Period: Current

Why do we need this? We use this information to aid in training our pricing models, implementing margin constraints and correctly calculating P&L metrics.

​
Schema

Unique Constraint: sku_primary.
NameRequired?TypeDescriptionExample
Identifiers
sku_primaryrequiredstringMust be unique (including by price zone). This is the sku identifier at the most granular at which you would want to manage pricing."sku_1_zone_12"
sku_secondaryoptionalstringSecondary sku value. Does not need to be unique"sku_1"
barcodeoptionalstring12345678905
barcode_typeoptionalstringE.g asin/ upc/ gtin"ups"
Price
list_pricerequiredfloat14.99
member_priceoptionalfloat12.99
subscriber_priceoptionalfloat12.99
discounted_priceoptionalfloat14.49
Costs
costrequiredfloatThe unit cost to be used when calculating product margins in the dashboard and for forecasting.7.10
custom_costsoptionalZodJsonObject{}
Details
namerequiredstring"Blue T-Shirt"
descriptionoptionalstring"The best blue t-shirt."
sku_brandoptionalstringBrand of product being sold."Gap"
price_zoneoptionalstringPrice zone identifier. A price zone defines the region where the primary sku is sold."zone_1"
categoryrequiredstring[]Sku category["Men", "Shirts"]
attributesoptionalProductAttributesProduct attributes - see below for schema definitionProductAttributesSchema
tagsoptionalstring[]Tags for this sku, which will be applied as imported product tags in the dashboard.["Basics", "Snacks"]
is_activerequiredbooleanNote that we do not suggest price changes or track price changes for inactive SKUs.true
price_pushing_idoptionaljsonThe sku identifier we will use to push price changes live on your behalf.
Product Attributes
countoptionalstring
count_unit_of_measurementoptionalstring
collectionoptionalstring
coloroptionalstring"red"
comparison_priceoptionalstringe.g a per ounce price
comparison_quantityoptionalstring
comparison_unit_of_measurementoptionalstring
country_of_originoptionalstring"USA"
custom_attributesoptionalZodJsonObjectAny other product fields that are not in our schema, but you want to include?{}
departmentoptionalstring
discontinuedoptionalbooleanfalse
expiration_dateoptionalZodDateInput"2023-12-31"
fitoptionalstring"regular"
genderoptionalstring"unisex"
heightoptionalstring"6ft"
kvioptionalstringhigh_kvi
materialoptionalstring"cotton"
product_imageoptionalstringURL link to image for product."exampleimagelink.com"
product_urloptionalstringLink to product page."example.com/sku1"
sold_byoptionalstringShould be either “COUNT” or “WEIGHT”"WEIGHT"
producer_nameoptionalstring"Company A"
producer_typeoptionalstring"OEM"
product_brand_nameoptionalstring
product_typeoptionalstring"Electronics"
ratingoptionalstring"4.5"
release_dateoptionalZodDateInput"2023-01-01"
search_keywordsoptionalstring"keyword1, keyword2"
store_idoptionalstringId of the store where the product is sold"store_1"
sub_categoryoptionalstring[]Sku subcategories["T-shirt", "Casual"]
versionoptionalstring"1.0"
weightoptionalstring"500g"
weight_unit_of_measurementoptionalstring"g"
widthoptionalstring"10cm"
Data TablesOrder Table