INRFOOD Data API Documentation

About The API

Protocol: The transport is HTTPS. The INRFOOD API tries to conform to REST principles.
API Endpoint: The endpoint for the current API version is https://api.inrfood.com/v3. All URLs mentioned below are relative to the endpoint. The endpoint address may change in future versions of the API.
HTTPS: You can hit the end point using https at https://api.inrfood.com/v3
Response Format: The data returned by the API is encoded as JSON (Content-Type: application/json). The character encoding is UTF-8. Future versions of the API may introduce other formats which will be selectable through the use of Accept and Accept-Charset headers. In the current version these headers are ignored.

Developers Requirement

1- Authentication

In order to call the API, you need to register at our developer site. Once your request is approved by admin, you will issued an application key. You must either pass these with each API call in HTTP headers: apikey:api-key or include them as URL parameters: apikey=app-key If your key is invalid the server will respond with the HTTP status code 401 If you exceed your API rate limit server the server will respond with the HTTP status code 429

2- Attribution Requirements

Whenever you display information obtained from the Inrfood API to your users, you must give attribution to Inrfood . The objects returned by the API calls contain an attribution which consists of the following fields:

current: gives the count of result set for the current page
next: gives the count of result set for next page with same page size
previous: gives the count of result set for previous page
pagesize: the number of items to be returned in a page

Error Codes

200 – Successful operation 201 – Resource created successfully 429 – API rate limit exceeded 400 – Bad Request 401 – Unauthorized access /Bad Api URI 503 - Bad gateway

Api Calls

Autocomplete

Using The Auto Complete Category Api Call

Performing GET requests to autocomplete category name

The base url for the autocomplete/category GET is https://api.inrfood.com/v3/autocomplete/category?apikey=api-key&search=search-parameter
Skip and Limit are optional parameters
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of Search category response.

Search API Semantics

Skip and Limit parameters are optional parameters
Search is required parameter
The keyword you pass as search parameter will find for all the category name beginning with the search keyword

Auto complete Metadata Dictionaries We keep dictionaries of the possible values of our search parameters which are defined in the section “Parameters”. Each parameter documented in the “Parameters” section contains a link to the corresponding metadata dictionary.

The objects returned by these APIs is JSON. The structure is something like

{“data”:[{ “Category Id”:544,”Category Name”:”Pickles”,”Parent Category”:”Condiments, Dips, & Salad Dressings”},..]

Again, don’t forget to URL-encode!

Parameters

search: search is required parameter. For example to autocomplete category name beginning with sa append &search=sa

like: https://api.inrfood.com/v3/autocomplete/category?apikey=your_api-key&search=sa

Skip and Limit are optional parameter used for paging.

Skip - the number of items to skip before returning anything. The LIMIT is used to limit the number of results returned in a SQL statement. So if you have 1000 rows in a table, but only want to return the first 10, you can set limit as 10. And if want to show result set from 11-20 then skip as 10 Consumer Guide for Autocomplete Category Response The following documentation is for objects returned from the autocomplete category API Call. The autocomplete API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Category Id : It is the category id for the searched category
Category Name :List of all the result set beginning with the given search keyword
Parent Categoy: Gives the parent category of the above category name
search : This states the query parameters for the result set.

Using The Auto Complete Cultural Concern Api Call

Performing GET requests to autocomplete cultural concerns

The base url for the /autocomplete/concerns/cultural{?search}[{?skip}][{?limit}] GET is https://api.inrfood.com/v3/autocomplete/concerns/cultural?apikey=api-key&search=search-parameter
Ski p and Limit are optional parameters
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of Search cultural concern response.

Search API Semantics

Skip and Limit parameters are optional parameters
Search is required parameter
The keyword you pass as search parameter will find for all the cultural concern beginning with the search keyword

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Concern Id”: 1,”Concern Name”: “Vegan (Vgn)”},..]

Again, don’t forget to URL-encode!

Parameters

search: search is required parameter. For example to autocomplete cultural concern beginning with veg append &search=veg

like: https://api.inrfood.com/v3/autocomplete/concerns/cultural?apikey=api-key&search=veg

Skip and Limit are optional parameter used for paging.

Skip - the number of items to skip before returning anything. The LIMIT is used to limit the number of results returned in a SQL statement. So if you have 1000 rows in a table, but only want to return the first 10, you can set limit as 10. And if want to show result set from 11-20 then skip as 10 Consumer Guide for Autocomplete Cultural Concern Response The following documentation is for objects returned from the autocomplete cultural concern API Call. The autocomplete API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Concern Id : It is the cultural concern id for the searched concern
Concern Name :List of all the result set beginning with the given search keyword
search : This states the query parameters for the result set.

Using The Auto Complete Medical Concern Api Call

Performing GET requests to autocomplete medical concerns

The base url for the /autocomplete/concerns/medical{?search}[{?skip}][{?limit}] GET is https://api.inrfood.com/v3/autocomplete/concerns/medical?apikey=api-key&search=search-parameter
Ski p and Limit are optional parameters
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of Search medical concern response.

Search API Semantics

Skip and Limit parameters are optional parameters
Search is required parameter
The keyword you pass as search parameter will find for all the medical concern beginning with the search keyword

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Concern Id”: 1,”Concern Name”: “Heart Disease (Hea)”},..]

Again, don’t forget to URL-encode!

Parameters

search: search is required parameter. For example to autocomplete medical concern beginning with he append &search=he

like: https://api.inrfood.com/v3/autocomplete/concerns/cultural?apikey=api-key&search=he

Skip and Limit are optional parameter used for paging.

Skip - the number of items to skip before returning anything. The LIMIT is used to limit the number of results returned in a SQL statement. So if you have 1000 rows in a table, but only want to return the first 10, you can set limit as 10. And if want to show result set from 11-20 then skip as 10 Consumer Guide for Autocomplete Medical Concern Response The following documentation is for objects returned from the autocomplete medical concern API Call. The autocomplete API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Concern Id : It is the cultural concern id for the searched concern name
Concern Name :List of all the result set beginning with the given search keyword
search : This states the query parameters for the result set.

Using The Auto Complete Ingredient Api Call

Performing GET requests to autocomplete ingredient

The base url for the /autocomplete/ingredient{?search}[{?skip}][{?limit}] GET is https://api.inrfood.com/v3/autocomplete/ingredient?apikey=api-key&search=search-parameter
Ski p and Limit are optional parameters
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of Search ingredient response.

Search API Semantics

Skip and Limit parameters are optional parameters
Search is required parameter
The keyword you pass as search parameter will find for all the ingredient name beginning with the search keyword

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Ingredient Id”: 82,”Ingredient Name”: “Processed Wheat”}, ..]

Again, don’t forget to URL-encode!

Parameters

search: search is required parameter. For example to autocomplete ingredient name beginning with pr append &search=pr

like: https://api.inrfood.com/v3/autocomplete/ingredient?apikey=api-key&search=pr

Skip and Limit are optional parameter used for paging.

Skip - the number of items to skip before returning anything. The LIMIT is used to limit the number of results returned in a SQL statement. So if you have 1000 rows in a table, but only want to return the first 10, you can set limit as 10. And if want to show result set from 11-20 then skip as 10 Consumer Guide for Autocomplete Ingredient Response The following documentation is for objects returned from the autocomplete Ingredient API Call. The autocomplete API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Ingredient Id : It is the ingredient id for the searched ingredient name
Ingredient Name :List of all the result set beginning with the given search keyword
search : This states the query parameters for the result set.

Using The Auto Complete Manufacturer Api Call

Performing GET requests to autocomplete manufacturer

The base url for the /autocomplete/manufacturer{?search}[{?skip}][{?limit}] GET is https://api.inrfood.com/v3/autocomplete/manufacturer?apikey=api-key&search=search-parameter
Ski p and Limit are optional parameters
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of Search manufacturer response.

Search API Semantics

Skip and Limit parameters are optional parameters
Search is required parameter
The keyword you pass as search parameter will find for all the manufacturer name beginning with the search keyword

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Manufacturer Id”: 13278,”Manufacturer Name”: “PRA Ltd.”}..]

Again, don’t forget to URL-encode!

Parameters

search: search is required parameter. For example to autocomplete manufacturer name beginning with pr append &search=pr

like: https://api.inrfood.com/v3/autocomplete/manufacturer?apikey=api-key&search=pr

Skip and Limit are optional parameter used for paging.

Skip - the number of items to skip before returning anything. The LIMIT is used to limit the number of results returned in a SQL statement. So if you have 1000 rows in a table, but only want to return the first 10, you can set limit as 10. And if want to show result set from 11-20 then skip as 10 Consumer Guide for Autocomplete manufacturer Response The following documentation is for objects returned from the autocomplete manufacturer API Call. The autocomplete API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Manufacturer Id : It is the manufacturer id for the searched manufacturer name
Manufacturer Name :List of all the result set beginning with the given search keyword
search : This states the query parameters for the result set.

Using The Auto Complete Product Category Api Call

Performing GET requests to autocomplete product category

The base url for the /autocomplete/product/category{?search}[{?skip}][{?limit}]}] GET is https://api.inrfood.com/v3/autocomplete/product/category?apikey=api-key&search=search-parameter
Ski p and Limit are optional parameters
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of Search product category response.

Search API Semantics

Skip and Limit parameters are optional parameters
Search is required parameter
The keyword you pass as search parameter will find for all the product category beginning with the search keyword

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Product Id”: 638,”Product Name”: “Pure Protein Natural Whey Protein”, “Product Category”: “Protein, Whey & Nutritionals”}..]

Again, don’t forget to URL-encode!

Parameters

search: search is required parameter. For example to autocomplete product category beginning with pr append &search=pr

like: https://api.inrfood.com/v3/autocomplete/product/category?apikey=api-key&search=pr

Skip and Limit are optional parameter used for paging.

Skip - the number of items to skip before returning anything. The LIMIT is used to limit the number of results returned in a SQL statement. So if you have 1000 rows in a table, but only want to return the first 10, you can set limit as 10. And if want to show result set from 11-20 then skip as 10 Consumer Guide for Autocomplete Product Category Response The following documentation is for objects returned from the autocomplete product category API Call. The autocomplete API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Product Id : It is the product id for the searched product category
Product Name :Product name for the searched product category
Product Category :List of all the result set beginning with the given search keyword
search : This states the query parameters for the result set.

Using The Auto Complete Product Api Call

Performing GET requests to autocomplete product category

The base url for the /autocomplete/product{?search}[{?skip}][{?limit}]}] GET is https://api.inrfood.com/v3/autocomplete/product?apikey=api-key&search=search-parameter
Ski p and Limit are optional parameters
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of Search product response.

Search API Semantics

Skip and Limit parameters are optional parameters
Search is required parameter
The keyword you pass as search parameter will find for all the product beginning with the search keyword

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Product Id”: 228,”Product Name”: “Private Selection Egg”, “Upcnumber”: “011110843388”,”Product Category”: “Eggs & Egg Substitutes”}..]

