v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Nutrition Service

getAllNutritions

Retrieve a list of all Nutrition Details.

get/nutrition/v1/getAllNutritions

Query parameters

activeFlagboolean

Fetch all active Nutrition Details

includeNullboolean

Specify 'true' to output null data elements.

includeUsdaboolean

Fetch either USDA or Custom Nutrition Details

itemDescriptionstring

This is the Item Description of the Nutrition. Use 2 or more characters.

itemNumberstring

This is the Item Number of the Nutrition

minutesSinceUpdateinteger

The number of minutes since a Nutrition record was last updated. Use to set how far back to search.

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring required

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring required

User ID for the Crunchtime Application User

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

locationCodestring

Location "Code" from Nutrition screen

Example response

[
  {
    "locationCode": "000000",
    "nutritionDetails": [
      {
        "nutritionDetailDetails": [
          {
            "addedSugars": 15,
            "calcium": 15,
            "calories": 15,
            "cholesterol": 15,
            "dietaryFiber": 15,
            "iron": 15,
            "itemDescription": "NUTRITION-TEST",
            "potassium": 15,
            "protein": 15,
            "saturatedFat": 15,
            "sodium": 15,
            "sugars": 15,
            "totalCarbohydrate": 15,
            "totalFat": 15,
            "transFat": 15,
            "vitaminA": 15,
            "vitaminC": 15,
            "vitaminD": 15
          }
        ]
      }
    ]
  }
]