Minimum catalog requirements
The following columns are required for all products. If you do not provide data in the required columns, your products are not displayed on your storefront.
| Column | Data type | Description | Example |
|---|---|---|---|
| available | boolean | If an item is available for purchase, TRUE. If you remove a row from a Full Inventory and Delta file, the item remains available. If you remove a row from a Reinventory file, the item is marked as unavailable. To manage availability, you can add additional availability data. | True: 1, T, True, Y, Yes or False: 0, F, False, N, No |
| brand_name | text | The customer-facing product brand name (100 character limit). This is a static field that is only applied when you create a product. For products shared across retailers, this brand name is provided by the brand owner. | Dr. Pepper |
| cost_price_per_unit | float | The price per pound or per unit. This distinction is noted in the cost_unit column.Note: Pricing rules set can change the price. If selling in USA, provide the price in USD. If selling in Canada, provide the price in CAD. | 32.99 0.75 Note: For numbers less than 1, the price includes a zero before the decimal. |
| cost_unit | text | Indicates how a product is sold: by unit or by weight unit (each, lb, g, kg). Note: All par_weight items must use a cost_unit of either ‘lb’ or ‘kg’. For more information, see Additional dimensions. | ‘lb’, ‘kg’, or ‘each’ Example: Royal Gala Apples sold for $2.29/lb, weighing 0.38lbs each cost_price_per_unit = 2.29cost_unit = "lb"par_weight = '0.38'In the above example, customers are charged $0.87 per apple, because price of $2.29 / lb x 0.38 lbs = $0.87. |
| location_code | text | The store ID where this item is located. | 38, 1172 |
| lookup_code | text | The unique code that represents each of your products (such as PLU or UPC). For scannable barcodes, the code provided should be the code on the product label. | PLU examples: 4066 94066 UPC examples: 0008541410B142 005041244417B2 00012000015260 |
If you have a group of lookup_codes tied to a single product, add a retailer_reference_code. | |||
| Include a check digit on all UPCs to ensure we have a full UPC to translate to what we have in our system. This helps provide the most accurate information for this product. | |||
| IMPORTANT: Ensure that you provide the value as text and that the lookup code is not in scientific notation. | |||
| name | text | The name of the product on the storefront (100 character limit). This is a static field that is only required when creating the product for the first time. Items in Instagrocer’s Universal Catalog can inherit a trusted product source, such as data from CPGs. This value is used as a method for matching PLU items to correct products and to create new products specific to a retailer. Do not use abbreviations. | Meat Beef Ground 90/10 Banana Ripe |
| retailer_reference_code | text | (Optional) The internal item code used by retailers to identify products or to group a series of lookup codes to the same product. | 185452 |
| size | integer | The numerical amount of a unit within the pack. To define the associated unit of measure, use the size_uom field.To define the number of units in a pack, use the unit_count field. Can also be ‘per lb’.Note: For alcoholic products and non-alcoholic beverages the size provided must be a volume measurement. | 12 For an 8-pack of 12 fl oz Pepsi: size = '12'size_uom = 'fl oz'unit_count = '8' |
| size_uom | text | Unit of measure for the amount within the pack (size). Default is ‘each’. Note: For alcoholic products and non-alcoholic beverages the size provided must be a volume measurement. | each oz, ounce, ounces lb, pound, pounds mL, milliliter L, liter g, gram, grams kg, kilogram, kilograms fl oz, fl. oz., fluid ounce, fluid ounces, in, ft, yd, inch, foot, yard sq ft mm, cm, m, millimeter, centimeter, meter, gal |
| unit_count | integer | The number of units in a pack item. This value is combined with size and size_uom columns to create a customer experience that identifies when multiple units are included in a pack. | For an 8-pack of 12 fl oz Pepsi:size = 12size_uom = 'fl oz'unit_count = '8' |
Last updated on