Routes & Descriptions

Get Product By Product Code

Summary

Given a product code, such as 698241110109 from UPC/Barcode scanning, get the detailed information and nutrients of the corresponding food product.

Get Food By Product Code

get food by product code

GEThttps://api.passiolife.com/v2/products/napi/food/productCode/{productCode}

Path parameters

productCode*string

product code

Query parameters

Response

200400404429500

OK

Body

application/json

brandNamestring

Optional brandname pertinent to this food entity.

brandedall of

Optional branded food information pertinent to this food entity.

concernsarray of integer

descriptionstring

Optional description pertinent to this food entity.

fromViewsarray of string

iconIdstring

id*string

An API generated unique id for the food. required: true example: 1599761049537

licenseCopystring

LicenseCopy is the text of the license that was used to create this food entry.

name*string

name_i18nall of

Language translations

nutrientsarray of object

originarray of object

List of references to the raw data source(s), from which we did the migration/curation

popularityinteger

portionsarray of object

qualityScorestring

QualityScore is string representing quality, and is one of "Low", "Medium", or "High".

refCodestring

tagsarray of string

Tags for additional metadata per food

timestampstring

Time at which the document was last updated. Set automatically by API. required: true read only: true

webLinksarray of string

If there is no raw database from which we imported data, and thus origin is empty, we should be able to specify a weblink or so example: www.productstraderjoes.com

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.passiolife.com/v2/products/napi/food/productCode/{productCode}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404429500

{
  "brandName": "text",
  "branded": {
    "certified": false,
    "country": "text",
    "images": [
      {
        "bucket": "text",
        "path": "text"
      }
    ],
    "ingredients": "text",
    "ocrText": "text",
    "owner": "text",
    "productCode": "text",
    "reviewed": false,
    "tested": false,
    "upc": "text"
  },
  "concerns": [
    0
  ],
  "description": "text",
  "fromViews": [
    "text"
  ],
  "iconId": "text",
  "id": "text",
  "licenseCopy": "text",
  "name": "text",
  "name_i18n": {},
  "nutrients": [
    {
      "amount": 0,
      "id": 0,
      "nutrient": {
        "group": "text",
        "id": 0,
        "name": "text",
        "origin": [
          {
            "dataType": "text",
            "id": "text",
            "source": "text",
            "timestamp": "text"
          }
        ],
        "shortName": "text",
        "unit": "text"
      }
    }
  ],
  "origin": [
    {
      "dataType": "text",
      "id": "text",
      "source": "text",
      "timestamp": "text"
    }
  ],
  "popularity": 0,
  "portions": [
    {
      "name": "text",
      "quantity": 0,
      "suggestedQuantity": [
        0
      ],
      "weight": {
        "unit": "text",
        "value": 0
      }
    }
  ],
  "qualityScore": "text",
  "refCode": "text",
  "tags": [
    "text"
  ],
  "timestamp": "text",
  "webLinks": [
    "text"
  ]
}

Get Product By Food ID

Summary

Given a food items ID, such as 698241110109 get the detailed information and nutrients of the corresponding food product.

Get Food By ID

get food record by its corresponding food identifier

GEThttps://api.passiolife.com/v2/products/napi/food/{externalFoodId}

Path parameters

externalFoodId*string

food id (ex: 1599690204479)

Query parameters

Response

200400404429500

OK

Body

application/json

brandNamestring

Optional brandname pertinent to this food entity.

brandedall of

Optional branded food information pertinent to this food entity.

concernsarray of integer

descriptionstring

Optional description pertinent to this food entity.

fromViewsarray of string

iconIdstring

id*string

An API generated unique id for the food. required: true example: 1599761049537

licenseCopystring

LicenseCopy is the text of the license that was used to create this food entry.

name*string

name_i18nall of

Language translations

nutrientsarray of object

originarray of object

List of references to the raw data source(s), from which we did the migration/curation

popularityinteger

portionsarray of object

qualityScorestring

QualityScore is string representing quality, and is one of "Low", "Medium", or "High".

refCodestring

tagsarray of string

Tags for additional metadata per food

timestampstring

Time at which the document was last updated. Set automatically by API. required: true read only: true

webLinksarray of string

