Update a product nutrient row
Partially update a nutrient row — only supplied fields change. Changing nutrient_type to one already on the label returns 409. Requires the organization.contribute_organization permission on the membership.
Authorizations
Path Parameters
UUID of the organization that owns the product.
22^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$GTIN-8/12/13/14 of the target product. Normalized to GTIN-14 by zero-padding before lookup.
^\d{8,14}$UUID (or 22-char shortuuid) of the nutrient row to update.
Body
Request body for a partial update to a nutrient row. Only supplied fields change.
New canonical nutrient identifier. Must not collide with another row on the same label.
CALORIES, TOTAL_FAT, SATURATED_FAT, TRANS_FAT, CHOLESTEROL, SODIUM, TOTAL_CARBS, DIETARY_FIBER, TOTAL_SUGARS, ADDED_SUGARS, PROTEIN, VITAMIN_D, CALCIUM, IRON, POTASSIUM New quantity of the nutrient per serving.
x >= 0New unit of measurement for amount.
G, MG, MCG, KCAL, KJ, IU, ML New percent daily value. Send null to leave unchanged (this field cannot be cleared via PATCH).
x >= 0Response
OK
A single nutrient row on a nutrition-facts label, with its row id.
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).
22^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$Canonical nutrient identifier. Stable across regulatory label formats.
CALORIES, TOTAL_FAT, SATURATED_FAT, TRANS_FAT, CHOLESTEROL, SODIUM, TOTAL_CARBS, DIETARY_FIBER, TOTAL_SUGARS, ADDED_SUGARS, PROTEIN, VITAMIN_D, CALCIUM, IRON, POTASSIUM Localized display name for the nutrient (e.g. Total Fat). Derived from nutrient_type.
Quantity of the nutrient per serving, in the units specified by unit.
x >= 0Unit of measurement for amount.
G, MG, MCG, KCAL, KJ, IU, ML Percent of the regulatory daily value covered by one serving. Null when not declared.
x >= 0