LabelAPI - Documentation

Getting Started

At the root of our API is the FoodEssentials Personalized Dietary Profile.  The profile powers your app to automatically adapt to the specific dietary requirements of each of your users. Use it to set which nutrients, additives, allergens, and ingredients are shown in your app. It also sets which of those properties is used to base personalized dietary recommendations on. You can find a detailed walk-through of how the profile works as well as our API's basics on our Getting Started Page. 

 

Documentation

Written Documentation 

Our Written Documentation page breaks down every method we have available in our API. It defines each component of each method and which are required or optional. The output of each method is also displayed so you see what to expect.  

 

Interactive Documentation

Our Interactive Documentation page allows you to try each of our methods with live data from the FoodEssentials database once you've registered and logged in without having to write any code. 

 

Live Demo

You can play with our in-house Mobile Demo Application.

 

API Status

Check API performance status

 

Need help?

We're around:   email | forum | @foodessentials 

 

 

Method Indexes

 

Session Methods Index
Method Call Description
Create Session createsession Use this to manage sessions and User ID's. You need a session id (sid) before trying any other end points to interact with the Food Essentials API. Use the "Create Session" method to create a new session id that you can then use for all other methods. (see FAQ: Sessions

 

Dietary Profile Methods Index
Method Call Description
Get Profile getprofile The FoodEssentials Personalized Dietary Profile is key and core to the API. All the product data that is returned via a call is customized in the profile. The Get Profile method gets the profile that has set what nutrients, additives, allergens, and ingredients you care about, so we can flag these products. It can be returned in XML or JSON format. It is updated (or initialized) with the Set Profile (setprofile) method. It has a default setting (shown below) so initialization is optional. There is also a detailed walk-through of the profile on our Getting Started page (also see FAQ: Profiles). This is NOT the same as a 'My List' which just stores products for a specific user. 
Set Profile setprofile This is used to initially set or to update the dietary profile. Use the Set Profile (setprofile) and Add My Ingredient (addmyingredient) methods to customize your profile. It must be sent in JSON format. There is a detailed walk-through of the profile on our Getting Started page (also see FAQ: Profiles).
Ingredient Search ingredientsearch A keyword search for any ingredient.
Add My Ingredient addmyingredient Adds an ingredient of interest to the user profile.
Remove My Ingredient removemyingredient Removes an ingredient from the user profile.
Show Ingredient showingredient Descriptive information about an ingredient.

 

Label Methods Index
Method Call Description
Search Products searchprods Search for products by keyword, including product type, product title, upc, or brand.
Product Score  productscore Personalized Product Score: this powerful feature returns a personalized product score between -100 to 100 based on a user's/app profile (setprofile). See also: Product Score
Label  label Delivers the allergen and additive properties and product details for a specific UPC.
Label Array labelarray Returns a sorted list of similar products similar to a given upc along with the details for each product. It is how you retrieve the nutritional information for products.

More specifically labelarray returns:
  • product name
  • description
  • brand
  • size
  • manufacturer
  • aisle
  • shelf
  • food category
  • serving size
  • serving size unit of measure
  • servings per container
  • ingredients
  • nutrients
  • additives and warnings
  • allergens and warnings
  • additional ingredients added to the personalized dietary profile by way of the addmyingredient method.
The Set Profile method (setprofile) is used to determined which nutrient, additive, allergen, and ingredient properties are returned for each product in the returned list (also see Showing Nutrients: How do I show a product’s nutritive data?). 
Label Summary label_summary Returns the product name, UPC, and URL. 
Get Allergen Additive getallergenadditive Gives a specific allergen or additive properties of a specific upc. (also see Allergen Status: Determining the allergen status of a product).
Get Property Description getpropdescription Gives a description of each of the nutrient, additive, allergen properties.

 

Feature Methods Index
Method Call Description
Get My List
getmylist
Use this to get the list of products for which this user has added to the their 'My List'. 'My List' is provided as a feature for users to create and save products to a shopping list.  This can be used either as an actual shopping list, or as a historic product list, or as any other incarnation of a product list that developers would like.
Add My List
addmylist Add products to 'My List'.
Remove My List removemylist Removes products from 'My List'.
Get Search Log getsearchlog
Returns the previous searches for this session ID.

 

Methods

back to top ↑

Create Session - createsession
Parameter Status Type Description Example
uid required string User ID (see FAQ: uid)   000e1100-e11b-11d1-a111-111111110000
devid required string Device ID (see FAQ: devid)   You can get it from android.provider.Settings.System.ANDROID_ID for Android Apps.
For iPhone, refer to this doc.
appid required string App ID (see FAQ: appid)  

[YOUR API KEY HERE]

f required string Output format as JSON or XML "json"
c optional string Callback
v required string Version "2.00"

Request URI

http://api.foodessentials.com/createsession?uid=ert&devid=ert&appid=ert&f=json&v=2.00&api_key=YOUR_API_KEY_HERE  

Response Body

{
 "session_id": "a8290b03-5dc5-4c9f-a84e-a7494f59ee46",
 "user_id": "ert",
 "app_id": "ert",
 "device_id": "ert",
 "validUser": "true",
 "version": "2.00",
 "retailer_id": 1
}

 

back to top ↑

Get Profile  - getprofile
Parameter Status Type Description
sid required string Session ID (see FAQ: Sessions)  
f required string Output format as JSON or XML

Request URI

http://api.foodessentials.com/getprofile?sid=6982c2b5-79ff-4d55-929c-b303a18d1e87&n=10&s=1&f=json&api_key=YOUR_API_KEY_HERE

Response Body

