Guides

Welcome
Authentication
OAuth 2.0
OAuth 1.0
3-Legged OAuth
Data Types
Storable Data
Error Codes
Localization*

Method Overview
Foods
food.find_id_for_barcode*
food.get.v2
food.get (deprecated)
foods.autocomplete*
foods.search.v2*
foods.search
Food Brands
food_brands.get*
Food Categories
food_categories.get*
Food Sub Categories
food_sub_categories.get*
Recipes
recipe.get.v2
recipe.get
recipes.search.v3
recipes.search.v2
recipes.search
Recipe Types
recipe_types.get.v2
recipe_types.get

API Method Reference (OAuth 1.0)

Method Overview
Foods
food.add_favorite
food.create.v2*
food.create* (deprecated)
food.delete_favorite
food.find_id_for_barcode*
food.get.v2
food.get (deprecated)
foods.autocomplete*
foods.get_favorites
foods.get_most_eaten
foods.get_recently_eaten
foods.search.v2*
foods.search
Food Brands
food_brands.get*
Food Categories
food_categories.get*
Food Sub Categories
food_sub_categories.get*
Recipes
recipe.add_favorite
recipe.delete_favorite
recipe.get.v2
recipe.get
recipes.get_favorites
recipes.search.v3
recipes.search.v2
recipes.search
Recipe Types
recipe_types.get.v2
recipe_types.get
Saved Meals
saved_meal.create
saved_meal.delete
saved_meal.edit
saved_meals.get
saved_meal_item.add
saved_meal_item.delete
saved_meal_item.edit
saved_meal_items.get
Exercises
exercises.get
Profile - Management
profile.create
profile.get
profile.get_auth
Profile - Food Diary
food_entries.copy
food_entries.copy_saved_meal
food_entries.get
food_entries.get_month
food_entry.create
food_entry.delete
food_entry.edit
Profile - Exercise Diary
exercise_entries.commit_day
exercise_entries.get
exercise_entries.get_month
exercise_entries.save_template
exercise_entry.edit
Profile - Weight Diary
weight.update
weights.get_month

* denotes methods only available at the PREMIER level

Developers

REST API

API Method Reference (OAuth 2): food.find_id_for_barcode

food.find_id_for_barcode

Description

Returns the food_id matching the barcode specified.

Barcodes must be specified as GTIN-13 numbers - a 13-digit number filled in with zeros for the spaces to the left.

UPC-A, EAN-13 and EAN-8 barcodes may be specified.

UPC-E barcodes should be converted to their UPC-A equivalent (and then specified as GTIN-13 numbers).

Localization (Premier Only):

Two additional optional parameters named region and language are available to premier clients. More information can be found in the Localization guide.

Parameters

Required

Name	Type	Description
method	String	MUST be "food.find_id_for_barcode"
barcode	String	The 13-digit GTIN-13 formated sequence of digits representing the barcode to search against.

Optional

Name	Type	Description
format	String	The desired response format. Valid reponse formats are "xml" or "json" (default value is "xml").

Response

The result of the call is the food id which matches the barcode specified (0 if no match was found).

Example Return XML

<?xml version="1.0" encoding="utf-8" ?>

<food_id xmlns="http://platform.fatsecret.com/api/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://platform.fatsecret.com/api/1.0/ http://platform.fatsecret.com/api/1.0/fatsecret.xsd">4384</food_id>