Again, don’t forget to URL-encode!

Parameters

search: search is required parameter. For example to autocomplete product beginning with pr append &search=pr

like: https://api.inrfood.com/v3/autocomplete/product?apikey=api-key&search=pr

Skip and Limit are optional parameter used for paging.

Skip - the number of items to skip before returning anything. The LIMIT is used to limit the number of results returned in a SQL statement. So if you have 1000 rows in a table, but only want to return the first 10, you can set limit as 10. And if want to show result set from 11-20 then skip as 10 Consumer Guide for Autocomplete Product Response The following documentation is for objects returned from the autocomplete product API Call. The autocomplete API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Product Id : It is the product id for the searched product category
Product Name : List of all the result set beginning with the given search keyword
Upcnumber : Upcnumber for the searched product
Product Category : Product category for the searched product
search : This states the query parameters for the result set.

Using The Auto Complete Restaurant Api Call

Performing GET requests to autocomplete restaurant category

The base url for the /autocomplete/restaurant{?search}[{?skip}][{?limit}]}] GET is https://api.inrfood.com/v3/autocomplete/restaurant?apikey=api-key&search=search-parameter
Ski p and Limit are optional parameters
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of Search restaurant response.

Search API Semantics

Skip and Limit parameters are optional parameters
Search is required parameter
The keyword you pass as search parameter will find for all the restaurant beginning with the search keyword

The objects returned by these APIs is JSON. The structure is something like

“data”: [{“Restaurant Id”: 378,”Restaurant Name”: “Pret A Manger US”,”Phone Number”: “”,”Email Id”: “”}..]

Again, don’t forget to URL-encode!

Parameters

search: search is required parameter. For example to autocomplete restaurant beginning with pr append &search=pr

like: https://api.inrfood.com/v3/autocomplete/ restaurant?apikey=api-key&search=pr

Skip and Limit are optional parameter used for paging.

Skip - the number of items to skip before returning anything. The LIMIT is used to limit the number of results returned in a SQL statement. So if you have 1000 rows in a table, but only want to return the first 10, you can set limit as 10. And if want to show result set from 11-20 then skip as 10 Consumer Guide for Autocomplete Restaurant Response The following documentation is for objects returned from the autocomplete restaurant API Call. The autocomplete API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Restaurant Id : It is the restaurant id for the searched restaurant name
Restaurant Name : List of all the result set beginning with the given search keyword
Phone Number : Phone number for the searched restaurant
Email Id : Email Id for the searched restaurant
search : This states the query parameters for the result set.

data”: [{“Category Id”: 21,”Category Name”: “Ale”,”Parent Category”: “Alcoholic Beverages”}..]

Again, don’t forget to URL-encode!

Parameters

Id: Id is required parameter. For example to search category with id 21 append &id=21

like: https://api.inrfood.com/v3/category/id/?id=21&apikey=api-key Consumer Guide for Search Category By Id Response The following documentation is for objects returned from the search category by id API Call. The autocomplete API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Category Id : It is the category id that is searched
Category Name : Category name for the searched category
Parent Category : Parent category for the searched category
id : This states the query parameters for the result set.

Using The Category Search By Name Api Call

Performing GET requests to category search by name

The base url for the /category/name/{?name} GET is https://api.inrfood.com/v3/category/name/name=category-name&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of Search category by name response.

Search API Semantics

Name is required parameter
The name you pass as to search category, will get all the details for the corresponding category name

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Category Id”: 21,”Category Name”: “Ale”,”Parent Category”: “Alcoholic Beverages”}..]

Again, don’t forget to URL-encode!

Parameters

Name: Name is required parameter. For example to search category with name as Ale append &name=ale

like: https://api.inrfood.com/v3/category/name/?name=ale&apikey=api-key Consumer Guide for Search Category By Name Response The following documentation is for objects returned from the Search category by name API Call. The autocomplete API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Category Id : It is the category id for the searched category name
Category Name : Category name that is searched
Parent Category : Parent category for the searched category
name : This states the query parameters for the result set.

Using The Get Category List Api Call

Performing GET requests to get category list

The base url for the /category[{?skip}][{?limit}] GET is https://api.inrfood.com/v3/category?apikey=api-key
Skip and Limit are optional parameters
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get category list response.

Parameters

Skip and Limit are optional parameter used for paging.

Skip - the number of items to skip before returning anything. The LIMIT is used to limit the number of results returned in a SQL statement. So if you have 1000 rows in a table, but only want to return the first 10, you can set limit as 10. And if want to show result set from 11-20 then skip as 10 Consumer Guide for Get Category List Response The following documentation is for objects returned from the get category response API Call. The get category list API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Category Id : It is the category id for the category
Category Name : It is the corresponding category name
Categoy Status: Gives the status either active or inactive
Category Add Date : It specifies when the category was added.
Category Update Date: It specifies when the category was last updates

Concerns

Using The Get Cultural Concern List Api Call

Performing GET requests to get cultural concern list

The base url for the /concerns/cultural[{?skip}][{?limit}] GET is https://api.inrfood.com/v3/concerns/cultural?apikey=api-key
Skip and Limit are optional parameters
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get cultural concern list response.

Parameters

Skip and Limit are optional parameter used for paging.

Skip - the number of items to skip before returning anything. The LIMIT is used to limit the number of results returned in a SQL statement. So if you have 1000 rows in a table, but only want to return the first 10, you can set limit as 10. And if want to show result set from 11-20 then skip as 10 Consumer Guide for Get cultural concern List Response The following documentation is for objects returned from the get cultural concern list response API Call. The get cultural concern list API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Concern Id : It is the concern id for the cultural concern
Concern Name : It is the corresponding cultural concern name
Concern Status: Gives the status either active or inactive

Using The Get Medical Concern List Api Call

Performing GET requests to get medical concern list

The base url for the /concerns/medical[{?skip}][{?limit}] GET is https://api.inrfood.com/v3/concerns/medical?apikey=api-key
Skip and Limit are optional parameters
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of Search category response.

Parameters

Skip and Limit are optional parameter used for paging.

Skip - the number of items to skip before returning anything. The LIMIT is used to limit the number of results returned in a SQL statement. So if you have 1000 rows in a table, but only want to return the first 10, you can set limit as 10. And if want to show result set from 11-20 then skip as 10 Consumer Guide for Get Medical Concern List Response The following documentation is for objects returned from the get medical concern list response API Call. The get medical concern list API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Concern Id : It is the concern id for the medical concern
Concern Name : It is the corresponding medical concern name
Concern Status: Gives the status either active or inactive

Ingredient

Using The Ingredient Search By Name Api Call

Performing GET requests to ingredient search by name

The base url for the /ingredient/name/{?name}} GET is https://api.inrfood.com/v3/ingredient/name/name=ingredient-name&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of Search ingredient by name response.

Search API Semantics

Name is required parameter
The name you pass as to search ingredient, will get all the details for the corresponding ingredient name

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Ingredient ID”: 338646,”Item Name”: “Sugar”, “Function”: “”,”Health Effects”: “”,”Origin”: “”,”Other Uses”: “”, “Advisory”: “”}..]

Again, don’t forget to URL-encode!

Parameters

Name: Name is required parameter. For example to search ingredient with name as sugar append &name=sugar

like: https://api.inrfood.com/v3/ingredient/name/?name=sugar&apikey=api-key Consumer Guide for Search Ingredient by Name Response The following documentation is for objects returned from the Search ingredient by name API Call. The search ingredient by name API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Ingredient Id : It is the ingredient id for the searched ingredient name
Ingredient Name : Ingredient name that is searched
Function : Ingredient function for the corresponding ingredient
Health Effects : Health effects for the corresponding ingredient
Origin : Origin for the corresponding ingredient
Other Uses : Other uses for the corresponding ingredient
Advisory : Advisory for the corresponding ingredient
name : This states the query parameters for the result set.

Using The Ingredient Search By Id Api Call

Performing GET requests to ingredient search by id

The base url for the /ingredient{?id} GET is https://api.inrfood.com/v3/ingredient?id=ingredient-id&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of search ingredient by id response.

Search API Semantics

Id is required parameter
The Id you pass as to search ingredient, will get all the details for the corresponding ingredient id

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Ingredient ID”: 8,”Ingredient Name”: “Red Bell Pepper”, “Advisory Level”: “Safe”,”Category”: “Richard”,”Category 2″: null,”Created Date”: “2013-05-29T15:52:58.000Z”,”Updated Date”: “2013-05- “”,”Other Uses”: “”,”Medical Concerns”: “No”,”Cultural Concerns”: “No”}..]

Again, don’t forget to URL-encode!

Parameters

Id: Id is required parameter. For example to search ingredient with id as 8 append &id=8

like: https://api.inrfood.com/v3/ingredient/?id=8&apikey=api-key Consumer Guide for Search Ingredient by Name Response The following documentation is for objects returned from the Search ingredient by id API Call. The search ingredient by id API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Ingredient Id : Ingredient id that is searched
Ingredient Name : Ingredient name corresponding to the id
Advisory Level : Advisory level for the corresponding ingredient
Category : Category for the corresponding ingredient
Category 2 : Category 2 corresponding to ingredient
Created Date : Ingredient created date
Updated Date : Ingredient updated date
Function : Ingredient function for the corresponding ingredient
Health Effects : Health effects for the corresponding ingredient
Origin : Origin for the corresponding ingredient
Other Uses : Other uses for the corresponding ingredient
Medical Concerns : Medical concerns corresponding to the ingredient
Cultural Concerns : Cultural concerns corresponding to the ingredient
id : This states the query parameters for the result set

Using The Get Ingredient List Api Call

Performing GET requests to get ingredient list

The base url for the /ingredient[{?skip}][{?limit}] GET is https://api.inrfood.com/v3/ingredient?apikey=api-key
Skip and Limit are optional parameters
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get ingredient list response.

Parameters

Skip and Limit are optional parameter used for paging.

Skip - the number of items to skip before returning anything. The LIMIT is used to limit the number of results returned in a SQL statement. So if you have 1000 rows in a table, but only want to return the first 10, you can set limit as 10. And if want to show result set from 11-20 then skip as 10 Consumer Guide for Get ingredient List Response The following documentation is for objects returned from the get ingredient list response API Call. The get ingredient list API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Ingredient Id : It is the ingredient id for the ingredient
Ingredient Name : Ingredient name corresponding to the ingredient
Function : Ingredient function for the corresponding ingredient
Health Effects : Health effects for the corresponding ingredient
Origin : Origin for the corresponding ingredient
Other Uses : Other uses for the corresponding ingredient
Advisory : Advisory for the corresponding ingredient

Manufacturer

Using The Get Manufacturer List Api Call

Performing GET requests to get manufacturer list

The base url for the /manufacturer[{?skip}][{?limit}] GET is https://api.inrfood.com/v3/manufacturer?apikey=api-key
Skip and Limit are optional parameters
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get manufacturer list response.