{
    "session_id": "6982c2b5-79ff-4d55-929c-b303a18d1e87",
    "nutrients": [
        {
            "name": "Calcium",
            "value": "false"
        },
        {
            "name": "Calories",
            "value": "true"
        },
        {
            "name": "Calories from Fat",
            "value": "false"
        },
        {
            "name": "Cholesterol",
            "value": "false"
        },
        {
            "name": "Dietary Fiber",
            "value": "true"
        },
        {
            "name": "Insoluble Fiber",
            "value": "false"
        },
        {
            "name": "Iron",
            "value": "false"
        },
        {
            "name": "Monounsaturated Fat",
            "value": "false"
        },
        {
            "name": "Other Carbohydrate",
            "value": "false"
        },
        {
            "name": "Polyunsaturated Fat",
            "value": "false"
        },
        {
            "name": "Potassium",
            "value": "false"
        },
        {
            "name": "Protein",
            "value": "false"
        },
        {
            "name": "Saturated Fat",
            "value": "false"
        },
        {
            "name": "Saturated Fat Calories",
            "value": "false"
        },
        {
            "name": "Sodium",
            "value": "true"
        },
        {
            "name": "Soluble Fiber",
            "value": "false"
        },
        {
            "name": "Sugar Alcohol",
            "value": "false"
        },
        {
            "name": "Sugars",
            "value": "false"
        },
        {
            "name": "Total Carbohydrate",
            "value": "false"
        },
        {
            "name": "Total Fat",
            "value": "true"
        },
        {
            "name": "Vitamin A",
            "value": "false"
        },
        {
            "name": "Vitamin C",
            "value": "false"
        }
    ],
    "allergens": [
        {
            "name": "Cereals",
            "value": "false"
        },
        {
            "name": "Corn",
            "value": "false"
        },
        {
            "name": "Egg",
            "value": "false"
        },
        {
            "name": "Fish",
            "value": "false"
        },
        {
            "name": "Gluten",
            "value": "true"
        },
        {
            "name": "Lactose",
            "value": "false"
        },
        {
            "name": "Milk",
            "value": "false"
        },
        {
            "name": "Peanuts",
            "value": "true"
        },
        {
            "name": "Sesame Seeds",
            "value": "false"
        },
        {
            "name": "Shellfish",
            "value": "false"
        },
        {
            "name": "Soybean",
            "value": "false"
        },
        {
            "name": "Sulfites",
            "value": "false"
        },
        {
            "name": "Tree Nuts",
            "value": "false"
        },
        {
            "name": "Wheat",
            "value": "false"
        }
    ],
    "additives": [
        {
            "name": "Acidity Regulator",
            "value": "false"
        },
        {
            "name": "Added Sugar",
            "value": "true"
        },
        {
            "name": "Anti-Caking Agents",
            "value": "false"
        },
        {
            "name": "Anti-Foaming Agent",
            "value": "false"
        },
        {
            "name": "Antioxidants",
            "value": "false"
        },
        {
            "name": "Bulking Agents",
            "value": "false"
        },
        {
            "name": "Colors",
            "value": "true"
        },
        {
            "name": "Emulsifiers",
            "value": "false"
        },
        {
            "name": "Enzyme",
            "value": "false"
        },
        {
            "name": "Firming Agent",
            "value": "false"
        },
        {
            "name": "Flavor Enhancer",
            "value": "false"
        },
        {
            "name": "Flour Treating Agent",
            "value": "false"
        },
        {
            "name": "Food Acids",
            "value": "false"
        },
        {
            "name": "Gelling Agents",
            "value": "false"
        },
        {
            "name": "Glazing Agent",
            "value": "false"
        },
        {
            "name": "Humectants",
            "value": "false"
        },
        {
            "name": "Leavening Agent",
            "value": "false"
        },
        {
            "name": "Mineral Salt",
            "value": "false"
        },
        {
            "name": "Preservatives",
            "value": "true"
        },
        {
            "name": "Propellant",
            "value": "false"
        },
        {
            "name": "Raising Agents",
            "value": "false"
        },
        {
            "name": "Sequestrant",
            "value": "false"
        },
        {
            "name": "Stabilizers",
            "value": "false"
        },
        {
            "name": "Sweeteners",
            "value": "true"
        },
        {
            "name": "Thickeners",
            "value": "false"
        },
        {
            "name": "Vegetable Gum",
            "value": "false"
        }
    ],
    "myingredients": [
        {
            "name": "High Fructose Corn Syrup",
            "ingredientid": 137,
            "sameas": 137,
            "value": "true"
        },
        {
            "name": "Aspartame",
            "ingredientid": 5901,
            "sameas": 5901,
            "value": "true"
        }
    ],
    "mysort": [
        {
            "sort_variable": "Calories",
            "sort_order": 1,
            "variable_type": 1
        }
    ]
}

 

back to top ↑

Set Profile  - setprofile
Parameter Status Type Description
json required string Json document that describes a profile.

Request URI

http://api.foodessentials.com/setprofile?api_key=YOUR_API_KEY_HERE

Response Body

{"result":"success"}

 

back to top ↑

