Data Tables
Product Table
Data Tables
Product Table
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.| Name | Required? | Type | Description | Example |
|---|---|---|---|---|
| Identifiers | ||||
| sku_primary | required | string | Must 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_secondary | optional | string | Secondary sku value. Does not need to be unique | "sku_1" |
| barcode | optional | string | 12345678905 | |
| barcode_type | optional | string | E.g asin/ upc/ gtin | "ups" |
| Price | ||||
| list_price | required | float | 14.99 | |
| member_price | optional | float | 12.99 | |
| subscriber_price | optional | float | 12.99 | |
| discounted_price | optional | float | 14.49 | |
| Costs | ||||
| cost | required | float | The unit cost to be used when calculating product margins in the dashboard and for forecasting. | 7.10 |
| custom_costs | optional | ZodJsonObject | {} | |
| Details | ||||
| name | required | string | "Blue T-Shirt" | |
| description | optional | string | "The best blue t-shirt." | |
| sku_brand | optional | string | Brand of product being sold. | "Gap" |
| price_zone | optional | string | Price zone identifier. A price zone defines the region where the primary sku is sold. | "zone_1" |
| category | required | string[] | Sku category | ["Men", "Shirts"] |
| attributes | optional | ProductAttributes | Product attributes - see below for schema definition | ProductAttributesSchema |
| tags | optional | string[] | Tags for this sku, which will be applied as imported product tags in the dashboard. | ["Basics", "Snacks"] |
| is_active | required | boolean | Note that we do not suggest price changes or track price changes for inactive SKUs. | true |
| price_pushing_id | optional | json | The sku identifier we will use to push price changes live on your behalf. | |
| Product Attributes | ||||
| collection | optional | string | ||
| color | optional | string | "red" | |
| country_of_origin | optional | string | "USA" | |
| custom_attributes | optional | ZodJsonObject | Any other product fields that are not in our schema, but you want to include? | {} |
| department | optional | string | ||
| discontinued | optional | boolean | false | |
| expiration_date | optional | ZodDateInput | "2023-12-31" | |
| finish | optional | string | ||
| fit | optional | string | "regular" | |
| gender | optional | string | "unisex" | |
| height | optional | string | "6ft" | |
| product_image | optional | string | URL link to image for product. | "exampleimagelink.com" |
| product_url | optional | string | Link to product page. | "example.com/sku1" |
| ingredients | optional | string | "sugar, salt" | |
| is_free_shipping | optional | boolean | true | |
| kvi | optional | string | high_kvi | |
| lead_time | optional | string | "2 days" | |
| material | optional | string | "cotton" | |
| model_number | optional | string | "XYZ123" | |
| nutritional_info | optional | string | "Calories: 200" | |
| packaging | optional | string | "box" | |
| producer_name | optional | string | "Company A" | |
| producer_type | optional | string | "OEM" | |
| product_brand_name | optional | string | ||
| product_type | optional | string | "Electronics" | |
| quantity | optional | string | "10" | |
| rating | optional | string | "4.5" | |
| release_date | optional | ZodDateInput | "2023-01-01" | |
| search_keywords | optional | string | "keyword1, keyword2" | |
| secondary_list_price | optional | string | ||
| secondary_quantity | optional | string | ||
| secondary_unit_of_measurement | optional | string | ||
| shipping_dimensions | optional | string | "30x20x15" | |
| shipping_weight | optional | string | "5kg" | |
| shipping_weight_unit | optional | string | "kg" | |
| size | optional | string | "L" | |
| size_description | optional | string | "Large" | |
| size_unit | optional | string | "cm" | |
| store_id | optional | string | Id of the store where the product is sold | "store_1" |
| sub_category | optional | string[] | Sku subcategories | ["T-shirt", "Casual"] |
| unit_of_measurement | optional | string | "liters" | |
| variant_id | optional | string | "var123" | |
| version | optional | string | "1.0" | |
| volume | optional | string | "100ml" | |
| volume_unit | optional | string | "ml" | |
| warranty | optional | string | "1 year" | |
| weight | optional | string | "500g" | |
| weight_unit | optional | string | "g" | |
| width | optional | string | "10cm" |