Parameters

Skip and Limit are optional parameter used for paging.

Skip - the number of items to skip before returning anything. The LIMIT is used to limit the number of results returned in a SQL statement. So if you have 1000 rows in a table, but only want to return the first 10, you can set limit as 10. And if want to show result set from 11-20 then skip as 10 Consumer Guide For Get Manufacturer List Response The following documentation is for objects returned from the get manufacturer list response API Call. The get manufacturer list API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Manufacturer Id : It is the Manufacturer id for the manufacturer
Manufacturer Name : Name corresponding to the manufacturer id

Metrics

Using The Get Category Count Api Call

Performing GET requests to get category count

The base url for the /metrics/category/count GET is https://api.inrfood.com/v3/metrics/category/count?apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get category count response.

Consumer Guide for Get category count Response The following documentation is for objects returned from the get category count response API Call. The get category count API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Total Count : It gives the total count of category

Using The Get Ingredient Count Api Call

Performing GET requests to get ingredient count

The base url for the /metrics/ingredient/count GET is https://api.inrfood.com/v3/metrics/ingredient/count?apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get ingredient count response.

Consumer Guide for Get ingredient Count Response The following documentation is for objects returned from the get ingredient count response API Call. The get ingredient count API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Total Count : It gives the total count of ingredient

Using The Get Manufacturer Count Api Call

Performing GET requests to get ingredient count

The base url for the /metrics/manufacturer/count GET is https://api.inrfood.com/v3/metrics/manufacturer/count?apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get manufacturer count response.

Consumer Guide for Get Manufacturer Count Response The following documentation is for objects returned from the get manufacturer count response API Call. The get manufacturer count API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Total Count : It gives the total count of manufacturer

Using The Get Product Count Api Call

Performing GET requests to get product count

The base url for the /metrics/product/count GET is https://api.inrfood.com/v3/metrics/product/count?apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get product count response.

Consumer Guide for Get Product Count Response The following documentation is for objects returned from the get product count response API Call. The get product count API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Total Count : It gives the total count of products

Using The Get Restaurant Count Api Call

Performing GET requests to get restaurant count

The base url for the /metrics/restaurant/count GET is https://api.inrfood.com/v3/metrics/restaurant/count?apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get restaurant count response.

Consumer Guide for Get Restaurant Count Response The following documentation is for objects returned from the get restaurant count response API Call. The get restaurant count API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Total Count : It gives the total count of restaurant items

Product

Using The Get Product Fact By Id Api Call

Performing GET requests to get product fact by id

The base url for the /product/facts/{?id} GET is https://api.inrfood.com/v3/product/facts/?id=product-id&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get product fact by id response.

Search API Semantics

Id is required parameter
The Id you pass as to search product facts, will get all the details for the corresponding product id

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Product Id”: 915,”Product Name”: “The Laughing Cow Light Pasteurized Cheese Light, Queso Fresco & Chipotle Flavor 8 ea”, “Product Image”: http://inrpet.com/uploaded_files/attachmentfile/00041757054144.png”, “Serving Size Unit”: “g”, “Serving Size”: “21”,”Number Of Servings”: “168”, “Calories”: “35”,”Total fat”: “1.5”,”Saturated Fat”: “1”,”Monounsaturated Fat”: “”,”Unsaturated Fat”: “”, “Transfat”: “0”,”Cholesterol”: “5”, “Sodium”: “200”,”Potassium”: “”,”Total Carbohydrate”: “1”,”Dietary Fiber”: “0”,”Sugars”: “1”,”Protein”: “2”,”Vitamin A”: “0”,”Vitamin C”: “0”, “Calcium”: “8.00”,”Iron”: “0”}..]

Again, don’t forget to URL-encode!

Parameters

Id: Id is required parameter. For example to search product fact with id as 915 append &id=915

like: https://api.inrfood.com/v3/product/facts/?id=915&apikey=api-key Consumer Guide for Get Product Fact By Id Response The following documentation is for objects returned from the get product fact by id API Call. The get product fact by id API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Product Id : Product id that is searched
Product Name : Product name corresponding to the id
Product Image : Product Image for the corresponding product
Serving Size Unit : Unit corresponding to the product
Serving Size : Serving Size corresponding to the product.
Number of Serving : Number of serving corresponding to the product
Calories : Calories corresponding to the product
Total Fat : Total fat corresponding to the product
Saturated Fat : Saturated fat corresponding to the product
Monounsaturated Fat : Monounsaturated fat corresponding to the product
Unsaturated Fat : Unsaturated Fat corresponding to the product
Transfat : Transfat corresponding to the product
Cholesterol : Cholesterol corresponding to the product
Sodium : Sodium corresponding to the product
Potassium : Potassium corresponding to the product
Total Carbohydrate : Total carbohydrate corresponding to the product
Dietary Fibre : Dietary fibre corresponding to the product
Sugars : Sugars corresponding to the product
Protein : Protein corresponding to the product
Vitamin A : Vitamin A corresponding to the product
Vitamin C : Vitamin C corresponding to the product
Calcium : Calcium corresponding to the product
Iron : Iron corresponding to the product
id : This states the query parameters for the result set

Using The Search For Food Product By Id Api Call

Performing GET requests to search food product by id

The base url for the /product/food{?productId} GET is https://api.inrfood.com/v3/product/food?productId=product-id&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of search food product by id response.

Search API Semantics

productId is required parameter
The productId you pass as to search food products, will get all the food details for the corresponding product id

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Product Image”: “http://inrpet.com/uploaded_files/attachmentfile/00041757054144.png”, “Product ID”: 915,”Product Name”: “The Laughing Cow Light Pasteurized Cheese Light, Queso Fresco & Chipotle Flavor 8 ea”,”UPC”: “041757054144”, “Category”: “Cheese”,”Created Date”: “2013-02-09T00:23:48.000Z”, “Updated Date”: “2014-11-07T15:05:10.000Z”,”Manufacturer”: “Bel Brands USA”}..]

Again, don’t forget to URL-encode!

Parameters

productId : productId is required parameter. For example to search food product with productId as 915 append & productId =915

like: https://api.inrfood.com/v3/product/food/?productId=915&apikey=api-key Consumer Guide for Search Food Product By Id Response The following documentation is for objects returned from the get food product by id API Call. The get food product by id API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Product Image : Product Image for the corresponding product Id
Product Id : Product id that is searched
Product Name : Product name corresponding to the id
UPC : UPC number corresponding to the product
Category : Category corresponding to the product
Created Date : It corresponds to product created date
Updated Date : It corresponds to product updated date
Manufacturer : It corresponds to the manufacturer for the product
productId : This states the query parameters for the result set

Using The Get Ingredient Notes For General Food Product By Id Api Call

Performing GET requests to get ingredient notes for general food product by id

The base url for the /product/generalfood/ingredient/notes{?productId} GET is https://api.inrfood.com/v3 /product/generalfood/ingredient/notes?productId=product-id&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get ingredient notes for general food product by id response.

Search API Semantics

productId is required parameter
The productId you pass as to search general food products, will get ingredient notes corresponding to product id

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Ingredient Notes”: “green onions,gingerroot,peanut oil,cream, chicken stock, rice wine, soy sauce,white pepper,cooked chicken,sesame oil, egg.” }..]

Again, don’t forget to URL-encode!

Parameters

productId : productId is required parameter. For example to get ingredient notes for product with productId as 915 append & productId =915

like: https://api.inrfood.com/v3/product/generalfood/ingredient/notes?productId=915&apikey=api-key Consumer Guide for Get Ingredient Notes for Product By Id Response The following documentation is for objects returned from the get ingredient notes for product by id API Call. The get food product by id API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Ingredient Notes : Ingredient Notes for the corresponding product Id
productId : This states the query parameters for the result set

Using The Get Nutrition Fact For General Food Product By Id Api Call

Performing GET requests to get nutrition fact for general food product by id

The base url for the /product/generalfood/nutritionfacts{?productId} GET is https://api.inrfood.com/v3/product/generalfood/nutritionfacts?productId=product-id&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get nutrition fact for general food product by id response.

Search API Semantics

productId is required parameter
The productId you pass as to search general food products, will get nutrition fact corresponding to product id

Get Metadata Dictionaries We keep dictionaries of the possible values of our search parameters which are defined in the section “Parameters”. Each parameter documented in the “Parameters” section contains a link to the corresponding metadata dictionary.

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Product Size”: “”,”Serving Size Unit”: “bowl”, “Servings Per Container”: “1”,”Calories”: “290”,”Calories From Fat”: “210”, “Total Fat”: “23”,”Unsaturated Fat”: “”,”Saturated Fat”: “12”, “Polyunsaturated Fat”: “”,”Monounsaturated Fat”: “”, “Cholesterol”: “105”, “Sodium”: “470”,”Potassium”: “290”,”Total Carbohydrates”: “9”,”Soluble Fiber”: “”,”Insoluble Fiber”: “”,”Dietary Fiber”: “0”,”Sugar”: “2”, “Sugar Alcohol”: “”,”Protein”: “10”}..]

Again, don’t forget to URL-encode!

Parameters

productId : productId is required parameter. For example to get nutrition fact for product with productId as 915 append & productId =915

like: https://api.inrfood.com/v3/product/generalfood/nutritionfacts?productId=915&apikey=api-key Consumer Guide for Get Nutrition Fact for Product By Id Response The following documentation is for objects returned from the get nutrition fact for product by id API Call. The get nutrition fact for product by id API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Product Size : Product size corresponding to the the product
Serving Size Unit : Unit corresponding to the product
Serving Per Container: Serving per container corresponding to the product.
Calories : Calories corresponding to the product
Total Fat : Total fat corresponding to the product
Unsaturated Fat : Unsaturated fat corresponding to the product

Saturated Fat : Saturated fat corresponding to the product
Polysaturated Fat : Polysaturated fat corresponding to the product
Monounsaturated Fat : Monounsaturated fat corresponding to the product
Cholesterol : Cholesterol corresponding to the product
Sodium : Sodium corresponding to the product
Potassium : Potassium corresponding to the product
Total Carbohydrates : Total carbohydrate corresponding to the product
Soluble Fiber : Soluble fiber corresponding to the product
Insoluble Fiber : Insoluble fiber corresponding to the product
Dietary Fiber : Dietary fibre corresponding to the product
Sugar : Sugars corresponding to the product
Sugar Alcohol : Sugar Alcohol corresponding to the product
Protein : Protein corresponding to the product
productId : This states the query parameters for the result set

Using the Get vitamins for general food product by id Api Call

Performing GET requests to get vitamins for general food product by id

The base url for the /product/generalfood/vitamins{?productId} GET is https://api.inrfood.com/v3 /product/generalfood/vitamins?productId=product-id&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get vitamins for general food product by id response.

Search API Semantics