Ingredient Search  - ingredientsearch
Parameter Status Type Description
q required string search term(s)/query
sid required string Session ID (see FAQ: Sessions
n required integer number of results to return
s required integer start number (offset)
f required string Output format as JSON or XML

Request URI

http://api.foodessentials.com/ingredientsearch?q=msg&sid=6982c2b5-79ff-4d55-929c-b303a18d1e87&n=10&s=1&f=json&api_key=YOUR_API_KEY_HERE

Response Body

{
    "numFound": 40,
    "session_id": "6982c2b5-79ff-4d55-929c-b303a18d1e87",
    "resultSize": 10,
    "arrayIngredients": [
        {
            "ingredient_id": 117251,
            "ingredient_name": "Alaa Salt and Does Not Contain Any MSG"
        },
        {
            "ingredient_id": 144155,
            "ingredient_name": "All Natural No Additives or Preservatives No MSG"
        },
        {
            "ingredient_id": 167159,
            "ingredient_name": "Contains Naturally Occurring MSG"
        },
        {
            "ingredient_id": 163225,
            "ingredient_name": "Contains no MSG"
        },
        {
            "ingredient_id": 150527,
            "ingredient_name": "Does Not Contain MSG"
        },
        {
            "ingredient_id": 146561,
            "ingredient_name": "Does not contain: MSG"
        },
        {
            "ingredient_id": 10571,
            "ingredient_name": "Flavor Enhancer (MSG)"
        },
        {
            "ingredient_id": 4301,
            "ingredient_name": "Flavour Enhancer (MSG)"
        },
        {
            "ingredient_id": 120029,
            "ingredient_name": "Hydrolyzed Protein (No MSG Added)"
        },
        {
            "ingredient_id": 49751,
            "ingredient_name": "Hydrolyzed Vegetable Protein (No Added MSG)"
        }
    ]
}

 

back to top ↑

Add My Ingredient  - addmyingredient
Parameter Status Type Description
sid required string Session ID (see FAQ: Sessions
id required string Ingredient ID
f required string Output format as JSON or XML

Request URI

http://api.foodessentials.com/admyingredient?input=flax&sid=6982c2b5-79ff-4d55-929c-b303a18d1e87&id=73719&f=json&api_key=YOUR_API_KEY_HERE

Response Body

{
    "sid": "6982c2b5-79ff-4d55-929c-b303a18d1e87",
    "result": "success"
}

 

back to top ↑

Remove My Ingredient  - removemyingredient
Parameter Status Type Description
sid required string Session ID (see FAQ: Sessions
id required string Ingredient ID
f required string Output format as JSON or XML

Request URI

http://api.foodessentials.com/removemyingredient?input=flax&sid=6982c2b5-79ff-4d55-929c-b303a18d1e87&id=73719&f=json&api_key=YOUR_API_KEY_HERE

Response Body

{
    "sid": "6982c2b5-79ff-4d55-929c-b303a18d1e87",
    "result": "success"
}

 

back to top ↑

Show Ingredient  - showingredient
Parameter Status Type Description
input required string search term(s)/query
sid required string Session ID (see FAQ: Sessions
id required integer Ingredient ID
f required string Output format as JSON or XML

Request URI

http://api.foodessentials.com/showingredient?input=msg&sid=6982c2b5-79ff-4d55-929c-b303a18d1e87&id=10571&f=json&api_key=YOUR_API_KEY_HERE

Response Body

{
    "ingredientid": 10571,
    "name": "Flavor Enhancer (MSG)",
    "sameasingredients": [
        {
            "ingredientid": 7613,
            "name": "Added MSG"
        },
        {
            "ingredientid": 55383,
            "name": "E621"
        },
        {
            "ingredientid": 10371,
            "name": "Flavor (E621)"
        },
        {
            "ingredientid": 10213,
            "name": "Flavor Enhancer (621)"
        },
        {
            "ingredientid": 10329,
            "name": "Flavor Enhancer (E621)"
        },
        {
            "ingredientid": 10445,
            "name": "Flavor Enhancer (Monosodium Glutamate)"
        },
        {
            "ingredientid": 52243,
            "name": "Flavor Enhancer (Sodium Monoglutamate)"
        },
        {
            "ingredientid": 10449,
            "name": "Flavor Enhancer [621]"
        },
        {
            "ingredientid": 64051,
            "name": "Flavor Enhancer-Monosodium Glutamate"
        },
        {
            "ingredientid": 10503,
            "name": "Flavor Enhancer: Monosodium Glutamate"
        },
        {
            "ingredientid": 64057,
            "name": "Flavor Enhancers (Monosodium Glutamate)"
        },
        {
            "ingredientid": 64059,
            "name": "Flavor Intensifier: Monosodium Glutamate"
        },
        {
            "ingredientid": 2303,
            "name": "Flavour (E621)"
        },
        {
            "ingredientid": 427,
            "name": "Flavour Enhancer (621)"
        },
        {
            "ingredientid": 1659,
            "name": "Flavour Enhancer (E621)"
        },
        {
            "ingredientid": 3149,
            "name": "Flavour Enhancer (Monosodium Glutamate)"
        },
        {
            "ingredientid": 4301,
            "name": "Flavour Enhancer (MSG)"
        },
        {
            "ingredientid": 64061,
            "name": "Flavour Enhancer Monosodium Glutamate"
        },
        {
            "ingredientid": 3190,
            "name": "Flavour Enhancer [621]"
        },
        {
            "ingredientid": 3605,
            "name": "Flavour Enhancer: Monosodium Glutamate"
        },
        {
            "ingredientid": 50131,
            "name": "Flavour Enhancers (Monosodium Glutamate)"
        },
        {
            "ingredientid": 63083,
            "name": "Flavour Intensifier Monosodium Glutamate"
        },
        {
            "ingredientid": 31571,
            "name": "M.S.G"
        },
        {
            "ingredientid": 57911,
            "name": "Mono - Sodium Glutamate"
        },
        {
            "ingredientid": 57781,
            "name": "Mono Sodium Glutamate"
        },
        {
            "ingredientid": 31411,
            "name": "Mono-Sodium Glutamate"
        },
        {
            "ingredientid": 3154,
            "name": "Monosodium Glutamate"
        },
        {
            "ingredientid": 10197,
            "name": "Monosodium Glutamate (A Flavor Enhancer)"
        },
        {
            "ingredientid": 62297,
            "name": "Monosodium Glutamate (Flavor Enhanced)"
        },
        {
            "ingredientid": 62295,
            "name": "Monosodium Glutamate (Flavor Enhancer from Natural Source)"
        },
        {
            "ingredientid": 9959,
            "name": "Monosodium Glutamate (Flavor Enhancer)"
        },
        {
            "ingredientid": 27839,
            "name": "Monosodium Glutamate (MSG)"
        },
        {
            "ingredientid": 28923,
            "name": "Monosodium Glutamate (Natural Flavor Enhancer)"
        },
        {
            "ingredientid": 39789,
            "name": "Monosodium Glutamate (Preservative)"
        },
        {
            "ingredientid": 57925,
            "name": "Monosodium Glutamate (to Enhance Flavor)"
        },
        {
            "ingredientid": 39941,
            "name": "Monosodium Glutamate as a Flavor Enhancer"
        },
        {
            "ingredientid": 39939,
            "name": "Monosodium Glutamate as Flavor Enhancer"
        },
        {
            "ingredientid": 62301,
            "name": "Monosodium Glutamate [as a Flavor Enhancer]"
        },
        {
            "ingredientid": 39937,
            "name": "Monosodium Glutamate [Flavor Enhancer]"
        },
        {
            "ingredientid": 7616,
            "name": "Monosodium L-Glutamate (MSG) (621)"
        },
        {
            "ingredientid": 3610,
            "name": "MSG"
        },
        {
            "ingredientid": 34399,
            "name": "Sodium Glutamate"
        }
    ]
}

 

back to top ↑

Search Products  - searchprods
Parameter Status Type Description
q required string search term(s)/query
sid required string Session ID (see FAQ: Sessions
n required integer number of results to return
s required integer start number (offset)
f required string Output format as JSON or XML
c optional string callback
v required string version

Request URI

http://api.foodessentials.com/searchprods?q=orange+juice&sid=9a948dd1-a338-4acc-a5e6-2320bf74fa86&n=5&s=1&f=json&v=2.00&api_key=YOUR_API_KEY_HERE

Response Body

{
    "numFound": 502,
    "resultSize": 10,
    "session_id": "9a948dd1-a338-4acc-a5e6-2320bf74fa86",
    "productsArray": [
        {
            "upc": "00025000054341",
            "isInMyList": "false",
            "product_name": "Simply Orange Orange Juice, Calcium, Pulp Free",
            "product_description": "Orange Juice, Calcium, Pulp Free",
            "brand": "Simply Orange",
            "manufacturer": "Simply Orange Juice Company",
            "product_size": "89 oz"
        },
        {
            "upc": "00025000055430",
            "isInMyList": "false",
            "product_name": "Simply Orange Orange Juice, Calcium, Pulp Free",
            "product_description": "Orange Juice, Calcium, Pulp Free",
            "brand": "Simply Orange",
            "manufacturer": "Simply Orange Juice Company",
            "product_size": "59 oz"
        },
        {
            "upc": "00025000054167",
            "isInMyList": "false",
            "product_name": "Simply Orange Orange Juice, Country Stand, Calcium, Medium Pulp",
            "product_description": "Orange Juice, Country Stand, Calcium, Medium Pulp",
            "brand": "Simply Orange",
            "manufacturer": "Simply Orange Juice Company",
            "product_size": "59 oz"
        },
        {
            "upc": "00025000055447",
            "isInMyList": "false",
            "product_name": "Simply Orange Orange Juice, High Pulp",
            "product_description": "Orange Juice, High Pulp",
            "brand": "Simply Orange",
            "manufacturer": "Simply Orange Juice Company",
            "product_size": "59 oz"
        },
        {
            "upc": "00025000003752",
            "isInMyList": "false",
            "product_name": "Simply Orange Orange Juice, Original, Pulp Free",
            "product_description": "Orange Juice, Original, Pulp Free",
            "brand": "Simply Orange",
            "manufacturer": "Simply Orange Juice Company",
            "product_size": "13.5 oz"
        },
        }
    ]
}

 

back to top ↑

Product Score  - productscore
Parameter Status Type Description
u required string UPC
sid required string Session ID (see FAQ: Sessions
f required string Output format as JSON or XML

Request URI

http://api.foodessentials.com/productscore?u=021131501013&sid=b0130ba6-6f1e-4d6d-bfc1-cdd617ec0325&f=json&api_key=YOUR_API_KEY_HERE

Response Body

{
    "product": {
        "upc": "021131501013",
        "product_name": "MARIE CALLENDERS CHICKEN POT PIE",
        "brand": "MARIE CALLENDERS",
        "manufacturer": "MARIE CALLENDERS RETAIL FOODS",
        "nutrients": [{
            "nutrient_name": "Calories",
            "nutrient_value": "520.0",
            "nutrient_uom": "Cal",
            "nutrient_fe_level": "9"
        }, {
            "nutrient_name": "Total Fat",
            "nutrient_value": "31.0",
            "nutrient_uom": "g",
            "nutrient_fe_level": "9"
        }, {
            "nutrient_name": "Dietary Fiber",
            "nutrient_value": "3.0",
            "nutrient_uom": "g",
            "nutrient_fe_level": "4"
        }, {
            "nutrient_name": "Sodium",
            "nutrient_value": "800.0",
            "nutrient_uom": "mg",
            "nutrient_fe_level": "9"
        }],
        "additives": [{
            "additive_name": "Preservatives",
            "additive_value": "2",
            "additive_red_ingredients": "Polysorbate 60",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Colors",
            "additive_value": "2",
            "additive_red_ingredients": "Riboflavin",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Added Sugar",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Sweeteners",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }],
        "allergens": [{
            "allergen_name": "Gluten",
            "allergen_value": "2",
            "allergen_red_ingredients": "Wheat Flour Enriched with Niacin",
            "allergen_yellow_ingredients": "Flavor"
        }, {
            "allergen_name": "Peanuts",
            "allergen_value": "0",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": ""
        }],
        "procingredients": [{
            "name": "High Fructose Corn Syrup",
            "value": 0,
            "ingredientid": 137
        }, {
            "name": "Aspartame",
            "value": 0,
            "ingredientid": 5901
        }],
        "productscore": 8
    }
}

 

back to top ↑

Label  - label
Parameter Status Type Description
u required string UPC
sid required string Session ID (see FAQ: Sessions
appid required integer App ID
f required string Output format as JSON or XML
long optional string Longitude
lat optional string Latitude

Request URI

http://api.foodessentials.com/label?u=050200559105&sid=af520b23-4799-4a54-bc94-488484fa8ac0&appid=demoApp_01&f=json&long=38.6300&lat=90.2000&api_key=YOUR_API_KEY_HERE

Response Body

{
        "upc":"050200559105",
        "product_name":"SUNNY DELIGHT ORANGE FLAVORED CITRUS PUNCH",
"canStoreName":"false",
        "processedIngredients":"",
        "allergens":[{
            "allergen_name":"Cereals",
            "allergen_value":2,
            "allergen_red_ingredients":"Corn Syrup, Modified Cornstarch",
            "allergen_yellow_ingredients":"ASCORBIC ACID (VITAMIN C), CELLULOSE GUM, CITRIC ACID, MALIC ACID, NATURAL FLAVORS"
            },{
                "allergen_name":"Shellfish",
                "allergen_value":0,
                "allergen_red_ingredients":"",
                "allergen_yellow_ingredients":""
            },{
                "allergen_name":"Egg",
                "allergen_value":0,
                "allergen_red_ingredients":"",
                "allergen_yellow_ingredients":""
            },{
                "allergen_name":"Fish",
                "allergen_value":0,
                "allergen_red_ingredients":"",
                "allergen_yellow_ingredients":""
            },{
                "allergen_name":"Milk",
                "allergen_value":0,
                "allergen_red_ingredients":"",
                "allergen_yellow_ingredients":""
            },{
                "allergen_name":"Peanuts",
                "allergen_value":0,
                "allergen_red_ingredients":"",
                "allergen_yellow_ingredients":""
            },{
                "allergen_name":"Sulfites",
                "allergen_value":2,
                "allergen_red_ingredients":"Corn Syrup, Modified Cornstarch",
                "allergen_yellow_ingredients":""
            },{
                "allergen_name":"Tree Nuts",
                "allergen_value":0,
                "allergen_red_ingredients":"",
                "allergen_yellow_ingredients":""

            },{
                "allergen_name":"Soybean",
                "allergen_value":0,
                "allergen_red_ingredients":"",
                "allergen_yellow_ingredients":""

            },{
                "allergen_name":"Sesame Seeds",
                "allergen_value":1,
                "allergen_red_ingredients":"",
                "allergen_yellow_ingredients":"NATURAL FLAVORS"

            },{
                "allergen_name":"Gluten",
                "allergen_value":0,
                "allergen_red_ingredients":"",
                "allergen_yellow_ingredients":""

            },{
                "allergen_name":"Lactose",
                "allergen_value":0,
                "allergen_red_ingredients":"",
                "allergen_yellow_ingredients":""

            },{
                "allergen_name":"Corn",
                "allergen_value":2,
                "allergen_red_ingredients":"Corn Syrup, Modified Cornstarch",
                "allergen_yellow_ingredients":"ASCORBIC ACID (VITAMIN C), CELLULOSE GUM, CITRIC ACID, MALIC ACID, NATURAL FLAVORS"
            },{
                "allergen_name":"Wheat",
                "allergen_value":0,
                "allergen_red_ingredients":"",
                "allergen_yellow_ingredients":""
            },{
                "allergen_name":"Coconut",
"allergen_value":0,
"allergen_red_ingredients":"",
"allergen_yellow_ingredients":""}],

        "additives":[{
                "additive_name":"Emulsifiers",
                "additive_value":2,
                "additive_red_ingredients":"CELLULOSE GUM, SODIUM HEXAMETAPHOSPHATE",
                "additive_yellow_ingredients":""
            },{
                "additive_name":"Stabilizers",
                "additive_value":2,
                "additive_red_ingredients":"CELLULOSE GUM, CITRIC ACID, Disodium EDTA, Modified Cornstarch, SODIUM HEXAMETAPHOSPHATE",
                "additive_yellow_ingredients":""
            },{
                "additive_name":"Preservatives",
                "additive_value":2,
                "additive_red_ingredients":"ASCORBIC ACID (VITAMIN C), CITRIC ACID, Disodium EDTA, POTASSIUM SORBATE TO PROTECT FLAVOR, SODIUM HEXAMETAPHOSPHATE",
                "additive_yellow_ingredients":""
            },{
                "additive_name":"Sweeteners",
                "additive_value":2,
                "additive_red_ingredients":"SUCRALOSE",
                "additive_yellow_ingredients":""
            },{
                "additive_name":"Antioxidants",
                "additive_value":2,
                "additive_red_ingredients":"ASCORBIC ACID (VITAMIN C), CITRIC ACID, Disodium EDTA, SODIUM HEXAMETAPHOSPHATE",
                "additive_yellow_ingredients":""
            },{
                "additive_name":"Colors",
                "additive_value":2,
                "additive_red_ingredients":"ASCORBIC ACID (VITAMIN C), Concentrated Juices, YELLOW #5, Yellow #6",
                "additive_yellow_ingredients":""
            },{
                "additive_name":"Vegetable Gum",
                "additive_value":2,
                "additive_red_ingredients":"CELLULOSE GUM, CITRIC ACID, Modified Cornstarch, SODIUM HEXAMETAPHOSPHATE",
                "additive_yellow_ingredients":""
            },{
                "additive_name":"Flavor Enhancer",
                "additive_value":2,
                "additive_red_ingredients":"CITRIC ACID, MALIC ACID",
                "additive_yellow_ingredients":"Thiamin, Vitamin B1"
            },{
                "additive_name":"Thickeners",
                "additive_value":2,
                "additive_red_ingredients":"CELLULOSE GUM, Modified Cornstarch",
                "additive_yellow_ingredients":""
            },{
                "additive_name":"Acidity Regulator",
                "additive_value":2,
                "additive_red_ingredients":"ASCORBIC ACID (VITAMIN C), CITRIC ACID, MALIC ACID, SODIUM HEXAMETAPHOSPHATE",
                "additive_yellow_ingredients":""
            },{
                "additive_name":"Food Acids",
                "additive_value":2,
                "additive_red_ingredients":"ASCORBIC ACID (VITAMIN C), CITRIC ACID, MALIC ACID",
                "additive_yellow_ingredients":""
            },{
                "additive_name":"Mineral Salt",
                "additive_value":2,
                "additive_red_ingredients":"CITRIC ACID, SODIUM HEXAMETAPHOSPHATE",
                "additive_yellow_ingredients":""
            },{
                "additive_name":"Propellant",
                "additive_value":0,
                "additive_red_ingredients":"",
                "additive_yellow_ingredients":""
            },{
                "additive_name":"Artificial Color",
                "additive_value":2,
                "additive_red_ingredients":"YELLOW #5",
                "additive_yellow_ingredients":"Yellow #6"
            },{
                "additive_name":"Artificial Flavoring Agent",
                "additive_value":0,
                "additive_red_ingredients":"",
                "additive_yellow_ingredients":""
            },{
                "additive_name":"Artificial Preservative",
                "additive_value":2,
                "additive_red_ingredients":"Disodium EDTA, POTASSIUM SORBATE TO PROTECT FLAVOR, SODIUM HEXAMETAPHOSPHATE",
                "additive_yellow_ingredients":""
            },{
                "additive_name":"Natural Color",
                "additive_value":2,
                "additive_red_ingredients":"Concentrated Juices, Yellow #6",
                "additive_yellow_ingredients":"ASCORBIC ACID (VITAMIN C)"
            },{
                "additive_name":"Natural Flavoring Agent",
                "additive_value":2,
                "additive_red_ingredients":"NATURAL FLAVORS",
                "additive_yellow_ingredients":""
            },{
                "additive_name":"Natural Preservative",
                "additive_value":2,
                "additive_red_ingredients":"ASCORBIC ACID (VITAMIN C), CITRIC ACID",
                "additive_yellow_ingredients":""
            },{
                "additive_name":"Trans Fat",
                "additive_value":0,
                "additive_red_ingredients":"",
                "additive_yellow_ingredients":""
            },{
                "additive_name":"Added Sugar",
            "additive_value":2,
            "additive_red_ingredients":"Concentrated Juices, Corn Syrup",
            "additive_yellow_ingredients":""}],"ingredients":"WATER, CORN SYRUP AND 2% OR LESS OF EACH OF THE FOLLOWING: CONCENTRATED JUICES (ORANGE,  TANGERINE, APPLE, LIME, GRAPEFRUIT), CITRIC ACID, MALIC ACID, ASCORBIC ACID (VITAMIN C),\ THIAMIN HYDROCHOLORIDE (VITAMIN B1), NATURAL FLAVORS. MODIFIED CORNSTARCH, CANOLA OIL, CELLULOSE GUM, SUCRALOSE, SODIUM HEXAMETAPHOSPHATE, POTASSIUM SORBATE TO PROTECT FLAVOR, YELLOW #5, YELLOW #6 AND DISODIUM EDTA TO PROTECT COLOR."}

 

back to top ↑

Label Array  - labelarray
Parameter Status Type Description
u required string UPC
sid required string Session ID (see FAQ: Sessions
appid required integer App ID
f required string Output format as JSON or XML
long optional string Longitude
lat optional string Latitude

Request URI

http://api.foodessentials.com/labelarray?u=076840100477&sid=9fe4492b-492e-4336-86b8-7d278e02aa51&n=2&s=0&f=json&api_key=YOUR_API_KEY_HERE

Response Body

{
    "sort_variable": "Calories",
    "sort_order": 1,
    "variable_type": 1,
    "primaryupc": "076840100477",
    "numFound": 38,
    "resultSize": 2,
    "numRows": 2,
    "startNum": 0,
    "food_category": "Ice Cream - Fudge Flavor",
    "productsArray": [{
        "upc": "076840100477",
        "isInMyList": "false",
        "product_name": "BEN & JERRY'S ICE CREAM, CHOCOLATE ICE CREAM WITH FUDGE BROWNIES",
        "product_description": "ICE CREAM, CHOCOLATE ICE CREAM WITH FUDGE BROWNIES",
        "brand": "BEN & JERRY'S",
        "product_size": "1 PT",
        "manufacturer": "BEN & JERRY'S HOMEMADE, INC.",
        "aisle": "FROZEN FOOD",
        "shelf": "Ice Cream & Frozen Yogurt",
        "food_category": "Ice Cream - Fudge Flavor",
        "serving_size": "0.5",
        "serving_size_uom": "cup",
        "servings_per_container": "4",
        "ingredients": "CREAM, LIQUID SUGAR (SUGAR, WATER), SKIM MILK, WATER SUGAR, COCOA (PROCESSED WITH ALKAI), WHEAT FLOUR, COCOA, EGG YOLKS, BUTTER (CREAM, SALT), EGGS, EGG WHITES, GUAR GIM SALT, CARRAGEENAN, VANILLA EXTRACT, SODIUM BICARBONATE.",
        "nutrients": [{
            "nutrient_name": "Calcium",
            "nutrient_value": "",
            "nutrient_uom": "mg",
            "nutrient_fe_level": "4"
        }, {
            "nutrient_name": "Calories",
            "nutrient_value": "260.0",
            "nutrient_uom": "Cal",
            "nutrient_fe_level": "10"
        }, {
            "nutrient_name": "Calories from Fat",
            "nutrient_value": "110.0",
            "nutrient_uom": "Cal",
            "nutrient_fe_level": "9"
        }, {
            "nutrient_name": "Cholesterol",
            "nutrient_value": "40.0",
            "nutrient_uom": "mg",
            "nutrient_fe_level": "7"
        }, {
            "nutrient_name": "Dietary Fiber",
            "nutrient_value": "2.0",
            "nutrient_uom": "g",
            "nutrient_fe_level": "5"
        }, {
            "nutrient_name": "Insoluble Fiber",
            "nutrient_value": "",
            "nutrient_uom": "",
            "nutrient_fe_level": ""
        }, {
            "nutrient_name": "Iron",
            "nutrient_value": "",
            "nutrient_uom": "mg",
            "nutrient_fe_level": "4"
        }, {
            "nutrient_name": "Monounsaturated Fat",
            "nutrient_value": "",
            "nutrient_uom": "",
            "nutrient_fe_level": ""
        }, {
            "nutrient_name": "Other Carbohydrate",
            "nutrient_value": "",
            "nutrient_uom": "",
            "nutrient_fe_level": ""
        }, {
            "nutrient_name": "Polyunsaturated Fat",
            "nutrient_value": "",
            "nutrient_uom": "",
            "nutrient_fe_level": ""
        }, {
            "nutrient_name": "Potassium",
            "nutrient_value": "",
            "nutrient_uom": "",
            "nutrient_fe_level": ""
        }, {
            "nutrient_name": "Protein",
            "nutrient_value": "4.0",
            "nutrient_uom": "g",
            "nutrient_fe_level": "5"
        }, {
            "nutrient_name": "Saturated Fat",
            "nutrient_value": "7.0",
            "nutrient_uom": "g",
            "nutrient_fe_level": "10"
        }, {
            "nutrient_name": "Saturated Fat Calories",
            "nutrient_value": "",
            "nutrient_uom": "",
            "nutrient_fe_level": ""
        }, {
            "nutrient_name": "Sodium",
            "nutrient_value": "65.0",
            "nutrient_uom": "mg",
            "nutrient_fe_level": "5"
        }, {
            "nutrient_name": "Soluble Fiber",
            "nutrient_value": "",
            "nutrient_uom": "",
            "nutrient_fe_level": ""
        }, {
            "nutrient_name": "Sugar Alcohol",
            "nutrient_value": "",
            "nutrient_uom": "",
            "nutrient_fe_level": ""
        }, {
            "nutrient_name": "Sugars",
            "nutrient_value": "27.0",
            "nutrient_uom": "g",
            "nutrient_fe_level": "10"
        }, {
            "nutrient_name": "Total Carbohydrate",
            "nutrient_value": "34.0",
            "nutrient_uom": "g",
            "nutrient_fe_level": "7"
        }, {
            "nutrient_name": "Total Fat",
            "nutrient_value": "12.0",
            "nutrient_uom": "g",
            "nutrient_fe_level": "6"
        }, {
            "nutrient_name": "Vitamin A",
            "nutrient_value": "",
            "nutrient_uom": "mg",
            "nutrient_fe_level": "4"
        }, {
            "nutrient_name": "Vitamin C",
            "nutrient_value": "",
            "nutrient_uom": "mg",
            "nutrient_fe_level": "7"
        }],
        "additives": [{
            "additive_name": "Acidity Regulator",
            "additive_value": "2",
            "additive_red_ingredients": "SODIUM BICARBONATE",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Added Sugar",
            "additive_value": "2",
            "additive_red_ingredients": "SUGAR, SUGAR, LIQUID SUGAR",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Anti-Caking Agents",
            "additive_value": "2",
            "additive_red_ingredients": "SODIUM BICARBONATE",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Anti-Foaming Agent",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Antioxidants",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Artificial Color",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Artificial Flavoring Agent",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Artificial Preservative",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Bulking Agents",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Colors",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Emulsifiers",
            "additive_value": "2",
            "additive_red_ingredients": "SODIUM BICARBONATE, CARRAGEENAN, Guar",
            "additive_yellow_ingredients": "CREAM, CREAM"
        }, {
            "additive_name": "Enzyme",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Firming Agent",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Flavor Enhancer",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Flour Treating Agent",
            "additive_value": "2",
            "additive_red_ingredients": "SODIUM BICARBONATE",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Food Acids",
            "additive_value": "2",
            "additive_red_ingredients": "SODIUM BICARBONATE",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Gelling Agents",
            "additive_value": "2",
            "additive_red_ingredients": "SODIUM BICARBONATE, CARRAGEENAN, Guar",
            "additive_yellow_ingredients": "CREAM, CREAM"
        }, {
            "additive_name": "Glazing Agent",
            "additive_value": "2",
            "additive_red_ingredients": "CARRAGEENAN",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Humectants",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Leavening Agent",
            "additive_value": "2",
            "additive_red_ingredients": "SODIUM BICARBONATE",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Mineral Salt",
            "additive_value": "2",
            "additive_red_ingredients": "SODIUM BICARBONATE",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Natural Color",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Natural Flavoring Agent",
            "additive_value": "2",
            "additive_red_ingredients": "VANILLA EXTRACT",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Natural Preservative",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Preservatives",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Propellant",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Raising Agents",
            "additive_value": "2",
            "additive_red_ingredients": "SODIUM BICARBONATE",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Saturated Fat",
            "additive_value": "2",
            "additive_red_ingredients": "SKIM MILK, CREAM, CREAM, COCOA, Cocoa, BUTTER, EGG YOLKS, EGGS, EGG WHITES",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Sequestrant",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Stabilizers",
            "additive_value": "2",
            "additive_red_ingredients": "SODIUM BICARBONATE, CARRAGEENAN, Guar",
            "additive_yellow_ingredients": "CREAM, CREAM"
        }, {
            "additive_name": "Sweeteners",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Thickeners",
            "additive_value": "2",
            "additive_red_ingredients": "CARRAGEENAN, Guar",
            "additive_yellow_ingredients": "CREAM, CREAM"
        }, {
            "additive_name": "Trans Fat",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Unsaturated Fat",
            "additive_value": "2",
            "additive_red_ingredients": "SKIM MILK, CREAM, CREAM, COCOA, Cocoa, BUTTER, EGG YOLKS, EGGS, EGG WHITES",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Vegetable Gum",
            "additive_value": "2",
            "additive_red_ingredients": "CARRAGEENAN, Guar",
            "additive_yellow_ingredients": ""
        }],
        "allergens": [{
            "allergen_name": "Cereals",
            "allergen_value": "2",
            "allergen_red_ingredients": "WHEAT FLOUR",
            "allergen_yellow_ingredients": "VANILLA EXTRACT"
        }, {
            "allergen_name": "Coconut",
            "allergen_value": "0",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Corn",
            "allergen_value": "1",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": "VANILLA EXTRACT"
        }, {
            "allergen_name": "Egg",
            "allergen_value": "2",
            "allergen_red_ingredients": "EGG YOLKS, EGGS, EGG WHITES",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Fish",
            "allergen_value": "0",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Gluten",
            "allergen_value": "2",
            "allergen_red_ingredients": "WHEAT FLOUR",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Lactose",
            "allergen_value": "2",
            "allergen_red_ingredients": "SKIM MILK, CREAM, CREAM, BUTTER",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Milk",
            "allergen_value": "2",
            "allergen_red_ingredients": "SKIM MILK, CREAM, CREAM, BUTTER",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Peanuts",
            "allergen_value": "0",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Sesame Seeds",
            "allergen_value": "0",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Shellfish",
            "allergen_value": "0",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Soybean",
            "allergen_value": "0",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Sulfites",
            "allergen_value": "0",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Tree Nuts",
            "allergen_value": "0",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Wheat",
            "allergen_value": "2",
            "allergen_red_ingredients": "WHEAT FLOUR",
            "allergen_yellow_ingredients": ""
        }],
        "procingredients": [
        		{
                    "name": "High Fructose Corn Syrup",
                    "value": 2,
                    "ingredientid": 137
                },
                {
                    "name": "Aspartame",
                    "value": 0,
                    "ingredientid": 5901
                },
                {
                    "name": "Pineapple Pulp",
                    "value": 0,
                    "ingredientid": 47475
        }]
    }, {
        "upc": "020188014439",
        "isInMyList": "false",
        "product_name": "TOFUTTI CHOCOLATE FUDGE TREATS.",
        "product_description": "CHOCOLATE FUDGE TREATS. ",
        "brand": "TOFUTTI",
        "product_size": "622 ml",
        "manufacturer": "TOFUTTI BRANDS",
        "aisle": "FROZEN FOOD",
        "shelf": "Ice Cream & Frozen Yogurt",
        "food_category": "Ice Cream - Fudge Flavor",
        "serving_size": "40",
        "serving_size_uom": "g",
        "servings_per_container": "12",
        "ingredients": "WATER, MALTODEXTRIN, SORBITOL, POLYDEXTROSE, COCOA PROCESSED WITH ALKALI, SOY PROTEIN, TOFU, VEGETABLE MONO AND DIGLYCERIDES, CELLULOSE GUM, CARRAGEENAN, VANILLA WITH OTHER NATURAL FLAVORS, ASPARTMAME, SALT.",
        "nutrients": [{
            "nutrient_name": "Calcium",
            "nutrient_value": "",
            "nutrient_uom": "",
            "nutrient_fe_level": ""
        }, {
            "nutrient_name": "Calories",
            "nutrient_value": "30.0",
            "nutrient_uom": "Cal",
            "nutrient_fe_level": "3"
        }, {
            "nutrient_name": "Calories from Fat",
            "nutrient_value": "0.0",
            "nutrient_uom": "Cal",
            "nutrient_fe_level": "3"
        }, {
            "nutrient_name": "Cholesterol",
            "nutrient_value": "0.0",
            "nutrient_uom": "mg",
            "nutrient_fe_level": "3"
        }, {
            "nutrient_name": "Dietary Fiber",
            "nutrient_value": "0.0",
            "nutrient_uom": "g",
            "nutrient_fe_level": "7"
        }, {
            "nutrient_name": "Insoluble Fiber",
            "nutrient_value": "",
            "nutrient_uom": "",
            "nutrient_fe_level": ""
        }, {
            "nutrient_name": "Iron",
            "nutrient_value": "",
            "nutrient_uom": "",
            "nutrient_fe_level": ""
        }, {
            "nutrient_name": "Monounsaturated Fat",
            "nutrient_value": "",
            "nutrient_uom": "",
            "nutrient_fe_level": ""
        }, {
            "nutrient_name": "Other Carbohydrate",
            "nutrient_value": "4.0",
            "nutrient_uom": "g",
            "nutrient_fe_level": "99"
        }, {
            "nutrient_name": "Polyunsaturated Fat",
            "nutrient_value": "",
            "nutrient_uom": "",
            "nutrient_fe_level": ""
        }, {
            "nutrient_name": "Potassium",
            "nutrient_value": "61.0",
            "nutrient_uom": "mg",
            "nutrient_fe_level": "99"
        }, {
            "nutrient_name": "Protein",
            "nutrient_value": "1.0",
            "nutrient_uom": "g",
            "nutrient_fe_level": "7"
        }, {
            "nutrient_name": "Saturated Fat",
            "nutrient_value": "0.0",
            "nutrient_uom": "g",
            "nutrient_fe_level": "3"
        }, {
            "nutrient_name": "Saturated Fat Calories",
            "nutrient_value": "",
            "nutrient_uom": "",
            "nutrient_fe_level": ""
        }, {
            "nutrient_name": "Sodium",
            "nutrient_value": "86.0",
            "nutrient_uom": "mg",
            "nutrient_fe_level": "5"
        }, {
            "nutrient_name": "Soluble Fiber",
            "nutrient_value": "",
            "nutrient_uom": "",
            "nutrient_fe_level": ""
        }, {
            "nutrient_name": "Sugar Alcohol",
            "nutrient_value": "",
            "nutrient_uom": "",
            "nutrient_fe_level": ""
        }, {
            "nutrient_name": "Sugars",
            "nutrient_value": "0.0",
            "nutrient_uom": "g",
            "nutrient_fe_level": "3"
        }, {
            "nutrient_name": "Total Carbohydrate",
            "nutrient_value": "6.0",
            "nutrient_uom": "g",
            "nutrient_fe_level": "5"
        }, {
            "nutrient_name": "Total Fat",
            "nutrient_value": "0.0",
            "nutrient_uom": "g",
            "nutrient_fe_level": "3"
        }, {
            "nutrient_name": "Vitamin A",
            "nutrient_value": "",
            "nutrient_uom": "",
            "nutrient_fe_level": ""
        }, {
            "nutrient_name": "Vitamin C",
            "nutrient_value": "",
            "nutrient_uom": "",
            "nutrient_fe_level": ""
        }],
        "additives": [{
            "additive_name": "Acidity Regulator",
            "additive_value": "1",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": "COCOA PROCESSED WITH ALKALI"
        }, {
            "additive_name": "Added Sugar",
            "additive_value": "1",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": "MALTODEXTRIN"
        }, {
            "additive_name": "Anti-Caking Agents",
            "additive_value": "1",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": "COCOA PROCESSED WITH ALKALI"
        }, {
            "additive_name": "Anti-Foaming Agent",
            "additive_value": "2",
            "additive_red_ingredients": "VEGETABLE MONO AND DIGLYCERIDES",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Antioxidants",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Artificial Color",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Artificial Flavoring Agent",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Artificial Preservative",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Bulking Agents",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Colors",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Emulsifiers",
            "additive_value": "2",
            "additive_red_ingredients": "CARRAGEENAN, SORBITOL, CELLULOSE GUM, VEGETABLE MONO AND DIGLYCERIDES",
            "additive_yellow_ingredients": "COCOA PROCESSED WITH ALKALI"
        }, {
            "additive_name": "Enzyme",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Firming Agent",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Flavor Enhancer",
            "additive_value": "2",
            "additive_red_ingredients": "VEGETABLE MONO AND DIGLYCERIDES",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Flour Treating Agent",
            "additive_value": "2",
            "additive_red_ingredients": "VEGETABLE MONO AND DIGLYCERIDES",
            "additive_yellow_ingredients": "COCOA PROCESSED WITH ALKALI"
        }, {
            "additive_name": "Food Acids",
            "additive_value": "2",
            "additive_red_ingredients": "VEGETABLE MONO AND DIGLYCERIDES",
            "additive_yellow_ingredients": "COCOA PROCESSED WITH ALKALI"
        }, {
            "additive_name": "Gelling Agents",
            "additive_value": "2",
            "additive_red_ingredients": "CARRAGEENAN, CELLULOSE GUM",
            "additive_yellow_ingredients": "COCOA PROCESSED WITH ALKALI"
        }, {
            "additive_name": "Glazing Agent",
            "additive_value": "2",
            "additive_red_ingredients": "CARRAGEENAN",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Humectants",
            "additive_value": "2",
            "additive_red_ingredients": "POLYDEXTROSE, SORBITOL, VEGETABLE MONO AND DIGLYCERIDES",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Leavening Agent",
            "additive_value": "1",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": "COCOA PROCESSED WITH ALKALI"
        }, {
            "additive_name": "Mineral Salt",
            "additive_value": "1",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": "COCOA PROCESSED WITH ALKALI"
        }, {
            "additive_name": "Natural Color",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Natural Flavoring Agent",
            "additive_value": "2",
            "additive_red_ingredients": "Other Natural Flavors",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Natural Preservative",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Preservatives",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Propellant",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Raising Agents",
            "additive_value": "2",
            "additive_red_ingredients": "POLYDEXTROSE, VEGETABLE MONO AND DIGLYCERIDES",
            "additive_yellow_ingredients": "COCOA PROCESSED WITH ALKALI"
        }, {
            "additive_name": "Saturated Fat",
            "additive_value": "2",
            "additive_red_ingredients": "TOFU, COCOA PROCESSED WITH ALKALI",
            "additive_yellow_ingredients": "VEGETABLE MONO AND DIGLYCERIDES"
        }, {
            "additive_name": "Sequestrant",
            "additive_value": "2",
            "additive_red_ingredients": "SORBITOL",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Stabilizers",
            "additive_value": "2",
            "additive_red_ingredients": "MALTODEXTRIN, POLYDEXTROSE, CARRAGEENAN, SORBITOL, CELLULOSE GUM, VEGETABLE MONO AND DIGLYCERIDES",
            "additive_yellow_ingredients": "COCOA PROCESSED WITH ALKALI"
        }, {
            "additive_name": "Sweeteners",
            "additive_value": "2",
            "additive_red_ingredients": "SORBITOL",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Thickeners",
            "additive_value": "2",
            "additive_red_ingredients": "MALTODEXTRIN, POLYDEXTROSE, CARRAGEENAN, CELLULOSE GUM, VEGETABLE MONO AND DIGLYCERIDES",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Trans Fat",
            "additive_value": "0",
            "additive_red_ingredients": "",
            "additive_yellow_ingredients": ""
        }, {
            "additive_name": "Unsaturated Fat",
            "additive_value": "2",
            "additive_red_ingredients": "TOFU, COCOA PROCESSED WITH ALKALI",
            "additive_yellow_ingredients": "VEGETABLE MONO AND DIGLYCERIDES"
        }, {
            "additive_name": "Vegetable Gum",
            "additive_value": "2",
            "additive_red_ingredients": "CARRAGEENAN, CELLULOSE GUM, VEGETABLE MONO AND DIGLYCERIDES",
            "additive_yellow_ingredients": ""
        }],
        "allergens": [{
            "allergen_name": "Cereals",
            "allergen_value": "2",
            "allergen_red_ingredients": "MALTODEXTRIN",
            "allergen_yellow_ingredients": "POLYDEXTROSE, Vanilla, SORBITOL, CELLULOSE GUM, Other Natural Flavors, VEGETABLE MONO AND DIGLYCERIDES"
        }, {
            "allergen_name": "Coconut",
            "allergen_value": "0",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Corn",
            "allergen_value": "2",
            "allergen_red_ingredients": "MALTODEXTRIN",
            "allergen_yellow_ingredients": "POLYDEXTROSE, Vanilla, SORBITOL, CELLULOSE GUM, Other Natural Flavors, VEGETABLE MONO AND DIGLYCERIDES"
        }, {
            "allergen_name": "Egg",
            "allergen_value": "0",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Fish",
            "allergen_value": "0",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Gluten",
            "allergen_value": "1",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": "MALTODEXTRIN"
        }, {
            "allergen_name": "Lactose",
            "allergen_value": "0",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Milk",
            "allergen_value": "0",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Peanuts",
            "allergen_value": "0",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Sesame Seeds",
            "allergen_value": "1",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": "Other Natural Flavors"
        }, {
            "allergen_name": "Shellfish",
            "allergen_value": "0",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Soybean",
            "allergen_value": "2",
            "allergen_red_ingredients": "SOY PROTEIN, TOFU",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Sulfites",
            "allergen_value": "0",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Tree Nuts",
            "allergen_value": "0",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": ""
        }, {
            "allergen_name": "Wheat",
            "allergen_value": "0",
            "allergen_red_ingredients": "",
            "allergen_yellow_ingredients": ""
        }],
        "procingredients": [
                {
                    "name": "High Fructose Corn Syrup",
                    "value": 2,
                    "ingredientid": 137
                },
                {
                    "name": "Aspartame",
                    "value": 0,
                    "ingredientid": 5901
                },
                {
                    "name": "Pineapple Pulp",
                    "value": 0,
                    "ingredientid": 47475
        }]
    }]
}

 

back to top ↑

Label Summary  - label_summary
Parameter Status Type Description
u required string UPC
sid required string Session ID (see FAQ: Sessions
appid required integer App ID
f required string Output format as JSON or XML
long optional string Longitude
lat optional string Latitude

Request URI

http://api.foodessentials.com/label_summary?u=050200559105&sid=00015900061327&appid=Example&f=json&api_key=YOUR_API_KEY_HERE

Response Body

{
    "upc": "050200559105",
    "product_name": "Sunny D Citrus Punch, Orange Flavored",
    "url": "http://foodessentials.mobi/pages/label.jsp?upc=050200559105&ld=0&from=Example"
}

 

back to top ↑

Get Allergen Additve  - getallergenadditive 
Parameter Status Type Description
u required string UPC
sid required string Session ID
appid required string App ID
f required string Output format as JSON or XML
property required string has to equal the allergen or additive exactly as it is spelt
proptype required string Property Type

Request URI

http://api.foodessentials.com/getallergenadditive?u=+%09++050200559105&sid=test&f=json&property=Corn&propType=allergen&api_key=YOUR_API_KEY_HERE

Response Body

{
    "upc": "050200559105",
    "property": "Corn",
    "propType": "allergen",
    "redIngredients": [
        "High Fructose Corn Syrup",
        "Modified Cornstarch"
    ],
    "yellowIngredients": [
        "Ascorbic Acid (Vitamin C)",
        "Sodium Citrate",
        "Cellulose Gum",
        "Citric Acid",
        "Natural Flavors"
    ]
}
{
    "upc": "050200559105",
    "property": "Corn",
    "propType": "allergen",
    "redIngredients": [
        "High Fructose Corn Syrup",
        "Modified Cornstarch"
    ],
    "yellowIngredients": [
        "Ascorbic Acid (Vitamin C)",
        "Sodium Citrate",
        "Cellulose Gum",
        "Citric Acid",
        "Natural Flavors"
    ]
}

 

back to top ↑

Get Property Description  - getpropdescription
Parameter Status Type Description
type required string nutrient/allergen/additive
name required integer name of nutrient/allergen/additive
f required string Output format as JSON or XML

Request URI

http://api.foodessentials.com/getpropdescription?type=nutrient&name=Calories&f=json&api_key=YOUR_API_KEY_HERE

Response Body

{
    "propertyType": "nutrient",
    "propertyName": "Calories",
    "propertyDescription": "Daily Value = 2,000 Calories\r\nLOW = Less than or equal to 40 Calories/Serve\r\nMODERATE = Between 41 - 399 Calories/Serve\r\nHIGH = More than or equal to 400 Calories/Serve \r\n\r\nCalories (Cal) are the unit of which energy is measured. On food labels, calories may also be referred to as \"kilocalories\", Kcalories or \"Kcal\". 1Kcal = 1000Cal. The number of calories in a food can give you a good idea of how much food you should be consuming for your particular lifestyle. The FDA calorie guidelines are based on consuming on average 2,000 Calories per day. However, these are just guidelines, and every individual is slightly different.  If you consume more energy than you use, then you risk gaining weight as your body can store the excess energy as fat. However, consuming too little energy can be detrimental as this could cause nutritional deficiencies.",
    "alertvalue1": 3,
    "alertcaption1": "low",
    "alertvalue2": 6,
    "alertcaption2": "medium",
    "alertvalue3": 9,
    "alertcaption3": "high"
}

 

back to top ↑

Get My List  - getmylist
Parameter Status Type Description
sid required string Session ID (see FAQ: Sessions
n required integer number of results to return
s required integer start number (offset)
f required string Output format as JSON or XML

Request URI

http://api.foodessentials.com/getmylist?sid=example&n=5&s=1&f=json&api_key=YOUR_API_KEY_HERE

Response Body

{
    "upc": "050200559105",
    "property": "Corn",
    "propType": "allergen",
    "redIngredients": [
        "High Fructose Corn Syrup",
        "Modified Cornstarch"
    ],
    "yellowIngredients": [
        "Ascorbic Acid (Vitamin C)",
        "Sodium Citrate",
        "Cellulose Gum",
        "Citric Acid",
        "Natural Flavors"
    ]
}

 

back to top ↑

Add My List  - addmylist
Parameter Status Type Description
u required string UPC
sid required integer Session ID
f required string Output format as JSON or XML

Request URI

http://api.foodessentials.com/addmylist?u=00015900061327&sid=6982c2b5-79ff-4d55-929c-b303a18d1e87&f=json&api_key=YOUR_API_KEY_HERE

Response Body

{"result":"success"}

 

back to top ↑

Remove My List  - removemylist
Parameter Status Type Description
sid required string Session ID (see FAQ: Sessions
u required integer UPC
f required string Output format as JSON or XML

Request URI

http://api.foodessentials.com/removemylist?input=msg&sid=6982c2b5-79ff-4d55-929c-b303a18d1e87&u=00015900061327&f=json&api_key=YOUR_API_KEY_HERE

Response Body

{"result":"success"}

 

back to top ↑

Get Search Log  - getsearchlog
Parameter Status Type Description
sid required string Session ID (see FAQ: Sessions
n required integer number of results to return
s required integer start number (offset)
f required string Output format as JSON or XML

Request URI

http://api.foodessentials.com/getsearchlog?sid=6982c2b5-79ff-4d55-929c-b303a18d1e87&n=10&s=1&f=json&api_key=YOUR_API_KEY_HERE

Response Body

{
    "session_id": "6982c2b5-79ff-4d55-929c-b303a18d1e87",
    "user_id": "ex",
    "queries": [
        {
            "query": "bacon",
            "datesearched": "2012-09-18 15:59:11.0"
        }
    ]
}