The Label Insight Base Schema is the default schema for all product data delivered via the Products API or to Label Insight's hosted SFTP.
Base Schema along with the associated data type for each field.
{
"upc": "String",
"brand": "String",
"subBrand": "String",
"productTitle": "String",
"productSize": "String",
"unitsPerPack": "String",
"variant": "String",
"manufacturer": "String",
"distributor": "String",
"importer": "String",
"categorization": {
"productType": "String",
"aisle": "String",
"shelf": "String",
"category": "String"
},
"sizes": [
{
"netWeight": {
"value": "String",
"uom": "String"
}
}
],
"gtinFormats": {
"gtin12": "String",
"gtin14": "String"
},
"ingredients": {
"declaration": "String",
"symbols": [
"String"
]
},
"warning": "String",
"factPanel": {
"nutrition": {
"insignificantAmountStatement": "String",
"labelStyle": "String",
"serving": {
"description": "String",
"numberPerPack": "String",
"size": "String",
"sizeUom": "String",
"size2": "String",
"sizeUom2": "String"
},
"columns": [
{
"name": "String",
"nutrients": [
{
"name": "String",
"valueOperator": "String",
"value": "Double",
"uom": "String",
"percentDvOperator": "String",
"percentDv": "Double"
}
]
}
]
},
"supplement": {
"insignificantAmountStatement": "String",
"serving": {
"description": "String",
"numberPerPack": "String",
"size": "String",
"sizeUom": "String",
"size2": "String",
"sizeUom2": "String"
},
"columns": [
{
"name": "String",
"supplements": [
{
"name": "String",
"valueOperator": "String",
"value": "Double",
"uom": "Double",
"percentDvOperator": "String",
"percentDv": "Double"
}
]
}
]
},
"drug": {
"activeIngredients": [
{
"name": "String",
"amount": "Double",
"uom": "String",
"purpose": "String"
}
],
"inEach": "",
"warnings": [
"String"
],
"otherInformation": [
"String"
],
"uses": [
"String"
],
"questions": [
"String"
],
"directions": [
"String"
]
},
"guaranteedAnalysis": {
"columns": [
{
"name": "String",
"nutrientsAsFed": [
{
"name": "String",
"valueOperator": "String",
"value": "Double",
"uom": "Double",
"percentOperator": "String",
"percent": "Double"
}
]
}
],
"calorieContent": [
{
"value": "Double",
"valueUom": "String",
"perUom": "String"
},
{
"value": 313.0,
"valueUom": "kCal",
"perUom": "kg"
}
]
}
},
"alcohol": {
"abv": "Double",
"ibu": "Integer"
},
"attributes": [
{
"name": "String"
}
],
"lastUpdatedTimestamp": "IsoTimestamp"
}
Base Schema populated with sample product data.
{
"upc": "12345678912",
"brand": "Tasty Fudge Bars",
"subBrand": "Flavorful Tasty Fudge Bars",
"productTitle": "Fudge Bars",
"productSize": "3 FL OZ",
"unitsPerPack": "About 3",
"variant": "Fudge",
"manufacturer": "Classic Manufacturing",
"distributor": "Classic Distributor",
"importer": "Classic Importer",
"categorization": {
"productType": "Food",
"aisle": "Frozen Food",
"shelf": "Ice Cream & Frozen Yogurt",
"category": "Ice Cream - Fudge Bars"
},
"sizes": [
{
"netWeight": {
"value": "3",
"uom": "FL OZ"
}
}
],
"gtinFormats": {
"gtin12": "1234567891234",
"gtin14": "12345678912"
},
"ingredients": {
"declaration": "SKIM MILK, CONDENSED SKIM MILK, POLYDEXTROSE, WHOLE MILK, SORBITOL*, COCOA (PROCESSED WITH ALKALI), MILK PROTEIN CONCENTRATE, CONTAINS 2% OR LESS OF: GLYCERIN, STABILIZER BLEND (MALTODEXTRIN, WHEY POWDER, CELLULOSE GUM, LOCUST BEAN GUM, MONO- AND DIGLYCERIDES, GUAR GUM, CORN STARCH, CARRAGEENAN, POLYSORBATE 80), WHEY PROTEIN CONCENTRATE, ASPARTAME, VITAMIN A PALMITATE, NATURAL FLAVOR.",
"symbols": [
"* Sensitive individuals may experience a laxative effect from excessive consumption of these ingredients."
]
},
"warning": "CONTAINS: MILK. PHENYLKETONEURICS: CONTAINS PHENYLALANINE.",
"factPanel": {
"nutrition": {
"insignificantAmountStatement": "Not a significant source of trans fat and dietary fiber.",
"labelStyle": "NLEA_2018",
"serving": {
"description": "1 bar",
"numberPerPack": "1",
"size": "2.6",
"sizeUom": "oz",
"size2": "76",
"sizeUom2": "g"
},
"columns": [
{
"name": "Amount/serving",
"nutrients": [
{
"name": "Calories",
"valueOperator": "=",
"value": 90.0,
"uom": "Cal",
"percentDvOperator": null,
"percentDv": null
},
{
"name": "Total Fat",
"valueOperator": "=",
"value": 1.0,
"uom": "g",
"percentDvOperator": "=",
"percentDv": 1.0
},
{
"name": "Vitamin D",
"valueOperator": "=",
"value": 0.0,
"uom": "mcg",
"percentDvOperator": "=",
"percentDv": 0.0
},
{
"name": "Iron",
"valueOperator": "=",
"value": 1.2,
"uom": "mg",
"percentDvOperator": "=",
"percentDv": 6.0
}
]
}
]
},
"supplement": null,
"drug": null,
“guaranteedAnalysis”: null
},
"attributes": [
{
"name": "No Added Sugar"
},
{
"name": "Good Source of Protein"
},
{
"name": "Low Fat"
}
],
"alcohol": null,
"lastUpdatedTimestamp": "2021-01-23T18:43:42.468Z"
}
Field Documentation
| Field Name | Description | Example |
|---|---|---|
| upc | This is the verbatim on package barcode captured for this given product. This field is NOT normalized to adhere to a certain GS1 Code and is strictly transcribed from the packaging image. | 012345678900 |
| brand | The brand of the product as listed on package. | Best Brand |
| subBrand | For the given Brand captured, which product line or subset of a Brand this product falls into. Oftentimes, but not always, the Sub Brand is a trademark. | Organics |
| productTitle | This is the identity of the product or the main product description associated with the product label. This field consists of the observed statement of identity, including Flavor when applicable. | Strawberry Whole Milk Yogurt |
| productSize | The unparsed net weight content statement as it appears on package. | 6-4 OZ (113g) CUPS NET WT 24 OZ (1.5 LB) 680g |
| unitsPerPack | If a product has both inner and outer packaging displayed on the front of pack - this field represents the number of individual units per package as listed on the label. | 6 |
| variant | Variant is the flavor, fragrance, or color associated with this product. For food and non-food products this is a further breakdown of a subset within a product line. | Strawberry |
| manufacturer | This field is the manufacturer listed within the contact information on package. It is limited to the company or brand name listed after a phrase such as, “Manufactured By” but does not include the actual phrase “Manufactured By”. This also does not include the contact address, phone number, email address, or social media handles listed. | Best Foods, LLC |
| distributor | This field is the distributor listed within the contact information on package. It is limited to the company or brand name listed after a phrase such as, “Distributed By” but does not include the actual phrase “Distributed By”. This also does not include the contact address, phone number, email address, or social media handles listed. | Best Foods |
| importer | This field is the importer listed within the contact information on package. It is limited to the company or brand name listed after a phrase such as, “Imported By” but does not include the actual phrase “Imported By”. This also does not include the contact address, phone number, email address, or social media handles listed. | Best Foods |
| categorization | ||
| productType | This is the broadest level of Label Insight's categorization. The product types are based on regulations and retailer structure. | Food |
| aisle | This is the second level of Label Insight's categorization. It consists of broad grouping within a particular Product Type. These are called Aisles because they loosely reflect the organization of most US supermarket stores. | DAIRY |
| shelf | Shelves are the third level of Label Insight's categorization. Shelves make up smaller grouping within a particular Aisle. | Yogurt |
| category | Product Category is the most detailed grouping of products. To date, Label Insight has over 2,600 distinct product categories across all Product Types. A product category can only be associated with one distinct Shelf, Aisle and Product Type. | Yogurt - Classic |
| sizes | ||
| netWeight | ||
| value | The parsed total net weight value of contents as it appears on package | 3 |
| uom | The parsed net weight unit of measure (UoM) as it appears on package | FL OZ |
| gtinFormats | ||
| gtin12 | 12-digit with rear check digit | 012345678900 |
| gtin14 | 14-digit product identifier which is comprised of three components: (1) One digit representing the Indicator Digit to indicate packaging level; (2) Twelve digits containing the GS1 US-Issued GS1 Company Prefix and the Item Reference which is designated internally by the brand/company; (3) One digit representing the check digit | 00123456789000 |
| ingredients | ||
| declaration | This field is the ingredient declaration, verbatim, as it is represented on package. | CULTURED PASTEURIZED ORGANIC WHOLE MILK, ORGANIC STRAWBERRIES, ORGANIC CANE SUGAR, PECTIN, CARROT JUICE CONCENTRATE (COLOR), ORGANIC LOCUST BEAN GUM, NATURAL FLAVOR, ORGANIC FRUIT AND VEGETABLE JUICE CONCENTRATES FOR COLOR (CARROT, APPLE), VITAMIN D3. CONTAINS LIVE AND ACTIVE CULTURES: S. THERMOPHILUS. L BULGARICUS. L ACIDOPHILUS, BIFIDUS, L PARACASEI, L RHAMNOSUS. |
| symbols | The capture of any symbol (e.g. asterisk) and accompanying definition associated with an ingredient or set of ingredient to provide further detail about the product. | * Organic |
| warning | The allergen warning statement as present on the product's packaging, typically in the form of a "contains:" or "may contain" statement. Also includes other allergen advisory statements such as "made in a shared facility..." or "made on shared equipment..." when present on package. | CONTAINS MILK INGREDIENTS. |
| factPanel | ||
| nutrition | ||
| insignificantAmountStatement | Nutrients listed as "not a significant source of" at the bottom of the nutrition facts panel on-package. | "Not a significant source of trans fat, dietary fiber, added sugars and iron." |
| labelStyle | This field indicates whether a product has updated their nutrition labeling to comply with the new nutrition facts panel style outlined in the 2016 FDA final rule: "Food Labeling: Revision of the Nutrition and Supplement Facts Labels" | NLEA_2018 |
| serving | ||
| description | The Serve Description field is primarily used for capture of non-standard units of measure. This field also can contain descriptors for Serving Size 1 & 2. | 1 tub |
| numberPerPack | This is the number of servings per package or container. | 1 |
| size | The serving size of the product listed first as present on the nutrition facts panel. This is only the value. | 113 |
| sizeUom | The unit of measure (UOM) associated to the serving size of the product listed first as present on the nutrition facts panel. | g |
| size 2 | The serving size of the product listed second as present on the nutrition facts panel. This is only the value. | 4 |
| size2Uom | The unit of measure (UOM) associated to the serving size of the product listed second as present on the nutrition facts panel. | oz |
| columns | ||
| name | The name of the column as it appears on the nutrition facts panel. | Amount per Serving |
| nutrients | ||
| name | The standardized nutrient name for the nutrient that appears on the nutrient facts panel. | Total Fat |
| valueOperator | The symbol ("=", "<", or ">") associated with the nutrient on the nutrition facts panel. | = |
| value | The value of the nutrient as listed on the nutrition facts panel. | 0.0 |
| uom | The unit of measure (UOM) of the nutrient as listed on the nutrition facts panel. | g |
| percentDvOperator | The symbol ("=", "<", or ">") associated with the nutrient DVP on the nutrition facts panel. | = |
| percentDv | The DVP of the nutrient as listed on the nutrition facts panel. | 0 |
| supplement | ||
| serving | ||
| description | The Serve Description field is primarily used for capture of non-standard units of measure. This field also can contain descriptors for Serving Size 1 & 2. | 1 tea bag (Makes 8 fl oz) |
| numberPerPack | This is the number of servings per package or container. | 12 |
| size | The serving size of the product listed first as present on the nutrition facts panel. This is only the value. | 8 |
| sizeUom | The unit of measure (UOM) associated to the serving size of the product listed first as present on the nutrition facts panel. | fl oz |
| size2 | The serving size of the product listed second as present on the nutrition facts panel. This is only the value. | 80 |
| size2UOM | The unit of measure (UOM) associated to the serving size of the product listed second as present on the nutrition facts panel. | g |
| columns | ||
| name | The name of the column as it appears on the supplement facts panel. | As Prepared |
| supplements | ||
| name | The standardized nutrient name for the nutrient that appears on the nutrient facts panel. | Organic Ginger Root |
| valueOperator | The symbol ("=", "<", or ">") associated with the nutrient on the nutrition facts panel. | = |
| value | The value of the nutrient as listed on the supplements facts panel. | 100 |
| uom | The unit of measure (UOM) of the nutrient as listed on the nutrition facts panel. | mg |
| percentDvOperator | The symbol ("=", "<", or ">") associated with the nutrient DVP on the supplements facts panel. | 2 |
| percentDv | The DVP of the nutrient as listed on the supplements facts panel. | % |
| drug | ||
| activeIngredients | ||
| name | The name of the active as it appears on the drug fact panel. | FAMOTIDINE |
| amount | The amount / strength of the active ingredient as it appears on the drug fact panel. | 20.0 |
| uom | The UOM of the active ingredient's strength as it appears on the drug fact panel. | mg |
| purpose | The purpose of the active ingredient as it appears on the drug fact panel. | Acid Reducer |
| inEach | The amount of the product which the active ingredient strength is based on, this is an optional field and will not appear on every product. | Tablet |
| warnings | The list of warnings present as they appear on the drug fact panel. | FOR EXTERNAL USE ONLY |
| otherInformation | The list of other information present as they appear on the drug fact panel. | TEMPORARILY BLURRED VISION IS TYPICAL UPON APPLICATION |
| uses | The list of uses present as they appear on the drug fact panel. | TEMPORARILY RELIEF OF BURNING AND IRRITATION DUE TO DRYNESS OF THE EYE |
| questions | The list of questions present as they appear on the drug fact panel. | CALL 1-800-000-0000 |
| directions | The list of directions present as they appear on the drug fact panel. | REMOVE CONTACT LENSES BEFORE APPLYING DROPS |
| guaranteedAnalysis | ||
| columns | ||
| nutrientsAsFed | ||
| name | The name of the nutrient as it appears on the guaranteed analysis panel. | Vitamin E (Min) |
| valueOperator | The symbol ("=", "<", or ">") associated with the nutrient on the guaranteed analysis panel. | = |
| value | The value associated with the nutrient on the guaranteed analysis panel. | 100.0 |
| uom | The unit of measure associated with the nutrient on the guaranteed analysis panel. | IU/kg |
| percentOperator | The symbol ("=", "<", or ">") associated with the nutrient on the guaranteed analysis panel. | = |
| percent | The percent associated with the nutrient on the guaranteed analysis panel. | 82 |
| calorieContent | ||
| value | 847.0 | |
| valueUom | kcal | |
| perUom | kg | |
| alcohol | ||
| abv | The % ABV as it appears on the product's label. | 5.9 |
| ibu | The IBU number as it appears on the product's label. | 55 |
| attributes | ||
| name | The name of the attribute licensed, only appears when the product qualifies for the associated attribute. | Organic |
| lastUpdatedTimestamp | The last date which the product data licensed by the Customer in their configuration has experienced an update or change. Please note, Label Insight's update every product weekly and this is not a field that can be leveraged to detect data deltas. | 2021-02-27T04:51:26.948Z |
Custom Schema
Interested in a custom data schema? See Custom Schema