If there is no raw database from which we imported data, and thus origin is empty, we should be able to specify a weblink or so example: www.productstraderjoes.com

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.passiolife.com/v2/products/napi/food/{externalFoodId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404429500

{
  "brandName": "text",
  "branded": {
    "certified": false,
    "country": "text",
    "images": [
      {
        "bucket": "text",
        "path": "text"
      }
    ],
    "ingredients": "text",
    "ocrText": "text",
    "owner": "text",
    "productCode": "text",
    "reviewed": false,
    "tested": false,
    "upc": "text"
  },
  "concerns": [
    0
  ],
  "description": "text",
  "fromViews": [
    "text"
  ],
  "iconId": "text",
  "id": "text",
  "licenseCopy": "text",
  "name": "text",
  "name_i18n": {},
  "nutrients": [
    {
      "amount": 0,
      "id": 0,
      "nutrient": {
        "group": "text",
        "id": 0,
        "name": "text",
        "origin": [
          {
            "dataType": "text",
            "id": "text",
            "source": "text",
            "timestamp": "text"
          }
        ],
        "shortName": "text",
        "unit": "text"
      }
    }
  ],
  "origin": [
    {
      "dataType": "text",
      "id": "text",
      "source": "text",
      "timestamp": "text"
    }
  ],
  "popularity": 0,
  "portions": [
    {
      "name": "text",
      "quantity": 0,
      "suggestedQuantity": [
        0
      ],
      "weight": {
        "unit": "text",
        "value": 0
      }
    }
  ],
  "qualityScore": "text",
  "refCode": "text",
  "tags": [
    "text"
  ],
  "timestamp": "text",
  "webLinks": [
    "text"
  ]
}

Get Product By Reference Code

Summary

All items returned from our API come with a Reference Code. This can be used to retreive the same item later, and to store custom data if necessary.

Get Search Result Food By RefCode

given a search result refcode, retreive the full food information

GEThttps://api.passiolife.com/v2/products/napi/food/search/result/refCode/:refCode

Path parameters

refCode*string

the string of a base64 url encoded json str. returned with results as 'refCode' from this api. example decoded object: {\

Query parameters

Response

200400429500

OK

Body

application/json

alternativesarray of object

resultsarray of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.passiolife.com/v2/products/napi/food/search/result/refCode/:refCode', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400429500

{
  "alternatives": [
    {
      "displayName": "text",
      "iconId": "text",
      "labelId": "text",
      "resultId": "text",
      "type": "text"
    }
  ],
  "results": [
    {
      "displayName": "text",
      "iconId": "text",
      "ingredients": [
        {
          "brandName": "text",
          "branded": {
            "certified": false,
            "country": "text",
            "images": [
              {
                "bucket": "text",
                "path": "text"
              }
            ],
            "ingredients": "text",
            "ocrText": "text",
            "owner": "text",
            "productCode": "text",
            "reviewed": false,
            "tested": false,
            "upc": "text"
          },
          "concerns": [
            0
          ],
          "description": "text",
          "fromViews": [
            "text"
          ],
          "iconId": "text",
          "id": "text",
          "licenseCopy": "text",
          "name": "text",
          "name_i18n": {},
          "nutrients": [
            {
              "amount": 0,
              "id": 0,
              "nutrient": {
                "group": "text",
                "id": 0,
                "name": "text",
                "origin": [
                  {
                    "dataType": "text",
                    "id": "text",
                    "source": "text",
                    "timestamp": "text"
                  }
                ],
                "shortName": "text",
                "unit": "text"
              }
            }
          ],
          "origin": [
            {
              "dataType": "text",
              "id": "text",
              "source": "text",
              "timestamp": "text"
            }
          ],
          "popularity": 0,
          "portions": [
            {
              "name": "text",
              "quantity": 0,
              "suggestedQuantity": [
                0
              ],
              "weight": {
                "unit": "text",
                "value": 0
              }
            }
          ],
          "qualityScore": "text",
          "refCode": "text",
          "tags": [
            "text"
          ],
          "timestamp": "text",
          "webLinks": [
            "text"
          ]
        }
      ],
      "internalId": "text",
      "internalName": "text",
      "portions": [
        {
          "name": "text",
          "quantity": 0,
          "suggestedQuantity": [
            0
          ],
          "weight": {
            "unit": "text",
            "value": 0
          }
        }
      ],
      "refCode": "text",
      "type": "text"
    }
  ]
}

Search Foods

Summary

This route allows text search against our entire database of foods, products, and recipes.

Simply URL Encode your search term to take care of special characters, and send the request! The default limit (max results returned) is 50. This is the recommended setting, but can be adjusted as needed.

Search Foods (Basic)

search for food (generic, branded or restaraunt) or recipes

GEThttps://api.passiolife.com/v2/products/napi/food/search/advanced

Query parameters

Response

200400429500

OK

Body

application/json

alternateNamesarray of string

resultsarray of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.passiolife.com/v2/products/napi/food/search/advanced?term=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400429500

{
  "alternateNames": [
    "text"
  ],
  "results": [
    {
      "brandName": "text",
      "displayName": "text",
      "iconId": "text",
      "labelId": "text",
      "longName": "text",
      "nutritionPreview": {
        "calories": 0,
        "carbs": 0,
        "fat": 0,
        "fiber": 0,
        "portion": {
          "name": "text",
          "quantity": 0,
          "suggestedQuantity": [
            0
          ],
          "weight": {
            "unit": "text",
            "value": 0
          }
        },
        "protein": 0
      },
      "recipeId": "text",
      "refCode": "text",
      "referenceId": "text",
      "resultId": "text",
      "score": 0,
      "scoredName": "text",
      "shortName": "text",
      "synonymId": "text",
      "tags": [
        "text"
      ],
      "type": "text"
    }
  ]
}

(Deprecated) Get Search Result Details [use Reference Codes]

Summary

This route remains to support backward compatibility. Reference Codes should be used instead for all new implementations.

• labelId If the selected result has a labelId, pass it as this parameter. If the labelId is empty, pass an all 0's uuid: 00000000-0000-0000-0000-000000000000

• type All search results will have a type field which will be one of synonym, recipe, or reference. Pass this value to the type parameter

• resultId all search results will have a resultId. Pass this value to the resultId parameter

Get Search Result Food

given a search result object, retreive the full food information

GEThttps://api.passiolife.com/v2/products/napi/food/search/result/:labelId/:type/:resultId

Path parameters

labelId*string

labelid from search result. use an all zeros uuid if unknown.

type*enum

type from search result

synonymrecipereference

resultId*string

resultid from search result

Query parameters

Response

200400429500

OK

Body

application/json

alternativesarray of object

resultsarray of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.passiolife.com/v2/products/napi/food/search/result/:labelId/:type/:resultId', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400429500

{
  "alternatives": [
    {
      "displayName": "text",
      "iconId": "text",
      "labelId": "text",
      "resultId": "text",
      "type": "text"
    }
  ],
  "results": [
    {
      "displayName": "text",
      "iconId": "text",
      "ingredients": [
        {
          "brandName": "text",
          "branded": {
            "certified": false,
            "country": "text",
            "images": [
              {
                "bucket": "text",
                "path": "text"
              }
            ],
            "ingredients": "text",
            "ocrText": "text",
            "owner": "text",
            "productCode": "text",
            "reviewed": false,
            "tested": false,
            "upc": "text"
          },
          "concerns": [
            0
          ],
          "description": "text",
          "fromViews": [
            "text"
          ],
          "iconId": "text",
          "id": "text",
          "licenseCopy": "text",
          "name": "text",
          "name_i18n": {},
          "nutrients": [
            {
              "amount": 0,
              "id": 0,
              "nutrient": {
                "group": "text",
                "id": 0,
                "name": "text",
                "origin": [
                  {
                    "dataType": "text",
                    "id": "text",
                    "source": "text",
                    "timestamp": "text"
                  }
                ],
                "shortName": "text",
                "unit": "text"
              }
            }
          ],
          "origin": [
            {
              "dataType": "text",
              "id": "text",
              "source": "text",
              "timestamp": "text"
            }
          ],
          "popularity": 0,
          "portions": [
            {
              "name": "text",
              "quantity": 0,
              "suggestedQuantity": [
                0
              ],
              "weight": {
                "unit": "text",
                "value": 0
              }
            }
          ],
          "qualityScore": "text",
          "refCode": "text",
          "tags": [
            "text"
          ],
          "timestamp": "text",
          "webLinks": [
            "text"
          ]
        }
      ],
      "internalId": "text",
      "internalName": "text",
      "portions": [
        {
          "name": "text",
          "quantity": 0,
          "suggestedQuantity": [
            0
          ],
          "weight": {
            "unit": "text",
            "value": 0
          }
        }
      ],
      "refCode": "text",
      "type": "text"
    }
  ]
}