Skip to main content
PATCH
Update a product nutrient row

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

UUID of the organization that owns the product.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
gtin
string
required

GTIN-8/12/13/14 of the target product. Normalized to GTIN-14 by zero-padding before lookup.

Pattern: ^\d{8,14}$
nutrient_id
string
required

UUID (or 22-char shortuuid) of the nutrient row to update.

Body

application/json

Request body for a partial update to a nutrient row. Only supplied fields change.

nutrient_type
enum<string> | null

New canonical nutrient identifier. Must not collide with another row on the same label.

Available options:
CALORIES,
TOTAL_FAT,
SATURATED_FAT,
TRANS_FAT,
CHOLESTEROL,
SODIUM,
TOTAL_CARBS,
DIETARY_FIBER,
TOTAL_SUGARS,
ADDED_SUGARS,
PROTEIN,
VITAMIN_D,
CALCIUM,
IRON,
POTASSIUM
amount
number | null

New quantity of the nutrient per serving.

Required range: x >= 0
unit
enum<string> | null

New unit of measurement for amount.

Available options:
G,
MG,
MCG,
KCAL,
KJ,
IU,
ML
daily_value_pct
integer | null

New percent daily value. Send null to leave unchanged (this field cannot be cleared via PATCH).

Required range: x >= 0

Response

200 - application/json

OK

A single nutrient row on a nutrition-facts label, with its row id.

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
nutrient_type
enum<string>
required

Canonical nutrient identifier. Stable across regulatory label formats.

Available options:
CALORIES,
TOTAL_FAT,
SATURATED_FAT,
TRANS_FAT,
CHOLESTEROL,
SODIUM,
TOTAL_CARBS,
DIETARY_FIBER,
TOTAL_SUGARS,
ADDED_SUGARS,
PROTEIN,
VITAMIN_D,
CALCIUM,
IRON,
POTASSIUM
name
string
required

Localized display name for the nutrient (e.g. Total Fat). Derived from nutrient_type.

amount
number
required

Quantity of the nutrient per serving, in the units specified by unit.

Required range: x >= 0
unit
enum<string>
required

Unit of measurement for amount.

Available options:
G,
MG,
MCG,
KCAL,
KJ,
IU,
ML
daily_value_pct
integer | null

Percent of the regulatory daily value covered by one serving. Null when not declared.

Required range: x >= 0