productId is required parameter
The productId you pass as to search general food products, will get vitamins corresponding to product id

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Vitamin A”: “15.00 IU”,”Vitamin C”: “6.00 mg”, “Calcium”: “10.00 mg”,”Iron”: “4.00 mg”,”Chromium”: “”,”Copper”: “”, “Biotin (Vitamin B7)”: “”,”Chloride”: “”,”Fluoride”: “”,”Folate”: “”, “Folic Acid”: “”,”Iodine”: “”,”Magnesium”: “”,”Manganese”: “”, “Molybdenum”: “”,”Niacin (Vitamin B3)”: “”,”Pantothenic Acid (Vitamin B5)”: “”,”Phosphorus”: “”,”Riboflavin”: “”,”Selenium”: “”,”Thiamin (Vitamin B1)”: “”,”Vitamin B12″: “”,”Vitamin B6″: “”,”Vitamin D”: “”,”Vitamin E”: “”, “Vitamin K”: “”,”Zinc”: “”}..]

Again, don’t forget to URL-encode!

Parameters

productId : productId is required parameter. For example to get vitamins for product with productId as 915 append & productId =915

like: https://api.inrfood.com/v3/product/generalfood/vitamins?productId=915&apikey=api-key Consumer Guide to Get Vitamins for Product By Id Response The following documentation is for objects returned from the get vitamin for product by id API Call. The get vitamin for product by id API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Vitamin A : Vitamin A corresponding to the product
Vitamin C : Vitamin C corresponding to the product
Calcium : Calcium corresponding to the product
Iron : Iron corresponding to the product.
Chromium : Chromium corresponding to the product
Copper : Copper corresponding to the product
Biotin (Vitamin B7) : Biotin corresponding to the product
Chloride : Chloride corresponding to the product
Fluoride : Fluoride corresponding to the product
Folate : Folate corresponding to the product
Folic Acid : Folic Acid corresponding to the product
Iodine : Iodine corresponding to the product
Magnesium : Magnesium corresponding to the product
Manganese : Manganese corresponding to the product
Molybdenum : Molybdenum corresponding to the product
Niacin (Vitamin B3) : Niacin corresponding to the product
Pantothenic Acid (Vitamin B5) : Pantothenic Acid corresponding to the product
Phosphorus : Phosphorus corresponding to the product
Riboflavin : Riboflavin corresponding to the product
Selenium : Selenium corresponding to the product
Thiamin( Vitamin B1) : Thiamin corresponding to the product
Vitamin B12 : Vitamin B12 corresponding to the product
Vitamin B6 : Vitamin B6 corresponding to the product
Vitamin D : Vitamin D corresponding to the product
Vitamin E : Vitamin E corresponding to the product
Vitamin K : Vitamin K corresponding to the product
Zinc : Zinc corresponding to the product
productId : This states the query parameters for the result set

Using The Search For General Food Product By Id Api Call

Performing GET requests to search general food product by id

The base url for the /product/generalfood{?productId} GET is https://api.inrfood.com/v3 /product/generalfood?productId=product-id&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of search general food product by id response.

Search API Semantics

productId is required parameter
The productId you pass as to search general food products, will get product details corresponding to product id

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Product ID”: “GP915″,”Product Name”: “Chinese Chicken And Corn Soup”,”Category”: “Chinese”,”Created Date”: “2013-10-10T08:32:10.000Z”,”Updated Date”: “2013-10-10T08:32:10.000Z”, “Manufacturer”: “”}..]

Again, don’t forget to URL-encode!

Parameters

productId : productId is required parameter. For example to get product details corresponding with productId as 915 append & productId =915

like: https://api.inrfood.com/v3/product/generalfood?productId=915&apikey=api-key Consumer Guide to Search for General Product By Id Response The following documentation is for objects returned from the search general product by id API Call. The search general product by id API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Product Id :It corresponds to the product Id that is searched
Product Name : Product Name corresponding to the product
Category : Product category corresponding to the product
Created Date : It corresponds to the product created date
Updated Date : It corresponds to the product updated date
Manufacturer : It corresponds to the manufacturer for the product searched
productId : This states the query parameters for the result set

Using The Get Food Product Ingredient By Id Api Call

Performing GET requests to get food product ingredient by id

The base url for the /product/ingredients/{?id} GET is https://api.inrfood.com/v3/product/ingredients/?id=product-id&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get ingredient for product by id response.

Search API Semantics

id is required parameter
The id you pass as to search food products, will get ingredients for the corresponding product

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Ingredient Id”: “338861”,”Ingredient Name”: “Citric Acid” }..]

Again, don’t forget to URL-encode!

Parameters

id : id is required parameter. For example to get ingredient details corresponding with id as 915 append & id =915

like: https://api.inrfood.com/v3/product/ ingredients/?id=915&apikey=api-key Consumer Guide to get food product ingredient by id Response The following documentation is for objects returned from the get food product ingredient by id API Call. The get food product ingredient by id API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Ingredient Id : It corresponds to the ingredient id for the searched product
Ingredient Name : It corresponds to the ingredient name for the searched product
id : This states the query parameters for the result set

Using The Get Ingredient Notes For Food Product By Id Api Call

Performing GET requests to get ingredient notes for food product by id

The base url for the /product/ingredient/notes{?productId} GET is https://api.inrfood.com/v3 /product/ingredient/notes?productId=915& apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get ingredient notes for food product by id response.

Search API Semantics

productId is required parameter
The productId you pass as to search food products, will get ingredients notes for the corresponding product

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Ingredient Notes”: ” Cheddar, Queso Fresco, Semisoft Cheese ( Pasteurized Cultured Milk And Part - Skim Milk, Salt, Enzymes ) ], Whey, Water, Sodium Phosphate And Sodium Polyphosphate, Sodium Citrate, Citric Acid, Chipotle Peppers,”}..]

Again, don’t forget to URL-encode!

Parameters

productId: productId is required parameter. For example to get ingredient notes corresponding with productId as 915 append & productId=915

like: https://api.inrfood.com/v3/product/ingredient/notes?productId=915 &apikey=api-key Consumer Guide to get food product ingredient by id Response The following documentation is for objects returned from the get food product ingredient by id API Call. The get food product ingredient by id API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Ingredient Notes : It corresponds to the ingredient notes for the searched product
productId : This states the query parameters for the result set

Using The Get List Of All Product Api Call

Performing GET requests to get list of product

The base url for the /product/list[{?skip}][{?limit}] GET is https://api.inrfood.com/v3 /product/list?apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get list of product response.

Get product list Metadata Dictionaries We keep dictionaries of the possible values of our search parameters which are defined in the section “Parameters”. Each parameter documented in the “Parameters” section contains a link to the corresponding metadata dictionary.

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Product Id”: 75,”Product Name”: “Energy Shot - Berry - Extra Strength (2 Pack)”,”Upcnumber”: “041260364938”,”Product Image”: “”, “Calories”: “”,”Category”: “Energy Drinks, Shots & Chews”,”Serving Size”: “1”,”Serving Size Unit”: “bottle”}..]

Again, don’t forget to URL-encode!

Consumer Guide to get product list Response The following documentation is for objects returned from the get product list API Call. The get product list API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Product Id : Product Id for the corresponding product
Product Name : Product name for the corresponding product
Upcnumber : Upcnumber for the corresponding product
Product Image : Product image for the corresponding product
Calories : Calories for the corresponding product
Category : Category for the corresponding product
Serving Size : Serving size for the corresponding product
Serving Size Unit : Serving Size Unit for the corresponding product
productId : This states the query parameters for the result set

Using The Get Nutrition Fact For Food Product By Id Api Call

Performing GET requests to get nutrition fact for food product by id

The base url for the /product /nutritionfacts{?productId} GET is https://api.inrfood.com/v3/product /nutritionfacts?productId=product-id&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get nutrition fact for food product by id response.

Search API Semantics

productId is required parameter
The productId you pass as to search food products, will get nutrition fact corresponding to product id

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Product Size”: “”,”Serving Size Unit”: “bowl”, “Servings Per Container”: “1”,”Calories”: “290”,”Calories From Fat”: “210”, “Total Fat”: “23”,”Unsaturated Fat”: “”,”Saturated Fat”: “12”, “Polyunsaturated Fat”: “”,”Monounsaturated Fat”: “”, “Cholesterol”: “105”, “Sodium”: “470”,”Potassium”: “290”,”Total Carbohydrates”: “9”,”Soluble Fiber”: “”,”Insoluble Fiber”: “”,”Dietary Fiber”: “0”,”Sugar”: “2”, “Sugar Alcohol”: “”,”Protein”: “10”}..]

Again, don’t forget to URL-encode!

Parameters

productId : productId is required parameter. For example to get nutrition fact for product with productId as 915 append & productId =915

like: https://api.inrfood.com/v3/product/nutritionfacts?productId=915&apikey=api-key Consumer Guide for Get Nutrition Fact for Product By Id Response The following documentation is for objects returned from the get nutrition fact for product by id API Call. The get nutrition fact for product by id API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Product Size : Product size corresponding to the the product
Serving Size Unit : Unit corresponding to the product
Serving Per Container: Serving per container corresponding to the product.
Calories : Calories corresponding to the product
Total Fat : Total fat corresponding to the product
Unsaturated Fat : Unsaturated fat corresponding to the product
Saturated Fat : Saturated fat corresponding to the product
TransFat : Transfat corresponding to the product
Polysaturated Fat : Polysaturated fat corresponding to the product
Monounsaturated Fat : Monounsaturated fat corresponding to the product
Cholesterol : Cholesterol corresponding to the product
Sodium : Sodium corresponding to the product
Potassium : Potassium corresponding to the product
Total Carbohydrates : Total carbohydrate corresponding to the product
Soluble Fiber : Soluble fiber corresponding to the product
Insoluble Fiber : Insoluble fiber corresponding to the product
Dietary Fiber : Dietary fibre corresponding to the product
Sugar : Sugars corresponding to the product
Sugar Alcohol : Sugar Alcohol corresponding to the product
Protein : Protein corresponding to the product
productId : This states the query parameters for the result set

Using The Get Serving Size For Food Product By Id Api Call

Performing GET requests to get serving size for food product by id

The base url for the /product/servingsize/{?id} GET is https://api.inrfood.com/v3/product/servingsize/?id=product-id&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get serving size for food product by id response.

Search API Semantics

id is required parameter
The id you pass as to search food products, will get serving size details corresponding to product id

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Id”: 39,”Name”: “g”,”Serving Size Unit Status”: “Active”,”Add Date”: “2014-03-26T00:20:54.000Z”,”Update Date”: “2015-03-23T12:52:45.000Z”,”Product Status”: “Active”,”Other Status”: “Yes”, “General Status”: “No”}..]

Again, don’t forget to URL-encode!

Parameters

id : id is required parameter. For example to get serving size unit for product with id as 915 append & id=915

