changedOutput schema / properties / failed / description
Previous value: -"Barcodes whose fetch failed, with the per-barcode reason. Absent when every fetch completed. A barcode listed here is unknown, not absent from Open Food Facts — retry it with off_get_product before concluding anything about the product."New value: +"Barcodes whose fetch failed, with the per-barcode reason. Absent when every fetch completed. A barcode listed here is unknown, not absent from Open Food Facts — retry it with off_get_product before concluding anything about the product. A stored as-sold set that could not be read is not a failed fetch: it stays on its row as stored_as_sold."
addedOutput schema / properties / failed / items / properties / retryAfter
Added value: +{
+ "description": "Whole seconds to wait before retrying this barcode: the time until this server's own product budget frees a slot, or the Retry-After Open Food Facts sent with a 429. Absent when the failure named no wait.",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+}
addedOutput schema / properties / mirror_snapshot
Added value: +{
+ "description": "Present only when a row's source is \"off_mirror\". States that those rows come from the local copy as of their mirror_as_of, so an edit made to them since then is not reflected.",
+ "type": "string"
+}
changedOutput schema / properties / products / items / properties / carbohydrates_100g / description
Previous value: -"Total carbohydrates in grams per 100 g, or per 100 ml for liquids, as sold. Absent when not entered, or when this read returned only prepared figures (see prepared)."New value: +"Total carbohydrates in grams per 100 g, or per 100 ml for liquids, as sold. When the product read returned only prepared figures, read from the record's stored as-sold set instead (see stored_as_sold). Absent when not entered, or when that stored set was not read."
changedOutput schema / properties / products / items / properties / energy_kcal_100g / description
Previous value: -"Energy in kcal per 100 g, or per 100 ml for liquids, as sold. Absent when not entered, or when this read returned only prepared figures (see prepared)."New value: +"Energy in kcal per 100 g, or per 100 ml for liquids, as sold. When the product read returned only prepared figures, read from the record's stored as-sold set instead (see stored_as_sold). Absent when not entered, or when that stored set was not read."
changedOutput schema / properties / products / items / properties / fat_100g / description
Previous value: -"Total fat in grams per 100 g, or per 100 ml for liquids, as sold. Absent when not entered, or when this read returned only prepared figures (see prepared)."New value: +"Total fat in grams per 100 g, or per 100 ml for liquids, as sold. When the product read returned only prepared figures, read from the record's stored as-sold set instead (see stored_as_sold). Absent when not entered, or when that stored set was not read."
changedOutput schema / properties / products / items / properties / fiber_100g / description
Previous value: -"Dietary fiber in grams per 100 g, or per 100 ml for liquids, as sold. Absent when not entered, or when this read returned only prepared figures (see prepared)."New value: +"Dietary fiber in grams per 100 g, or per 100 ml for liquids, as sold. When the product read returned only prepared figures, read from the record's stored as-sold set instead (see stored_as_sold). Absent when not entered, or when that stored set was not read."
addedOutput schema / properties / products / items / properties / mirror_as_of
Added value: +{
+ "description": "ISO 8601 time of the newest Open Food Facts change the local copy reflects. Present only when source is \"off_mirror\".",
+ "type": "string"
+}
changedOutput schema / properties / products / items / properties / prepared / description
Previous value: -"Figures for the prepared product, on the same columns and basis as the as-sold fields, read from Open Food Facts' *_prepared_100g keys and never derived or substituted for an as-sold figure. Open Food Facts returns one preparation state per read, so as-sold fields absent beside this object mean this read returned none, not that the record holds none. Absent when the read carried none of these figures."New value: +"Figures for the prepared product, on the same columns and basis as the as-sold fields, read from Open Food Facts' *_prepared_100g keys and never derived or substituted for an as-sold figure. Open Food Facts returns one preparation state per read, so when the product read returned only prepared figures the record's stored as-sold set is read for the as-sold fields, and stored_as_sold says how that went. Absent when the read carried none of these figures."
changedOutput schema / properties / products / items / properties / proteins_100g / description
Previous value: -"Protein in grams per 100 g, or per 100 ml for liquids, as sold. Absent when not entered, or when this read returned only prepared figures (see prepared)."New value: +"Protein in grams per 100 g, or per 100 ml for liquids, as sold. When the product read returned only prepared figures, read from the record's stored as-sold set instead (see stored_as_sold). Absent when not entered, or when that stored set was not read."
changedOutput schema / properties / products / items / properties / salt_100g / description
Previous value: -"Salt in grams per 100 g, or per 100 ml for liquids, as sold. Absent when not entered, or when this read returned only prepared figures (see prepared)."New value: +"Salt in grams per 100 g, or per 100 ml for liquids, as sold. When the product read returned only prepared figures, read from the record's stored as-sold set instead (see stored_as_sold). Absent when not entered, or when that stored set was not read."
changedOutput schema / properties / products / items / properties / saturated_fat_100g / description
Previous value: -"Saturated fat in grams per 100 g, or per 100 ml for liquids, as sold. Absent when not entered, or when this read returned only prepared figures (see prepared)."New value: +"Saturated fat in grams per 100 g, or per 100 ml for liquids, as sold. When the product read returned only prepared figures, read from the record's stored as-sold set instead (see stored_as_sold). Absent when not entered, or when that stored set was not read."
addedOutput schema / properties / products / items / properties / source
Added value: +{
+ "description": "Where this row was read: \"off_api\", Open Food Facts itself, or \"off_mirror\", this server's local copy of the Open Food Facts export, which serves a barcode it holds on a deployment that keeps one, so one comparison can mix the two. The stored as-sold read behind stored_as_sold, when one runs, reads the same source. Present on every row whose found is true.",
+ "enum": [
+ "off_api",
+ "off_mirror"
+ ],
+ "type": "string"
+}
addedOutput schema / properties / products / items / properties / stored_as_sold
Added value: +{
+ "description": "How the read of the record's stored as-sold figures went for this row. Present only when its product read returned prepared figures and no as-sold one, which is when that second read of the record's stored nutrition sets runs (Open Food Facts serves one preparation state per product read, and prepared wins).",
+ "oneOf": [
+ {
+ "additionalProperties": false,
+ "description": "The as-sold fields hold one stored set, never merged: per 100 g, or per 100 ml for liquids, when the record stores it so, else a serving of at least 5 g or ml scaled to 100 as Open Food Facts scales it, from the manufacturer, packaging, USDA, or another non-estimate source, in that order. Each nutrient is the entered value, or the one Open Food Facts computed when none was entered; IU and % DV figures are left out.",
+ "properties": {
+ "status": {
+ "const": "read",
+ "description": "One stored as-sold set was read into the as-sold fields.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Open Food Facts stores no entered as-sold figures for it that can be given per 100 g, or per 100 ml for liquids: the record stores no sets, or only prepared ones, ones estimated from the ingredients, servings under 5 g or ml, or figures in units that do not convert. The as-sold fields stay absent because nothing is entered.",
+ "properties": {
+ "status": {
+ "const": "none",
+ "description": "The record stores no as-sold set the as-sold fields can be read from.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "The as-sold figures the record can still hold were not read, so the prepared figures are all this call holds. Never a failed call.",
+ "properties": {
+ "error": {
+ "description": "What went wrong reading the stored sets and what to do about it.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "Declared failure reason — one of upstream_error, upstream_timeout, upstream_rejected, rate_limited.",
+ "type": "string"
+ },
+ "retryAfter": {
+ "description": "Whole seconds to wait before reading again: the time until this server's own product budget frees a slot, or the Retry-After Open Food Facts sent with a 429. Absent when the failure named no wait.",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "status": {
+ "const": "unread",
+ "description": "The stored sets could not be read; the call itself succeeded.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "reason",
+ "error"
+ ],
+ "type": "object"
+ }
+ ]
+}
changedOutput schema / properties / products / items / properties / sugars_100g / description
Previous value: -"Total sugars in grams per 100 g, or per 100 ml for liquids, as sold. Absent when not entered, or when this read returned only prepared figures (see prepared)."New value: +"Total sugars in grams per 100 g, or per 100 ml for liquids, as sold. When the product read returned only prepared figures, read from the record's stored as-sold set instead (see stored_as_sold). Absent when not entered, or when that stored set was not read."