--- updatedAt: 2025-06-05T20:49:20.000Z agentTools: projectIndex: https://developers.labelinsight.com/llms.txt --- # Get Product Deltas Returns a list of products with data creation and update events **Key Features & Benefits:** Single endpoint for all product types Real time product updates Bulk Call functionality Ability to pass in an optional “preview” parameter to allow for calling of the API without clearing the delta queue > 📘 > > The product `/deltas` endpoint functions as a queue. Assuming there are product deltas that have not been delivered yet, the endpoint will return a new set of products equal to the `size` parameter until there are no more delta events to consume. ### Delta Event Types
Event Type Description
`ADDED` The first record of this product in your dataset
`MODIFIED` An existing product has been updated
# OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "products", "version": "1.2" }, "servers": [ { "url": "https://api.labelinsight.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "X-API-KEY" } } }, "security": [ { "sec0": [] } ], "paths": { "/products/v1/{configurationId}/deltas": { "get": { "summary": "Get Product Deltas", "description": "Returns a list of products with data creation and update events", "operationId": "get-product-deltas", "parameters": [ { "name": "size", "in": "query", "description": "Page size must be between 1 and 250.", "required": true, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "configurationId", "in": "path", "description": "Configuration ID provided by Label Insight", "schema": { "type": "string" }, "required": true }, { "name": "x-api-key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "preview", "in": "query", "description": "When true this allows you to read messages without removing them from the queue", "schema": { "type": "string", "default": "true" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"size\": 1,\n \"numberOfElements\": 1,\n \"totalRemaining\": 9,\n \"content\":\n [\n {\n \"deltaEvent\": \"ADDED\",\n \"product\":\n {\n \"upc\": \"12345678912\",\n \"brand\": \"Tasty Fudge Bars\",\n \"subBrand\": \"Flavorful Tasty Fudge Bars\",\n \"productTitle\": \"Fudge Bars\",\n \"productSize\": \"3 FL OZ\",\n \"unitsPerPack\": \"About 3\",\n \"variant\": \"Fudge\",\n \"manufacturer\": \"Classic Manufacturing\",\n \"distributor\": \"Classic Distributor\",\n \"importer\": \"Classic Importer\",\n \"categorization\":\n {\n \"productType\": \"Food\",\n \"aisle\": \"Frozen Food\",\n \"shelf\": \"Ice Cream & Frozen Yogurt\",\n \"category\": \"Ice Cream - Fudge Bars\"\n },\n \"gtinFormats\":\n {\n \"gtin12\": \"1234567891234\",\n \"gtin14\": \"12345678912\"\n },\n \"ingredients\":\n {\n \"declaration\": \"SKIM MILK, CONDENSED SKIM MILK, POLYDEXTROSE, WHOLE MILK, SORBITOL*, COCOA (PROCESSED WITH ALKALI), MILK PROTEIN CONCENTRATE, CONTAINS 2% OR LESS OF: GLYCERIN, STABILIZER BLEND (MALTODEXTRIN, WHEY POWDER, CELLULOSE GUM, LOCUST BEAN GUM, MONO- AND DIGLYCERIDES, GUAR GUM, CORN STARCH, CARRAGEENAN, POLYSORBATE 80), WHEY PROTEIN CONCENTRATE, ASPARTAME, VITAMIN A PALMITATE, NATURAL FLAVOR.\",\n \"symbols\":\n [\n \"* Sensitive individuals may experience a laxative effect from excessive consumption of these ingredients.\"\n ]\n },\n \"warning\": \"CONTAINS: MILK. PHENYLKETONEURICS: CONTAINS PHENYLALANINE.\",\n \"factPanel\":\n {\n \"nutrition\":\n {\n \"labelStyle\": \"NLEA_2018\",\n \"serving\":\n {\n \"description\": \"1 bar\",\n \"numberPerPack\": \"1\",\n \"size\": \"2.6\",\n \"sizeUom\": \"oz\",\n \"size2\": \"76\",\n \"sizeUom2\": \"g\"\n },\n \"columns\":\n [\n {\n \"name\": \"Amount/serving\",\n \"nutrients\":\n [\n {\n \"name\": \"Calories\",\n \"operator\": \"=\",\n \"value\": 90.0,\n \"uom\": \"Cal\",\n \"percentDvOperator\": null,\n \"percentDv\": null\n },\n {\n \"name\": \"Total Fat\",\n \"operator\": \"=\",\n \"value\": 1.0,\n \"uom\": \"g\",\n \"percentDvOperator\": \"=\",\n \"percentDv\": 1.0\n },\n {\n \"name\": \"Vitamin D\",\n \"operator\": \"=\",\n \"value\": 0.0,\n \"uom\": \"mcg\",\n \"percentDvOperator\": \"=\",\n \"percentDv\": 0.0\n },\n {\n \"name\": \"Iron\",\n \"operator\": \"=\",\n \"value\": 1.2,\n \"uom\": \"mg\",\n \"percentDvOperator\": \"=\",\n \"percentDv\": 6.0\n }\n ]\n }\n ]\n },\n \"drug\": null\n },\n \"attributes\":\n [\n {\n \"name\": \"No Added Sugar\"\n },\n {\n \"name\": \"Good Source of Protein\"\n },\n {\n \"name\": \"Low Fat\"\n }\n ]\n }\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "size": { "type": "integer", "example": 1, "default": 0 }, "numberOfElements": { "type": "integer", "example": 1, "default": 0 }, "totalRemaining": { "type": "integer", "example": 9, "default": 0 }, "content": { "type": "array", "items": { "type": "object", "properties": { "deltaEvent": { "type": "string", "example": "ADDED" }, "product": { "type": "object", "properties": { "upc": { "type": "string", "example": "12345678912" }, "brand": { "type": "string", "example": "Tasty Fudge Bars" }, "subBrand": { "type": "string", "example": "Flavorful Tasty Fudge Bars" }, "productTitle": { "type": "string", "example": "Fudge Bars" }, "productSize": { "type": "string", "example": "3 FL OZ" }, "unitsPerPack": { "type": "string", "example": "About 3" }, "variant": { "type": "string", "example": "Fudge" }, "manufacturer": { "type": "string", "example": "Classic Manufacturing" }, "distributor": { "type": "string", "example": "Classic Distributor" }, "importer": { "type": "string", "example": "Classic Importer" }, "categorization": { "type": "object", "properties": { "productType": { "type": "string", "example": "Food" }, "aisle": { "type": "string", "example": "Frozen Food" }, "shelf": { "type": "string", "example": "Ice Cream & Frozen Yogurt" }, "category": { "type": "string", "example": "Ice Cream - Fudge Bars" } } }, "gtinFormats": { "type": "object", "properties": { "gtin12": { "type": "string", "example": "1234567891234" }, "gtin14": { "type": "string", "example": "12345678912" } } }, "ingredients": { "type": "object", "properties": { "declaration": { "type": "string", "example": "SKIM MILK, CONDENSED SKIM MILK, POLYDEXTROSE, WHOLE MILK, SORBITOL*, COCOA (PROCESSED WITH ALKALI), MILK PROTEIN CONCENTRATE, CONTAINS 2% OR LESS OF: GLYCERIN, STABILIZER BLEND (MALTODEXTRIN, WHEY POWDER, CELLULOSE GUM, LOCUST BEAN GUM, MONO- AND DIGLYCERIDES, GUAR GUM, CORN STARCH, CARRAGEENAN, POLYSORBATE 80), WHEY PROTEIN CONCENTRATE, ASPARTAME, VITAMIN A PALMITATE, NATURAL FLAVOR." }, "symbols": { "type": "array", "items": { "type": "string", "example": "* Sensitive individuals may experience a laxative effect from excessive consumption of these ingredients." } } } }, "warning": { "type": "string", "example": "CONTAINS: MILK. PHENYLKETONEURICS: CONTAINS PHENYLALANINE." }, "factPanel": { "type": "object", "properties": { "nutrition": { "type": "object", "properties": { "labelStyle": { "type": "string", "example": "NLEA_2018" }, "serving": { "type": "object", "properties": { "description": { "type": "string", "example": "1 bar" }, "numberPerPack": { "type": "string", "example": "1" }, "size": { "type": "string", "example": "2.6" }, "sizeUom": { "type": "string", "example": "oz" }, "size2": { "type": "string", "example": "76" }, "sizeUom2": { "type": "string", "example": "g" } } }, "columns": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Amount/serving" }, "nutrients": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Calories" }, "operator": { "type": "string", "example": "=" }, "value": { "type": "integer", "example": 90, "default": 0 }, "uom": { "type": "string", "example": "Cal" }, "percentDvOperator": {}, "percentDv": {} } } } } } } } }, "drug": {} } }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "No Added Sugar" } } } } } } } } } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Forbidden\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Forbidden" } } } } } } }, "deprecated": false, "security": [] } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```