like: https://api.inrfood.com/v3/product/servingsize/?id=915&apikey=api-key Consumer Guide for Get Serving Size unit for Product By Id Response The following documentation is for objects returned from the get serving size unit for product by id API Call. The get serving size unit for product by id API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Id : Serving size unit Id for the corresponding product
Name : Serving size unit name for the corresponding product
Serving Size Unit Status : It corresponds to the unit status either active or inactive
Add Date : It corresponds to serving size unit add date
Update Date : It corresponds to serving size unit last update date
Product Status : It corresponds to serving size unit product status
Other Status : It corresponds to serving size unit other status
General Status : It corresponds to serving size unit general status
id : This states the query parameters for the result set

Using The Get Vitamins For Food Product By Id Api Call

Performing GET requests to get vitamins for food product by id

The base url for the /product/vitamins{?productId} GET is https://api.inrfood.com/v3/product/vitamins?productId=product-id&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get vitamins for food product by id response.

Search API Semantics

productId is required parameter
The productId you pass as to search food products, will get vitamins corresponding to product id

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Vitamin A”: “15.00 IU”,”Vitamin C”: “6.00 mg”, “Calcium”: “10.00 mg”,”Iron”: “4.00 mg”,”Chromium”: “”,”Copper”: “”, “Biotin (Vitamin B7)”: “”,”Chloride”: “”,”Fluoride”: “”,”Folate”: “”, “Folic Acid”: “”,”Iodine”: “”,”Magnesium”: “”,”Manganese”: “”, “Molybdenum”: “”,”Niacin (Vitamin B3)”: “”,”Pantothenic Acid (Vitamin B5)”: “”,”Phosphorus”: “”,”Riboflavin”: “”,”Selenium”: “”,”Thiamin (Vitamin B1)”: “”,”Vitamin B12″: “”,”Vitamin B6″: “”,”Vitamin D”: “”,”Vitamin E”: “”, “Vitamin K”: “”,”Zinc”: “”}..]

Again, don’t forget to URL-encode!

Parameters

productId : productId is required parameter. For example to get vitamins for product with productId as 915 append & productId =915

like: https://api.inrfood.com/v3/product/vitamins?productId=915&apikey=api-key Consumer Guide to Get Vitamins for Product By Id Response The following documentation is for objects returned from the get vitamin for product by id API Call. The get vitamin for product by id API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Vitamin A : Vitamin A corresponding to the product
Vitamin C : Vitamin C corresponding to the product
Calcium : Calcium corresponding to the product
Iron : Iron corresponding to the product.
Chromium : Chromium corresponding to the product
Copper : Copper corresponding to the product
Biotin (Vitamin B7) : Biotin corresponding to the product
Chloride : Chloride corresponding to the product
Fluoride : Fluoride corresponding to the product
Folate : Folate corresponding to the product
Folic Acid : Folic Acid corresponding to the product
Iodine : Iodine corresponding to the product
Magnesium : Magnesium corresponding to the product
Manganese : Manganese corresponding to the product
Molybdenum : Molybdenum corresponding to the product
Niacin (Vitamin B3) : Niacin corresponding to the product
Pantothenic Acid (Vitamin B5) : Pantothenic Acid corresponding to the product
Phosphorus : Phosphorus corresponding to the product
Riboflavin : Riboflavin corresponding to the product
Selenium : Selenium corresponding to the product
Thiamin( Vitamin B1) : Thiamin corresponding to the product
Vitamin B12 : Vitamin B12 corresponding to the product
Vitamin B6 : Vitamin B6 corresponding to the product
Vitamin D : Vitamin D corresponding to the product
Vitamin E : Vitamin E corresponding to the product
Vitamin K : Vitamin K corresponding to the product
Zinc : Zinc corresponding to the product
productId : This states the query parameters for the result set

Using The Search Product By Upc Number Api Call

Performing GET requests to search product by upc number

The base url for the /product/{?upc} GET is https://api.inrfood.com/v3/product/?upc=product-upc&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of search product by upc number response.

Search API Semantics

upc is required parameter
The upc you pass as to search food products, will get product details corresponding to product upc

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Product Id”: 75,”Manufacturer”: “The Kroger Co.”, “Category”: “Energy Drinks, Shots & Chews”,”Upcnumber”: “041260364938”, “Product Name”: “Energy Shot - Berry - Extra Strength (2 Pack)”, “Product Size”: “2”,”Calories”: “”,”Calories From Fat”: “”,”Total Fat”: “”, “Unsaturated Fat”: “”,”Saturated Fat”: “”,”Transfat”: “”, “Polyunsaturated Fat”: “”,”Monounsaturated Fat”: “”,”Cholesterol”: “”, “Sodium”: “”,”Potassium”: “”,”Totalcarbohydrate”: “”,”Dietary Fiber”: “”, “Sugars”: “”,”Sugar Alcohol”: “”,”Protein”: “”,”Vitamin A”: “”,”Vitamin C”: “”,”Calcium”: “”,”Chromium”: “”,”Copper”: “”,”Iron”: “”,”Biotin”: “”, “Chloride”: “”,”Fluoride”: “”,”Folate”: “1.00”,”Folic”: “”,”Folic Other”: “”,”Iodine”: “”,”Magnesium”: “”,”Manganese”: “”,”Molybdenum”: “”, “Niacin”: “40.00”,”Pantothenic Acid”: “”,”Phosphorus”: “”, “Riboflavin”: “”,”Selenium”: “”,”Thiamin”: “”,”Vitamin B12″: “1.00”,”Vitamin B6″: “40.00”,”Vitamin Cui”: “”,”Vitamin D”: “”,”vitamin E”: “”,”Vitamin K”: “”, “Zinc”: “”,”Vitamin A Other”: “”,”Vitamin C Other”: “”,”Calcium Other”: “”, “Chromium Other”: “”,”Copper Other”: “”,”Iron Other”: “”,”Biotin Other”: “”,”Chloride Other”: “”,”Fluoride Other”: “”,”Folate Other”: “4.00”, “Iodine Other”: “”,”Magnesium Other”: “”,”Manganese Other”: “”, “Molybdenum Other”: “”,”Niacin Other”: “8.00”,”Pantothenic Acid Other”: “”, “Phosphorus Other”: “”,”Riboflavin Other”: “”,”Selenium Other”: “”, “Thiamin Other”: “”,”Vitamin B12 Other”: “0.06”,”Vitamin B6 Other”: “0.80”, “Vitamin Cui Other”: “”,”Vitamin D Other”: “”,”Vitamin E Other”: “”, “Vitamin K Other”: “”,”Zinc Other”: “”,”Check Peanuts”: “”,”Check Soy”: “”, “Check Milk”: “”,”Check Eggs”: “”,”Check Treenuts”: “”,”Check Fish”: “”, “Check Meat”: “”,”Check Wheat”: “”,”Check Coconut”: “”,”Check Sesame Seeds”: “”,”Notes Desc”: “”,”Notes Ingredients”: “Niacinamide, Pyridoxine Hydrochloride, Folic Acid, Cyanocobalamin, Taurine, Glucuronolactone, Malic Acid, N - Acetyl L - Tyrosine, Cognizin Citocoline, Water, Natural Flavors, Potassium Citrate, Sucralose, Potassium Sorbate, Potassium Sorbate, Calcium Disodium Edta”,”Mark As Issue”: “”,”Attachment File”: “”, “Thumattachment File”: “”,”Add Date”: “2013-03-04T11:41:03.000Z”, “Update Date”: “2014-05-02T04:02:35.000Z”,”Status”: “Active”,”Source Status”: “Kroger”,”Soluable Fiber”: “”,”Soluable Size Unit”: “”, “Insoluable Fiber”: “”,”Insoluable Size Unit”: “”,”Carbohydrates”: “”, “Carbohydrates Size Unit”: “”,”Other Serving Size”: “”,”Products Ent Status”: “Prod”,”Product Type”: “”}..]

Again, don’t forget to URL-encode!

Parameters

upc : upc is required parameter. For example to get product details with upc as 041260364938 append & upc =041260364938

like: https://api.inrfood.com/v3/product/?upc=041260364938&apikey=api-key Consumer Guide to Search for product with upc Response The following documentation is for objects returned from the get product by upc API Call. The get product by upc API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Product Id : Product Id corresponding to the searched upc
Manufacturer : Manufacturer corresponding to the searched product
Category : Category corresponding to the searched product
Upcnumber : Upcnumber that is searched
Product Name : Product name corresponding to the searched product
Product size : Product size corresponding to the searched product
Calories : Calories corresponding to the searched product
Calories From fat : Calories from fat corresponding to the searched product
Total Fat : Total fat corresponding to the searched product
Unsaturated Fat : Unsaturated fat corresponding to the product
Saturated Fat : Saturated fat corresponding to the product
TransFat : Transfat corresponding to the product
Polysaturated Fat : Polysaturated fat corresponding to the product
Monounsaturated Fat : Monounsaturated fat corresponding to the product
Cholesterol : Cholesterol corresponding to the product
Sodium : Sodium corresponding to the product
Potassium : Potassium corresponding to the product
Total Carbohydrates : Total carbohydrate corresponding to the product
Dietary Fiber : Dietary fibre corresponding to the product
Sugar : Sugars corresponding to the product
Sugar Alcohol : Sugar Alcohol corresponding to the product
Protein : Protein corresponding to the product
Vitamin A : Vitamin A corresponding to the product
Vitamin C : Vitamin C corresponding to the product
Calcium : Calcium corresponding to the product
Chromium : Chromium corresponding to the product
Copper : Copper corresponding to the product
Iron : Iron corresponding to the product.
Biotin (Vitamin B7) : Biotin corresponding to the product
Chloride : Chloride corresponding to the product
Fluoride : Fluoride corresponding to the product
Folate : Folate corresponding to the product
Folic Acid : Folic Acid corresponding to the product
Iodine : Iodine corresponding to the product
Magnesium : Magnesium corresponding to the product
Manganese : Manganese corresponding to the product
Molybdenum : Molybdenum corresponding to the product
Niacin (Vitamin B3) : Niacin corresponding to the product
Pantothenic Acid (Vitamin B5) : Pantothenic Acid corresponding to the product
Phosphorus : Phosphorus corresponding to the product
Riboflavin : Riboflavin corresponding to the product
Selenium : Selenium corresponding to the product
Thiamin( Vitamin B1) : Thiamin corresponding to the product
Vitamin B12 : Vitamin B12 corresponding to the product
Vitamin B6 : Vitamin B6 corresponding to the product
Vitamin Cui : Vitamin Cui corresponding to the product
Vitamin D : Vitamin D corresponding to the product
Vitamin E : Vitamin E corresponding to the product
Vitamin K : Vitamin K corresponding to the product
Zinc : Zinc corresponding to the product
Vitamin A Other : Vitamin A other corresponding to the product
Vitamin C Other : Vitamin C other corresponding to the product
Calcium Other : Calcium other corresponding to the product
Chromium Other : Chromium other corresponding to the product
Copper Other : Copper other corresponding to the product
Iron Other : Iron other corresponding to the product
Biotin Other : Biotin other corresponding to the product
Chloride Other : Chloride other corresponding to the product
Fluoride Other : Fluoride other corresponding to the product
Folate Other : Folate other corresponding to the product
Iodine Other : Iodine other corresponding to the product
Magnesium Other : Magnesium other corresponding to the product
Manganese Other : Manganese other corresponding to the product
Molybdenum Other : Molybdenum other corresponding to the product
Niacin Other : Niacin other corresponding to the product
Pantothenic Acid Other : Panthothenic Acid Other corresponding to the product
Phosphorus Other : Phosphorus other corresponding to the product
Riboflavin Other : Riboflavin other corresponding to the product
Selenium Other : Selenium other corresponding to the product
Thiamin Other : Thiamin other corresponding to the product
Vitamin B12 Other : Vitamin B12 other corresponding to the product
Vitamin B6 Other : Vitamin B6 other corresponding to the product
Vitamin Cui Other : Vitamin cui other corresponding to the product
Vitamin D Other : Vitamin D other corresponding to the product
Vitamin E Other : Vitamin E other corresponding to the product
Vitamin K Other : Vitamin K other corresponding to the product
Zinc Other : Zinc other corresponding to the product
Check Peanuts : Check peanuts corresponding to the product
Check Soy : Check soy corresponding to the product
Check Milk : Check milk corresponding to the product
Check Eggs : check eggs corresponding to the product
Check Treenuts : Check treenuts corresponding to the product
Check Fish : check fish corresponding to the product
Check Meat : Check meat corresponding to the product
Check Wheat : Check wheat corresponding to the product
Check Coconut : Check coconut corresponding to the product
Check Sesame Seeds : Check sesame seeds corresponding to the product
Notes Desc : Notes description corresponding to the product
Notes Ingredients : Notes ingredients corresponding to the product
Mark As Issue : Mark as issue corresponding to the product
Attachment File : Attachment file corresponding to the product
Thumattachment File : Thumb attachment file corresponding to the product
Add Date : Product add date
Update Date : Product last updated date
Status : Product status like active, inactive
Source Status : Product source status
Soluble Fibre : Soluble fibre corresponding to the product
Soluble Size Unit : Soluble size unit corresponding to the product
Insoluble Fibre : Insoluble fibre corresponding to the product
Insoluble Size Unit : Insoluble size unit corresponding to the product
Carbohydrates : Carbohydrates corresponding to the product
Carbohydrates Size Unit : Carbohydrates size unit corresponding to the product
Other Serving Size : Other serving size corresponding to the product
Product Ent Status : Ent Status corresponding to the product
Product Type : Type corresponding to the product
productId : This states the query parameters for the result set

