Record Reference Food View

Records that the calling member opened a food (action: open) or changed the portion of a food they opened (action: portion), and returns the food as stored after the change. Opening a food puts it at the top of the member's Recent list. Each call is kept in the member's own view history, including the search text for a food opened from search.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

food_id*Food Id

Identifier of the food in the food database.

Match^[A-Za-z0-9][A-Za-z0-9_.:\-]*$

Length1 <= length <= 128

name*Name

The food's name as shown to the member.

Length1 <= length <= 200

brand?|

The brand as shown, for a branded food.

source*ReferenceFoodSource

generic for a general food, branded for a branded product.

Value in"generic" | "branded"

per_100g*

The headline nutrients per 100 g, as shown to the member.

data_version*Data Version

Version of the food data the member was shown.

Match^[A-Za-z0-9][A-Za-z0-9_.:+\-]*$

Length1 <= length <= 64

action*ReferenceFoodViewAction

open when the member opened the food. portion when they changed the portion of a food they already opened.

Value in"open" | "portion"

opened_from*ReferenceFoodOpenedFrom

The tab the food was opened from: search, recent or saved.

Value in"search" | "recent" | "saved"

portion?|

The portion shown. Required for portion. On open it becomes the food's last portion; when omitted the last portion is kept.

result_position?|

Where the food appeared in the search results, starting at 1 (at most 10000). Only for open from search.

query?|

The search text that found the food. Kept in the member's own view history only. Only for open from search.

Response Body

`application/json`

curl -X POST "https://api.bettermenu.live/studio/reference/foods/views" \  -H "Content-Type: application/json" \  -d '{    "food_id": "string",    "name": "string",    "source": "generic",    "per_100g": {},    "data_version": "string",    "action": "open",    "opened_from": "search"  }'

{
  "food_id": "string",
  "name": "string",
  "brand": "string",
  "source": "generic",
  "saved": true,
  "saved_at": "2019-08-24T14:15:22Z",
  "first_viewed_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z",
  "view_count": 0,
  "last_portion": {
    "label": "string",
    "grams": 0.001
  },
  "per_100g": {
    "calories": 100000,
    "total_fat": 100000,
    "total_carbohydrate": 100000,
    "protein": 100000
  },
  "data_version": "string"
}

{
  "type": "https://api.bettermenu.live/errors/recipe_not_found",
  "title": "Recipe Not Found",
  "status": 400,
  "detail": "Recipe rcpe_abc123 does not exist",
  "code": "recipe_not_found",
  "retryable": true,
  "instance": "/api/v1/recipes/rcpe_abc123",
  "trace_id": "req_xyz789",
  "errors": [
    {}
  ],
  "invalid_ids": [
    "f_abc123",
    "f_xyz789"
  ]
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

BETTERMENU

FDA-compliant nutrition labels from a recipe, in minutes.

Visit bettermenu.live

Request Body

Response Body

200application/json

404application/json

422application/json

`application/json`

`application/json`

`application/json`