Using The Get Product By Category Api Call

Performing GET requests to get product by category

The base url for the /product{?category}[{?skip}][{?limit}] GET is https://api.inrfood.com/v3/product/?category=category&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get product by category response.

Search API Semantics

1. category is required parameter

The category you pass as to search food products, will get products details for the searched category

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Product Id”: 54774,”Product Name”: “Beer, Gluten Free, Off Grid Pale Ale”,”Product Image”: “http://inrpet.com/uploaded_files/attachmentfile/00851858002049.jpg”, “Category”: “Ale”,”Serving Size Unit”: “oz”,”Serving Size”: “12”},..]

Again, don’t forget to URL-encode!

Parameters

category: category is required parameter. For example to get product details for category as ale append &category=ale

like: https://api.inrfood.com/v3/product?category=ale&apikey=api-key Consumer Guide for Get Product By Category Response The following documentation is for objects returned from the get product by category API Call. The get product by category API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Product Id : Product Id for the corresponding product
Product Name : Product name for the corresponding product
Product Image : Product image url for the corresponding product
Category : Category corresponding to the product
Serving Size Unit : Serving size unit for the corresponding product
Serving Size : Serving size for the corresponding product
category : This states the query parameters for the result set

Using The Search Food Product By Name Api Call

Performing GET requests to search food product by name

The base url for the /product{?name} GET is https://api.inrfood.com/v3/product/?name=product-name&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of search product by name response.

Search API Semantics

name is required parameter
The name you pass as to search food products, will get product details corresponding to product name

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Product Id”: 191286,”Manufacturer”: “The Kroger Co.”, “Category”: “Energy Drinks, Shots & Chews”,”Upcnumber”: “041260364938”, “Product Name”: “Energy Shot - Berry - Extra Strength (2 Pack)”, “Product Size”: “2”,”Calories”: “”,”Calories From Fat”: “”,”Total Fat”: “”, “Unsaturated Fat”: “”,”Saturated Fat”: “”,”Transfat”: “”, “Polyunsaturated Fat”: “”,”Monounsaturated Fat”: “”,”Cholesterol”: “”, “Sodium”: “”,”Potassium”: “”,”Totalcarbohydrate”: “”,”Dietary Fiber”: “”, “Sugars”: “”,”Sugar Alcohol”: “”,”Protein”: “”,”Vitamin A”: “”,”Vitamin C”: “”,”Calcium”: “”,”Chromium”: “”,”Copper”: “”,”Iron”: “”,”Biotin”: “”, “Chloride”: “”,”Fluoride”: “”,”Folate”: “1.00”,”Folic”: “”,”Folic Other”: “”,”Iodine”: “”,”Magnesium”: “”,”Manganese”: “”,”Molybdenum”: “”, “Niacin”: “40.00”,”Pantothenic Acid”: “”,”Phosphorus”: “”, “Riboflavin”: “”,”Selenium”: “”,”Thiamin”: “”,”Vitamin B12″: “1.00”,”Vitamin B6″: “40.00”,”Vitamin Cui”: “”,”Vitamin D”: “”,”vitamin E”: “”,”Vitamin K”: “”, “Zinc”: “”,”Vitamin A Other”: “”,”Vitamin C Other”: “”,”Calcium Other”: “”, “Chromium Other”: “”,”Copper Other”: “”,”Iron Other”: “”,”Biotin Other”: “”,”Chloride Other”: “”,”Fluoride Other”: “”,”Folate Other”: “4.00”, “Iodine Other”: “”,”Magnesium Other”: “”,”Manganese Other”: “”, “Molybdenum Other”: “”,”Niacin Other”: “8.00”,”Pantothenic Acid Other”: “”, “Phosphorus Other”: “”,”Riboflavin Other”: “”,”Selenium Other”: “”, “Thiamin Other”: “”,”Vitamin B12 Other”: “0.06”,”Vitamin B6 Other”: “0.80”, “Vitamin Cui Other”: “”,”Vitamin D Other”: “”,”Vitamin E Other”: “”, “Vitamin K Other”: “”,”Zinc Other”: “”,”Check Peanuts”: “”,”Check Soy”: “”, “Check Milk”: “”,”Check Eggs”: “”,”Check Treenuts”: “”,”Check Fish”: “”, “Check Meat”: “”,”Check Wheat”: “”,”Check Coconut”: “”,”Check Sesame Seeds”: “”,”Notes Desc”: “”,”Notes Ingredients”: “Niacinamide, Pyridoxine Hydrochloride, Folic Acid, Cyanocobalamin, Taurine, Glucuronolactone, Malic Acid, N - Acetyl L - Tyrosine, Cognizin Citocoline, Water, Natural Flavors, Potassium Citrate, Sucralose, Potassium Sorbate, Potassium Sorbate, Calcium Disodium Edta”,”Mark As Issue”: “”,”Attachment File”: “”, “Thumattachment File”: “”,”Add Date”: “2013-03-04T11:41:03.000Z”, “Update Date”: “2014-05-02T04:02:35.000Z”,”Status”: “Active”,”Source Status”: “Kroger”,”Soluable Fiber”: “”,”Soluable Size Unit”: “”, “Insoluable Fiber”: “”,”Insoluable Size Unit”: “”,”Carbohydrates”: “”, “Carbohydrates Size Unit”: “”,”Other Serving Size”: “”,”Products Ent Status”: “Prod”,”Product Type”: “”}..]

Again, don’t forget to URL-encode!

Parameters

name : name is required parameter. For example to get product details with name as dairy milk append &name=dairy%20milk

like: https://api.inrfood.com/v3/product?name=dairy%20milk&apikey=api-key Consumer Guide to Search for product by name Response The following documentation is for objects returned from the get product by name API Call. The get product by name API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Product Id : Product Id corresponding to the searched name
Manufacturer : Manufacturer corresponding to the searched product
Category : Category corresponding to the searched product
Upcnumber : Upcnumber that is searched
Product Name : Product name that was searched
Product size : Product size corresponding to the searched product
Calories : Calories corresponding to the searched product
Calories From fat : Calories from fat corresponding to the searched product
Total Fat : Total fat corresponding to the searched product
Unsaturated Fat : Unsaturated fat corresponding to the product
Saturated Fat : Saturated fat corresponding to the product
TransFat : Transfat corresponding to the product
Polysaturated Fat : Polysaturated fat corresponding to the product
Monounsaturated Fat : Monounsaturated fat corresponding to the product
Cholesterol : Cholesterol corresponding to the product
Sodium : Sodium corresponding to the product
Potassium : Potassium corresponding to the product
Total Carbohydrates : Total carbohydrate corresponding to the product
Dietary Fiber : Dietary fibre corresponding to the product
Sugar : Sugars corresponding to the product
Sugar Alcohol : Sugar Alcohol corresponding to the product
Protein : Protein corresponding to the product
Vitamin A : Vitamin A corresponding to the product
Vitamin C : Vitamin C corresponding to the product
Calcium : Calcium corresponding to the product
Chromium : Chromium corresponding to the product
Copper : Copper corresponding to the product
Iron : Iron corresponding to the product.
Biotin (Vitamin B7) : Biotin corresponding to the product
Chloride : Chloride corresponding to the product
Fluoride : Fluoride corresponding to the product
Folate : Folate corresponding to the product
Folic Acid : Folic Acid corresponding to the product
Iodine : Iodine corresponding to the product
Magnesium : Magnesium corresponding to the product
Manganese : Manganese corresponding to the product
Molybdenum : Molybdenum corresponding to the product
Niacin (Vitamin B3) : Niacin corresponding to the product
Pantothenic Acid (Vitamin B5) : Pantothenic Acid corresponding to the product
Phosphorus : Phosphorus corresponding to the product
Riboflavin : Riboflavin corresponding to the product
Selenium : Selenium corresponding to the product
Thiamin( Vitamin B1) : Thiamin corresponding to the product
Vitamin B12 : Vitamin B12 corresponding to the product
Vitamin B6 : Vitamin B6 corresponding to the product
Vitamin Cui : Vitamin Cui corresponding to the product
Vitamin D : Vitamin D corresponding to the product
Vitamin E : Vitamin E corresponding to the product
Vitamin K : Vitamin K corresponding to the product
Zinc : Zinc corresponding to the product
Vitamin A Other : Vitamin A other corresponding to the product
Vitamin C Other : Vitamin C other corresponding to the product
Calcium Other : Calcium other corresponding to the product
Chromium Other : Chromium other corresponding to the product
Copper Other : Copper other corresponding to the product
Iron Other : Iron other corresponding to the product
Biotin Other : Biotin other corresponding to the product
Chloride Other : Chloride other corresponding to the product
Fluoride Other : Fluoride other corresponding to the product
Folate Other : Folate other corresponding to the product
Iodine Other : Iodine other corresponding to the product
Magnesium Other : Magnesium other corresponding to the product
Manganese Other : Manganese other corresponding to the product
Molybdenum Other : Molybdenum other corresponding to the product
Niacin Other : Niacin other corresponding to the product
Pantothenic Acid Other : Panthothenic Acid Other corresponding to the product
Phosphorus Other : Phosphorus other corresponding to the product
Riboflavin Other : Riboflavin other corresponding to the product
Selenium Other : Selenium other corresponding to the product
Thiamin Other : Thiamin other corresponding to the product
Vitamin B12 Other : Vitamin B12 other corresponding to the product
Vitamin B6 Other : Vitamin B6 other corresponding to the product
Vitamin Cui Other : Vitamin cui other corresponding to the product
Vitamin D Other : Vitamin D other corresponding to the product
Vitamin E Other : Vitamin E other corresponding to the product
Vitamin K Other : Vitamin K other corresponding to the product
Zinc Other : Zinc other corresponding to the product
Check Peanuts : Check peanuts corresponding to the product
Check Soy : Check soy corresponding to the product
Check Milk : Check milk corresponding to the product
Check Eggs : check eggs corresponding to the product
Check Treenuts : Check treenuts corresponding to the product
Check Fish : check fish corresponding to the product
Check Meat : Check meat corresponding to the product
Check Wheat : Check wheat corresponding to the product
Check Coconut : Check coconut corresponding to the product
Check Sesame Seeds : Check sesame seeds corresponding to the product
Notes Desc : Notes description corresponding to the product
Notes Ingredients : Notes ingredients corresponding to the product
Mark As Issue : Mark as issue corresponding to the product
Attachment File : Attachment file corresponding to the product
Thumattachment File : Thumb attachment file corresponding to the product
Add Date : Product add date
Update Date : Product last updated date
Status : Product status like active, inactive
Source Status : Product source status
Soluble Fibre : Soluble fibre corresponding to the product
Soluble Size Unit : Soluble size unit corresponding to the product
Insoluble Fibre : Insoluble fibre corresponding to the product
Insoluble Size Unit : Insoluble size unit corresponding to the product
Carbohydrates : Carbohydrates corresponding to the product
Carbohydrates Size Unit : Carbohydrates size unit corresponding to the product
Other Serving Size : Other serving size corresponding to the product
Product Ent Status : Ent Status corresponding to the product
Product Type : Type corresponding to the product
productId : This states the query parameters for the result set

Restaurant

Using The Get Restaurant Allergens By Restaurant Id Api Call

Performing GET requests to get restaurant allergens by restaurant id

The base url for the /restaurant/Allergens{?restaurantId} GET is https://api.inrfood.com/v3 /restaurant/Allergens?restaurantId=RestaurantId& apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get restaurant allergens by id response.

Search API Semantics

restaurantId is required parameter
The restaurantId you pass as to search allergens, will get allergens for the correspondinf restaurant

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Allergens”: “Animal Fats”,”Status”: “No”}..]

Again, don’t forget to URL-encode!

Parameters

restaurantId : restaurantId is required parameter. For example to get allergens corresponding with restaurantId as 1 append &restaurantId=1

like: https://api.inrfood.com/v3/restaurant/Allergens?restaurantId=1&apikey=api-key Consumer Guide to get restaurant allergens by restaurant id Response The following documentation is for objects returned from the get restaurant allergens by restaurant id API Call. The get restaurant allergens by restaurant id API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Allergens : It corresponds to the allergens for the restaurant Id that is searched
Status : It corresponds to status yes if allergen is present for the restaurant else the status as No
restaurantId: This states the query parameters for the result set

Using The Search Restaurant By Id Api Call

Performing GET requests to search restaurant by id

The base url for the /restaurant/id/{?id} GET is https://api.inrfood.com/v3/restaurant/id/?id=RestaurantId& apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get restaurant by id response.

Search API Semantics

restaurantId is required parameter
The restaurantId you pass as to search allergens, will get allergens for the correspondinf restaurant

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Restaurant Id”: 1,”Restaurant Name”: “Bites”,”Rest Login Name”: “bites”,”Rest Password”: “52889b88d11c3″,”Rest First Name”: “”, “Rest Last Name”: “”,”Rest Address”: “”,”Rest Gender”: “”,”Rest Phone Number”: “”,”Rest Status”: “Active”,”Contact Email Id”: “”,”Rest City”: “”, “Rest State”: “”,”Rest Country”: “”,”Rest Zip”: “”,”Join Date”: “2013-11-17T22:03:44.000Z”,”Contact Person”: “”,”Contact Numbers”: “”,”Rest Notes”: “”,”IAccept”: “”,”Restaurant Image”: “http://inrpet.com/uploaded_files/restaurantimage/528dc0ebb51f8Bites.jpg”, “Last Login Time”: “2014-10-06T10:03:03.000Z”,”Add Date”: “2013-11-17T22:03:44.000Z”,”Update Date”: “2013-11-21T08:14:35.000Z”}..]

Again, don’t forget to URL-encode!

Parameters

id : id is required parameter. For example to get restaurant details corresponding with id as 1 append &id=1

like: https://api.inrfood.com/v3/restaurant/id/?id=1&apikey=api-key Consumer Guide to get restaurant by id Response The following documentation is for objects returned from the get restaurant by id API Call. The get restaurant by id API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Restaurant Id : It corresponds to the restaurant id that is serached
Restaurant Name : It corresponds to the restaurant name for the searched restaurant
Rest Login Name : It corresponds to restaurant login name for the restaurant
Rest Password : It corresponds to restaurant password
Rest First Name : It corresponds to restaurant first name
Rest Last Name : It corresponds to restaurant last name
Rest Address : It corresponds to restaurant address
Rest Gender : It corresponds to restaurant gender
Rest Phone Number : It corresponds to restaurant phone number
Rest Status : It corresponds to restaurant status
Contact Email Id : It corresponds to email id for the restaurant
Rest City : It corresponds to restaurant city
Rest State : It corresponds to restaurant state
Rest Country : It corresponds to restaurant country
Rest Zip : It corresponds to restaurant zip
Join Date : It corresponds to restaurant join date
Contact Person : It corresponds to contact person for the restaurant
Contact Number : It corresponds to contact numbers for the restaurant
Rest Notes : It corresponds to restaurant notes
IAccept : It corresponds to IAccept for the restaurant
Restaurant Image : It corresponds to the url for the image
User Type : It corresponds to the user type for the restaurant
Last Login Time : It corresponds to last login time for the restaurant
Add Date : It corresponds to restaurant add date
Update Date : It corresponds to the last update date for the restaurant
id: This states the query parameters for the result set

Using The Get Ingredient Notes For The Restaurant Item By Id Api Call

Performing GET requests to get ingredient notes for the restaurant item by id

The base url for the /restaurant/ingredient/notes{?id} GET is https://api.inrfood.com/v3/restaurant/ingredient/notes?id=ItemId& apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get ingredient notes for restaurant by item id response.

Search API Semantics

id is required parameter
The id you pass as to search restaurant item allergens, will get ingredient notes for the corresponding restaurant item

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Ingredient Notes”: “Water, vinegar, high fructose corn syrup, corn syrup, salt, containsrnless than 2% of Parmesan cheese (part-skim milk, cheese culture, salt, enzymes), garlic, onion juice,rnwhey, phosphoric acid, xanthan gum, potassium sorbate and calcium disodium EDTA as preservatives,rnyeast extract, spice, dried bell peppers, lemon juice concentrate, dried garlic, dried buttermilk, caramelrncolor, sodium phosphates, enzymes, oleoresin paprika. Contains milk.”}..]

Again, don’t forget to URL-encode!

Parameters

id : id is required parameter. For example to get ingredient notes for restaurant item corresponding with item id as 1 append &id=1

like: https://api.inrfood.com/v3/restaurant/ingredient/notes??id=1&apikey=api-key Consumer Guide to get ingredient notes for restaurant by item id Response The following documentation is for objects returned from the get ingredient notes for restaurant by item id API Call. The get ingredient notes for restaurant by item id API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Ingredient Notes : Ingredient notes corresponding to the item id searched
id: This states the query parameters for the result set

Using The Search For Restaurant By Name Api Call

Performing GET requests to search restaurant by name

The base url for the /restaurant/name/{?name} GET is https://api.inrfood.com/v3/restaurant/name/?name=restaurant-name&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of search for restaurant by name response.

Search API Semantics

name is required parameter
The name you pass as to search restaurant, will get restaurant details corresponding to the restaurant name

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Restaurant Id”: 1,”Restaurant Name”: “Bites”, “Restaurant Image”: “http://inrpet.com/uploaded_files/restaurantimage/528dc0ebb51f8Bites.jpg”}..]

Again, don’t forget to URL-encode!

Parameters

name : name is required parameter. For example to search restaurant by name corresponding with name as bites append &name=bites

like: https://api.inrfood.com/v3/restaurant/name/?name=bites&apikey=api-key Consumer Guide to get restaurant item by name Response The following documentation is for objects returned from the search restaurant by name API Call. The search restaurant by name API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Restaurant Id : It corresponds to the restaurant id for the searched restaurant
Restaurant Name : It corresponds to the searched restaurant name
Restaurant Image : It corresponds to the restaurant image for the searched restaurant
name: This states the query parameters for the result set

Using The Get Nutrition Facts For The Restaurant Item By Id Api Call

Performing GET requests to get nutrition fact for the searched restaurant item

The base url for the /restaurant/nutritionfacts{?id} GET is https://api.inrfood.com/v3/restaurant/nutritionfacts?id=1restaurant-id&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get nutrition fact for restaurant item by id response.

Search API Semantics

id is required parameter
The id you pass as to search restaurant item, will get nutrition fact for corresponding restaurant item

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Calories”: “640”,”Calories From Fat”: “160”,”Total Fat”: “18”,”Saturated Fat”: “8”,”Trans Fat”: “0”,”Cholesterol”: “40”, “Sodium”: “1,300”,”Total Carbohydrates”: “86”,”Dietary Fiber”: “10”, “Sugar”: “16”,”Protein”: “30”}..]

Again, don’t forget to URL-encode!

Parameters

id : id is required parameter. For example to get nutrition facts for restaurant by id corresponding with id as 1 append &id=1

like: https://api.inrfood.com/v3/restaurant/nutritionfacts?id=1&apikey=api-key Consumer Guide To Get Nutrition Fact For Restaurant Item By Id Response The following documentation is for objects returned from the get nutrition fact for restaurant item by id API Call. The get nutrition fact for restaurant item by id API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Calories : It corresponds to the calories for the searched restaurant item
Calories From Fat : It corresponds to the calories from fat for the searched restaurant item
Total Fat : It corresponds to the total fat the searched restaurant item
Transfat : It corresponds to the trans fat for the searched restaurant item
Cholesterol : It corresponds to the cholesterol for the searched restaurant item
Sodium : It corresponds to the sodium for the searched restaurant item
Total Carbohydrates : It corresponds to the carbohydrates for the searched restaurant item
Dietary Fiber : It corresponds to the dietary fiber for the searched restaurant item
Sugar : It corresponds to the sugar for the searched restaurant item
Protein : It corresponds to the protein for the searched restaurant item
id: This states the query parameters for the result set

Using The Search Restaurant Product By Id Api Call

Performing GET requests to search restaurant product by id

The base url for the /restaurant/product{?id} GET is https://api.inrfood.com/v3/restaurant/product?id=1restaurant-id&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get restaurant product by id response.

Search API Semantics

id is required parameter
The id you pass as to search restaurant, will get product corresponding to the restaurant

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Calories”: “640”,”Calories From Fat”: “160”,”Total Fat”: “18”,”Saturated Fat”: “8”,”Trans Fat”: “0”,”Cholesterol”: “40”, “Sodium”: “1,300”,”Total Carbohydrates”: “86”,”Dietary Fiber”: “10”, “Sugar”: “16”,”Protein”: “30”}..]

Again, don’t forget to URL-encode!

Parameters

id : id is required parameter. For example to get product for restaurant corresponding with is as 1 append &id=1

like: https://api.inrfood.com/v3/restaurant/product?id=1&apikey=api-key Consumer Guide To Search Restaurant Product By Id Response The following documentation is for objects returned from the search restaurant product by id API Call. The get restaurant product by id API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Product Id : It corresponds to the product id that is searched
Item Name : Item name corresponds to restaurant item name for the searched item
Category : It corresponds to the restaurant item category
Created Date : It corresponds to the restaurant product created date
Updated Date : It corresponds to the restaurant item last updated date
Restaurant : It corresponds to the restaurant id
id: This states the query parameters for the result set

Using The Search Restaurant Vitamins By Id Api Call

Performing GET requests to search restaurant vitamins by id

The base url for the /restaurant/vitamins{?id} GET is https://api.inrfood.com/v3/restaurant/vitamins?id=1restaurant-id&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get restaurant vitamins by id response.

Search API Semantics

id is required parameter
The id you pass as to search restaurant, will get vitamin details corresponding to the restaurant

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Vitamin A”: “15 IU”,”Vitamin C”: “15 mg”,”Calcium”: “60 mg”,”Iron”: “30 mg”}..]

Again, don’t forget to URL-encode!

Parameters

id : id is required parameter. For example to get vitamin details for restaurant corresponding with is as 1 append &id=1

like: https://api.inrfood.com/v3/restaurant/vitamins?id=1&apikey=api-key Consumer Guide To Search Restaurant Vitamins By Id Response The following documentation is for objects returned from the search restaurant product by id API Call. The get restaurant vitamins by id API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Vitamin A : Vitamin A for the corresponding restaurant item
Vitamin C : Vitamin C for the corresponding restaurant item
Calcium : Calcium for the corresponding restaurant item
Iron : Iron for the corresponding restaurant item
id: This states the query parameters for the result set

Using The Get Restaurant List Api Call

Performing GET requests to get restaurant list

The base url for the /restaurant[{?skip}][{?limit}] GET is https://api.inrfood.com/v3/restaurant?apikey=api-key
Skip and Limit are optional parameters
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of get restaurant list response.

Parameters

Skip and Limit are optional parameter used for paging.

Skip - the number of items to skip before returning anything. The LIMIT is used to limit the number of results returned in a SQL statement. So if you have 1000 rows in a table, but only want to return the first 10, you can set limit as 10. And if want to show result set from 11-20 then skip as 10 Consumer Guide For Get Restaurant List Response The following documentation is for objects returned from the get restaurant response API Call. The get restaurant list API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Restaurant Id : It corresponds to the restaurant id that is serached
Restaurant Name : It corresponds to the restaurant name for the searched restaurant
Rest Login Name : It corresponds to restaurant login name for the restaurant
Rest Password : It corresponds to restaurant password
Rest First Name : It corresponds to restaurant first name
Rest Last Name : It corresponds to restaurant last name
Rest Address : It corresponds to restaurant address
Rest Gender : It corresponds to restaurant gender
Rest Phone Number : It corresponds to restaurant phone number
Rest Status : It corresponds to restaurant status
Contact Email Id : It corresponds to email id for the restaurant
Rest City : It corresponds to restaurant city
Rest State : It corresponds to restaurant state
Rest Country : It corresponds to restaurant country
Rest Zip : It corresponds to restaurant zip
Join Date : It corresponds to restaurant join date
Contact Person : It corresponds to contact person for the restaurant
Contact Number : It corresponds to contact numbers for the restaurant
Rest Notes : It corresponds to restaurant notes
IAccept : It corresponds to IAccept for the restaurant
Restaurant Image : It corresponds to the url for the image
User Type : It corresponds to the user type for the restaurant
Last Login Time : It corresponds to last login time for the restaurant
Add Date : It corresponds to restaurant add date
Update Date : It corresponds to the last update date for the restaurant

Search

Using The Search Product Name Api Call

Performing GET requests to search product name api call

The base url for the /search/product{?name}[{?skip}][{?limit}] GET is https://api.inrfood.com/v3/search/product?name=product-name&apikey=api-key
Don’t forget to URL-encode parameter names and values (i.e., [ and ] become %5B and %5D).
This sample illustrates the structure of search product name response.

Search API Semantics

name is required parameter
The name you pass as to search product , will get product details for all the product corresponding to the name appearing anywhere in product name

The objects returned by these APIs is JSON. The structure is something like

{“data”: [{“Product Id”: 383,”Product Name”: “Genuine Muscle Milk Light”,”Upcnumber”: “876063005166”,”Product Category”: “Nutritional & Protein Drinks”}..]

Again, don’t forget to URL-encode!

Parameters

name : name is required parameter. For example to get products with keywords as milk append &name=milk

like: https://api.inrfood.com/v3/search/product?name=milk&apikey=api-key Consumer Guide To Search Product By Name Response The following documentation is for objects returned from the search product by name API Call. The search product by name API response objects consist of:

attribution : see Attribution Requirements Always present in response.
Product Id : Product Id corresponding to the product
Product Name : Product name corresponding to the product
Upcnumber : Upcnumber corresponding to the product
Product Category : Product category corresponding to the product
name: This states the query parameters for the result set

INRFOOD Data API Documentation

MENU

About The API

Developers Requirement

1- Authentication

2- Attribution Requirements

Error Codes

Api Calls

Autocomplete

Using The Auto Complete Category Api Call

Performing GET requests to autocomplete category name

Using The Auto Complete Cultural Concern Api Call

Performing GET requests to autocomplete cultural concerns

Using The Auto Complete Medical Concern Api Call

Performing GET requests to autocomplete medical concerns

{“data”: [{“Concern Id”: 1,”Concern Name”: “Heart Disease (Hea)”},..]

Using The Auto Complete Ingredient Api Call

Performing GET requests to autocomplete ingredient

{“data”: [{“Ingredient Id”: 82,”Ingredient Name”: “Processed Wheat”}, ..]

Using The Auto Complete Manufacturer Api Call

Performing GET requests to autocomplete manufacturer

{“data”: [{“Manufacturer Id”: 13278,”Manufacturer Name”: “PRA Ltd.”}..]

Using The Auto Complete Product Category Api Call

Performing GET requests to autocomplete product category

{“data”: [{“Product Id”: 638,”Product Name”: “Pure Protein Natural Whey Protein”, “Product Category”: “Protein, Whey & Nutritionals”}..]

Using The Auto Complete Product Api Call

Performing GET requests to autocomplete product category

{“data”: [{“Product Id”: 228,”Product Name”: “Private Selection Egg”, “Upcnumber”: “011110843388”,”Product Category”: “Eggs & Egg Substitutes”}..]

Using The Auto Complete Restaurant Api Call

Performing GET requests to autocomplete restaurant category

“data”: [{“Restaurant Id”: 378,”Restaurant Name”: “Pret A Manger US”,”Phone Number”: “”,”Email Id”: “”}..]

Category

Using The Category Search By Id Api Call

Performing GET requests to category search by id

data”: [{“Category Id”: 21,”Category Name”: “Ale”,”Parent Category”: “Alcoholic Beverages”}..]

Using The Category Search By Name Api Call

Performing GET requests to category search by name

{“data”: [{“Category Id”: 21,”Category Name”: “Ale”,”Parent Category”: “Alcoholic Beverages”}..]

Using The Get Category List Api Call

Performing GET requests to get category list

Concerns

Using The Get Cultural Concern List Api Call

Performing GET requests to get cultural concern list

Using The Get Medical Concern List Api Call

Performing GET requests to get medical concern list

Ingredient

Using The Ingredient Search By Name Api Call

Performing GET requests to ingredient search by name

{“data”: [{“Ingredient ID”: 338646,”Item Name”: “Sugar”, “Function”: “”,”Health Effects”: “”,”Origin”: “”,”Other Uses”: “”, “Advisory”: “”}..]

Using The Ingredient Search By Id Api Call

Performing GET requests to ingredient search by id

Using The Get Ingredient List Api Call

Performing GET requests to get ingredient list

Manufacturer

Using The Get Manufacturer List Api Call

Performing GET requests to get manufacturer list

Metrics

Using The Get Category Count Api Call

Performing GET requests to get category count

Using The Get Ingredient Count Api Call

Performing GET requests to get ingredient count

Using The Get Manufacturer Count Api Call

Performing GET requests to get ingredient count

Using The Get Product Count Api Call

Performing GET requests to get product count

Using The Get Restaurant Count Api Call

Performing GET requests to get restaurant count

Product

Using The Get Product Fact By Id Api Call

Performing GET requests to get product fact by id

Using The Search For Food Product By Id Api Call

Performing GET requests to search food product by id

Using The Get Ingredient Notes For General Food Product By Id Api Call

Performing GET requests to get ingredient notes for general food product by id

{“data”: [{“Ingredient Notes”: “green onions,gingerroot,peanut oil,cream, chicken stock, rice wine, soy sauce,white pepper,cooked chicken,sesame oil, egg.” }..]

Using The Get Nutrition Fact For General Food Product By Id Api Call

Performing GET requests to get nutrition fact for general food product by id

Using the Get vitamins for general food product by id Api Call

Performing GET requests to get vitamins for general food product by id

Using The Search For General Food Product By Id Api Call