--- updatedAt: 2025-06-05T20:50:44.000Z agentTools: projectIndex: https://developers.labelinsight.com/llms.txt --- # Product by ProductID Returns a single **SmartLabel Product** identified by the Product ID. Refer to schema below for response structure. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "SmartLabel API", "version": "1.0.2", "summary": "The SmartLabel (SL) API is for customers to integrate their systems with SL data via RESTful APIs. The SL API returns data from published products with live SmartLabel pages. Once a product is published, it will become available to be queried in the SL API. Likewise if a product is retired, it will be removed from the SL API.", "description": "# Getting Started\n## Access Keys\nYou will need two keys to access the SL API. These keys will be provided to you by your Customer Success contact. \nAuthentication is accomplished by setting the `X-API-KEY` in the request header. Authorization is done via an `accessKey` that is specified in the request path. The SL API is not accessible without these keys.\n## Rate Limiting\nThe default rate limit for the SL API is 5 requests per second.\n## Supported HTTP Methods\nThe SL API currently supports the GET method. The GET method is used to retrieve data only and will never cause an update or change to the underlying data.\n\n## Response Code Reference\nResponse codes are relatively simple for this API. 200 is a success and various 400s indicate issues with the request. Each endpoint describes their own responses, but generally: \n\n Response Code | Description \n ------------- | ----------- \n 200 | Success. \n 400 | The request is missing key information or is malformed. \n 403 | Invalid API key, missing `X-API-KEY` header, or invalid URL. \n 404 | The requested information cannot be found. " }, "servers": [ { "url": "https://enterprise-sl-api.labelinsight.com" } ], "security": [ { "ApiKeyHeader": [] } ], "tags": [ { "name": "Single Identifier Queries", "description": "The SL API includes an endpoint to retrieve product data for a specified ID. The product can be retrieved with a `productId`, `manufacturerId`, or a `UPC`. A `productId` is an internal SL generated ID. A `manufacturerId` is an ID that is optionally created and managed by the brand. The `UPC` is different because in certain cases it can be the same on multiple products. If a `UPC` is used, multiple products could be returned." } ], "paths": { "/api/v4/{accessKey}/data/product/{productId}": { "get": { "tags": [ "Single Identifier Queries" ], "summary": "Product by ProductID", "description": "Returns a single **SmartLabel Product** identified by the Product ID.\nRefer to schema below for response structure.", "parameters": [ { "name": "X-API-KEY", "in": "header", "description": "API key provided by Label Insight", "schema": { "type": "string" } }, { "name": "accessKey", "in": "path", "description": "Authorization key provided by Label Insight", "schema": { "type": "string" }, "required": true }, { "name": "productId", "in": "path", "description": "Label Insight's Product Id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmartLabelApiContract" } } } }, "400": { "description": "Request is missing data or is malformed." }, "403": { "description": "Invalid or missing API key, or invalid URL." }, "404": { "description": "Requested information cannot be found." } } } } }, "components": { "securitySchemes": { "ApiKeyHeader": { "type": "apiKey", "description": "Api key provided by customer success, to be included in the 'X-API-KEY' header.", "in": "header", "name": "X-API-KEY" } }, "schemas": { "ActiveIngredient": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the active ingredient.", "examples": [ "Citric Acid" ] }, "value": { "type": "string", "description": "Amount of ingredient present per unit of measure.", "examples": [ 20 ] }, "uom": { "type": "string", "description": "Unit of measure for active ingredient within product.", "examples": [ "MG", "ML", "%", "etc." ] }, "symbol": { "type": "string", "description": "Quantity symbol for active ingredient. Typically used to indicate 'less than' values with '<'.", "examples": [ "<", "=", ">", "etc" ] }, "order": { "type": "integer", "description": "Order listed on product, if available.", "examples": [ 4 ] }, "description": { "type": "string", "description": "Description of active ingredient, if available.", "examples": [ "Avobenzone is an oil soluble ingredient used in sunscreen products to help absorb the full spectrum of the sun's UVA/UVB rays." ] }, "purpose": { "type": "string", "description": "Intended purpose listed for product, if available.", "examples": [ "Topical anesthetic" ] } } }, "Advisory": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "mandatory": { "type": "boolean" }, "advisoryGroup": { "type": "integer", "format": "int32" } } }, "AdvisorySection": { "type": "object", "properties": { "advisories": { "type": "array", "items": { "$ref": "#/components/schemas/Advisory" } } } }, "Allergen": { "type": "object", "description": "Allergen", "properties": { "name": { "type": "string" }, "displayName": { "type": "string" }, "displayOrder": { "type": "integer", "format": "int32" }, "mandatory": { "type": "boolean" }, "presence": { "type": "string" }, "culpritIngredients": { "type": "array", "items": { "$ref": "#/components/schemas/Ingredient" } }, "description": { "type": "string" }, "allergenSubspecies": { "type": "array", "items": { "$ref": "#/components/schemas/AllergenSubspecies" } } } }, "AllergenInformation": { "type": "object", "description": "Allergen information", "properties": { "description": { "type": "string" } } }, "AllergenSection": { "type": "object", "description": "Allergen information", "properties": { "allergens": { "type": "array", "items": { "$ref": "#/components/schemas/Allergen" } }, "preventionInformation": { "$ref": "#/components/schemas/AllergenInformation" } } }, "AllergenSubspecies": { "type": "object", "properties": { "name": { "type": "string" }, "displayName": { "type": "string" }, "presence": { "type": "string" } } }, "CalorieContent": { "type": "object", "description": "Calorie information for product, if available as discrete values.", "properties": { "isFieldHidden": { "description": "Is this field viewable on the product's published SmartLabel page", "type": "object", "additionalProperties": { "type": "boolean" } }, "isHidden": { "description": "Is this field viewable on the product's published SmartLabel page", "type": "boolean" }, "id": { "description": "internal use id", "type": "integer", "format": "int32" }, "value": { "type": "string", "description": "Quantity of the particular calorie content value. This is only the actual numerical value, not the UOM.", "examples": [ 1.1 ] }, "valueUom": { "type": "string", "description": "UOM (unit of measure) for calorie content value. This does not include the numerical value.", "examples": [ "KCAL" ] }, "perUom": { "type": "string", "description": "Size/quantity indicator of the unit of measure in use. This is not the value.", "examples": [ "KG", "CAN", "CUP", "etc" ] } } }, "Certification": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "website": { "type": "string" }, "mandatory": { "type": "boolean" } } }, "ChildProduct": { "type": "object", "description": "A product associated with the current one. Typically as part of a variety pack/multi pack product.", "properties": { "isFieldHidden": { "type": "object", "additionalProperties": { "type": "boolean" } }, "isHidden": { "type": "boolean" }, "productId": { "type": "string" }, "order": { "type": "integer", "format": "int32" } } }, "Claim": { "type": "object", "description": "Represents a claim associated with a given product.", "properties": { "name": { "type": "string", "examples": [ "Not a Significant Source of Statement" ] }, "description": { "type": "string", "examples": [ "Per FDA regulation, when nutrients are omitted from the Nutrition Facts Panel, this statement including according nutrients must present at the button of the panel." ] }, "mandatory": { "type": "boolean", "examples": [ true ] } } }, "Claims": { "type": "object", "properties": { "claims": { "type": "array", "items": { "$ref": "#/components/schemas/Claim" } }, "fdaOffPackageClaims": { "type": "array", "items": { "$ref": "#/components/schemas/Claim" } } } }, "CompanyBrandSection": { "type": "object", "properties": { "name": { "type": "string" }, "address": { "type": "string" }, "email": { "type": "string" }, "consumerHotLine": { "type": "string" }, "contactHours": { "type": "string" }, "manufacturerUrl": { "$ref": "#/components/schemas/URL" }, "brandUrl": { "$ref": "#/components/schemas/URL" }, "contactUrl": { "$ref": "#/components/schemas/URL" }, "additionalUrls": { "type": "array", "items": { "$ref": "#/components/schemas/URL" } }, "privacyPolicy": { "$ref": "#/components/schemas/URL" }, "enableFacebook": { "type": "boolean" }, "enableTwitter": { "type": "boolean" }, "enablePinterest": { "type": "boolean" }, "enableInstagram": { "type": "boolean" } } }, "FeedingInstruction": { "type": "object", "description": "Feeding instructions for product (pet food or similar).", "properties": { "isFieldHidden": { "type": "object", "additionalProperties": { "type": "boolean" } }, "isHidden": { "type": "boolean" }, "id": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "type": { "type": "string", "enum": [ "FEEDING_INSTRUCTION", "FEEDING_TABLE" ] }, "title": { "type": "string" }, "description": { "type": "string" }, "tableDescription": { "type": "string" }, "tableFooter": { "type": "string" }, "columnHeaders": { "type": "array", "items": { "type": "string" } }, "rows": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } }, "GeneralInformation": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "mandatory": { "type": "boolean" } } }, "GmoDisclosure": { "type": "object", "properties": { "name": { "type": "string" }, "attributeType": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "website": { "type": "string" }, "mandatory": { "type": "boolean" } } }, "HeaderLogo": { "type": "object", "properties": { "name": { "type": "string" } } }, "HealthSafety": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "mandatory": { "type": "boolean" } } }, "Ingredient": { "type": "object", "description": "Ingredient statement as present on the product label.", "properties": { "name": { "type": "string", "description": "Name of ingredient", "examples": [ "Chicken" ] }, "description": { "type": "string", "description": "Description of ingredient, if present.", "examples": [ "Poultry product" ] }, "order": { "type": "string", "description": "Order of occurrence in ingredients list. Not strictly guaranteed to be sequential.", "examples": [ "0001" ] }, "ingredientComponents": { "type": "array", "description": "List of all ingredient components to head ingredient - For personal care product type.", "items": { "$ref": "#/components/schemas/IngredientComponent" } }, "growingMethod": { "type": "string", "description": "An off-package attribute that a brand can add to an ingredient to indicate how the ingredient was grown.", "examples": [ "Organically Grown" ] }, "countryOfOrigin": { "type": "string", "description": "An off-package attribute that a brand can add to an ingredient to indicate the country in which the ingredient was produced.", "examples": [ "USA" ] }, "geographicalSource": { "type": "string", "description": "An off-package attribute that a brand can add to an ingredient to indicate the geographical source of the ingredient within the country of origin.", "examples": [ "California Coast" ] }, "purpose": { "type": "string", "description": "An off-package attribute that a brand can add to an ingredient to indicate the FDA-defined purpose/function of an ingredient.", "examples": [ "Perfume" ] }, "primaryIngredient": { "type": "boolean", "description": "Indicates if the ingredient is a sub-ingredient.", "examples": [ false ] }, "isQuantifyingIngredient": { "type": "boolean", "description": "Indicates if the ingredient is part of the standard ingredient declaration and listed in order of magnitude or classified as a 'less than %' ingredient.", "examples": [ true ] }, "value": { "type": "string", "description": "Not applicable/ignore.", "examples": [ null ] }, "uom": { "type": "string", "description": "Not applicable/ignore.", "examples": [ null ] }, "casNumber": { "type": "string", "description": "Not applicable/ignore.", "examples": [ null ] }, "isCoc": { "type": "boolean", "description": "Not applicable/ignore.", "examples": [ null ] }, "cocLists": { "type": "string", "description": "Not applicable/ignore.", "examples": [ null ] }, "cocListsLink": { "type": "string", "description": "Not applicable/ignore.", "examples": [ null ] }, "subIngredientsDisplayType": { "type": "string", "description": "Not applicable/ignore.", "enum": [ "CLICK_THROUGH", "NONE" ] } } }, "IngredientClaim": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "mandatory": { "type": "boolean" } } }, "IngredientComponent": { "type": "object", "description": "Components in ingredient - For personal care product type.", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "ingredientComponentType": { "type": "string" } } }, "IngredientSection": { "type": "object", "description": "Product ingredients section.", "properties": { "ingredients": { "type": "array", "items": { "$ref": "#/components/schemas/Ingredient" } }, "activeIngredients": { "type": "array", "items": { "$ref": "#/components/schemas/ActiveIngredient" } }, "ingredientClaims": { "type": "array", "items": { "$ref": "#/components/schemas/IngredientClaim" } }, "ingredientSymbols": { "type": "array", "items": { "$ref": "#/components/schemas/IngredientSymbol" } } } }, "IngredientSymbol": { "type": "object", "description": "deprecated", "properties": { "symbol": { "type": "string" }, "description": { "type": "string" } } }, "Nutrient": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "uom": { "type": "string" }, "dvp": { "type": "string" }, "group": { "type": "string" }, "symbol": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "indent": { "type": "integer", "format": "int32" }, "bold": { "type": "boolean" }, "nutrientSource": { "type": "string", "enum": [ "NUTRIENTS", "BLEND_COMPOSITION" ] }, "factPanelSection": { "type": "string", "enum": [ "NUTRIENT", "VOLUNTARY_ODI" ] } } }, "NutrientPanel": { "type": "object", "description": "Nutrient panel information for product.", "properties": { "name": { "type": "string", "description": "Serving size description for nutrition facts panel.", "examples": [ "Amount/serving" ] }, "servingSize": { "type": "string", "description": "The serving size of the product as present on the nutrition facts panel. This is only the value.", "examples": [ "1 3/4" ] }, "servingSizeUom": { "type": "string", "description": "The UOM (unit of measure) associated to the serving size of the product as present on the nutrition facts panel.", "examples": [ "cup" ] }, "servingSize2": { "type": "string", "description": "The second serving size of the product as present on the nutrition facts panel. This is only the value.", "examples": [ 76 ] }, "servingSizeUom2": { "type": "string", "description": "The UOM (unit of measure) associated to the second serving size of the product as present on the nutrition facts panel.", "examples": [ "pieces" ] }, "servingPerContainer": { "type": "string", "description": "Servings per container if present on the nutrition facts panel.", "examples": [ 8 ] }, "nutrients": { "type": "array", "description": "A list of nutrient objects as listed on the nutrition facts panel.", "items": { "$ref": "#/components/schemas/Nutrient" } } } }, "NutrientSymbol": { "type": "object", "description": "Symbols/Footnote indicators for the product that indicate additional information.", "properties": { "symbol": { "type": "string", "examples": [ "*" ] }, "statement": { "type": "string", "examples": [ "One serving adds 8g of sugar to your diet and represents 16% of the Daily Value for Added Sugars." ] } } }, "NutritionClaim": { "type": "object", "description": "FDA nutrient content claims on product's packaging", "properties": { "name": { "type": "string", "examples": [ "Nutritional Guarantee" ] }, "description": { "type": "string", "examples": [ "generic description text" ] }, "mandatory": { "type": "boolean", "examples": [ false ] } } }, "NutritionSection": { "type": "object", "description": "Nutrition section of the product's SmartLabel page.", "properties": { "nutrientPanels": { "description": "List of all nutrition panels for the product. Typically one, but can be multiple in the case of variety packs or similar.", "type": "array", "items": { "$ref": "#/components/schemas/NutrientPanel" } }, "nutritionClaims": { "type": "array", "description": "List of nutrition claims on the product.", "items": { "$ref": "#/components/schemas/NutritionClaim" } }, "nutrientFactPanelFooter": { "type": "string", "examples": [ "NEW_LABEL_2018" ], "enum": [ "NONE", "OLD_LABEL", "NEW_LABEL_2018", "SHORTHAND", "UNKNOWN", "NOT_APPLICABLE" ] }, "nutrientFactPanelCaloriesPerGram": { "type": "string", "description": "Indicates if calories are represented per gram on the product.", "enum": [ "YES", "NO", "UNKNOWN", "NOT_APPLICABLE" ] }, "nutrientFactsPanelDisclaimers": { "type": "array", "description": "A list of nutritional disclaimers associated with the product.", "items": { "$ref": "#/components/schemas/Claim" } }, "nutrientDisclaimer": { "type": "string", "description": "Overall nutrient disclaimer for product.", "examples": [ "Not a significant source of cholesterol, dietary fiber, total sugars, added sugars, vitamin D, calcium, iron, and potassium." ] }, "nutrientSymbols": { "type": "array", "description": "All symbols/footer indicators on the product that point to additional contextual information for a claim.", "items": { "$ref": "#/components/schemas/NutrientSymbol" } }, "calorieContents": { "type": "array", "description": "Calorie content information for the product, by unit of measure.", "items": { "$ref": "#/components/schemas/CalorieContent" } } } }, "OtherSection": { "type": "object", "description": "Additional product information", "properties": { "claims": { "$ref": "#/components/schemas/Claims" }, "certifications": { "type": "array", "items": { "$ref": "#/components/schemas/Certification" } }, "sustainability": { "type": "array", "items": { "$ref": "#/components/schemas/Sustainability" } }, "healthSafeties": { "type": "array", "items": { "$ref": "#/components/schemas/HealthSafety" } }, "productInstructions": { "type": "array", "items": { "$ref": "#/components/schemas/ProductInstruction" } }, "gmoDisclosures": { "type": "array", "items": { "$ref": "#/components/schemas/GmoDisclosure" } }, "generalInformations": { "type": "array", "items": { "$ref": "#/components/schemas/GeneralInformation" } } } }, "ProductImage": { "type": "object", "description": "Image Url for product images", "properties": { "high": { "type": "string" }, "medium": { "type": "string" }, "small": { "type": "string" } } }, "ProductInstruction": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "mandatory": { "type": "boolean" } } }, "SmartLabelApiContract": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "The primary (SL) ID of the product.", "examples": [ 12345 ] }, "landingPageUrl": { "type": "string", "description": "The landing page for this product. Typically the Ingredients/Contents page.", "examples": [ "https://smartlabel.labelinsight.com/product/12345" ] }, "upc": { "type": "string", "description": "UPC for this product.", "examples": [ "00123456789012" ] }, "productType": { "type": "string", "description": "The type of product (e.g., Food, Personal Care, Pet Food, etc.).", "examples": [ "Food" ] }, "manufacturer": { "type": "string", "description": "The manufacturer of the product as listed on the package.", "examples": [ "FakeFood Co Inc." ] }, "distributor": { "type": "string", "description": "The distributor of the product as listed on the package, if present.", "examples": [ "FakeDistro Company LLC." ] }, "organizationId": { "type": "integer", "format": "int32", "description": "The custom ID applied by the product's customer (you), if present.", "examples": [ 123 ] }, "brand": { "type": "string", "description": "The brand of the product as listed on the package.", "examples": [ "FakeBrand Inc" ] }, "subBrand": { "type": "string", "description": "The sub-brand of the product as listed on the package, if present.", "examples": [ "SubBrand Co" ] }, "title": { "type": "string", "description": "The name of the product.", "examples": [ "Imaginary Salted Chips" ] }, "description": { "type": "string", "description": "The standardized product title, consisting of brand, statement of identity, and flavor.", "examples": [ "FakeCo Cake Mix, Chocolate" ] }, "flavour": { "type": "string", "description": "The flavor of the product, if present.", "examples": [ "Chocolate" ] }, "productSize": { "type": "string", "description": "The net weight of the product. This is the value and UOM.", "examples": [ "NET WT 12.5 OZ (354g)" ] }, "productSize2": { "type": "string", "description": "The second net weight of the product, if present on the nutrition facts panel. This is the value and UOM.", "examples": [ "20 lb" ] }, "dateCollected": { "type": "string", "description": "The date the product was onboarded to the Label Insight database. This is NOT necessarily the date the product's SmartLabel page was last published/updated.", "examples": [ "2021-02-23T07:12:37Z" ] }, "timestamp": { "type": "string", "description": "Date the product's status was last changed (Publish/Archive/Delete/Unpublish)" }, "lastIndexed": { "type": "string", "description": "The date of the most recent change to the product in Label Insight's database, returned as a string. This is NOT necessarily the date the product was last published/updated.", "examples": [ "2021-02-23T07:12:37Z" ] }, "landingPageDisclaimer": { "type": "string", "description": "A company specific disclaimer that brands can choose to include globally on all of their SmartLabel landing pages.", "examples": [ "Please refer to the label on your product for more information." ] }, "warnings": { "type": "string", "description": "The allergen warning statement as listed on the package.", "examples": [ "CONTAINS TREE NUTS (ALMONDS)." ] }, "rawIngredients": { "type": "string", "description": "All ingredients as present on the product label’s ingredient declaration.", "examples": [ "ALMOND FLOUR, SUGAR, COCOA POWDER, POWDERED SUGAR (SUGAR, CORN STARCH)" ] }, "marketingImage": { "description": "The image that the brand has chosen to display as the product image on the SmartLabel landing page.", "$ref": "#/components/schemas/ProductImage" }, "usdaCertification": { "description": "USDA stamp on the product's packaging, if present.", "$ref": "#/components/schemas/USDACertification" }, "nutritionSection": { "description": "Nutrient information as present on the product's nutrition fact panel.", "$ref": "#/components/schemas/NutritionSection" }, "ingredientSection": { "description": "Ingredient statement as present on the product label.", "$ref": "#/components/schemas/IngredientSection" }, "allergenSection": { "description": "Allergens present within the product, as indicated by the ingredient statement and/or \"contains\" statement.", "$ref": "#/components/schemas/AllergenSection" }, "otherSection": { "$ref": "#/components/schemas/OtherSection" }, "advisorySection": { "description": "Advisories claims applied to non-food products.", "$ref": "#/components/schemas/AdvisorySection" }, "usageSection": { "description": "Usage claims applied to non-food products.", "$ref": "#/components/schemas/UsageSection" }, "companyBrandSection": { "description": "Required company contact information on package.", "$ref": "#/components/schemas/CompanyBrandSection" }, "labelType": { "description": "Indicates if label is `Old_Label` or `New_Label` to recommended 2018 Label change.", "type": "string", "enum": [ "OLD_LABEL", "NEW_LABEL" ] }, "uniqueIdentifiers": { "type": "array", "description": "This field is deprecated and will be removed in the future.", "items": { "$ref": "#/components/schemas/UniqueIdentifier" } }, "identifiers": { "type": "object", "description": "Unique identifiers provided by company/brand for a specific product.", "additionalProperties": { "type": "string" } }, "variantId": { "type": "string", "description": "Additional identifier for product (the UPC)." }, "gmoPresence": { "type": "string", "description": "Level of GMO presence, if applicable.", "enum": [ "CONTAINS", "MAY_CONTAIN", "FREE", "IS", "EXEMPT", "NOT_SUBJECT", "NONE" ] }, "brickNumber": { "type": "string", "description": "Deprecated field." }, "nyDisclosureLevel": { "type": "string", "examples": [ "Level 1" ] }, "nyFragranceDisclosureLevel": { "type": "string", "examples": [ "Level 5" ] }, "sdsLink": { "type": "string", "description": "Link to safety data sheet, if available. Usually applies to cleaning products.", "examples": [ "https://www.fake_domain.example/document.pdf" ] }, "feedingInstructions": { "type": "array", "description": "Feeding instructions for product (pet food or similar).", "items": { "$ref": "#/components/schemas/FeedingInstruction" } }, "productCollectionType": { "type": "string", "description": "Mostly applies to variety pack products." }, "childProducts": { "type": "array", "description": "Any products organized underneath this product. Variety packs/Multi packs", "items": { "$ref": "#/components/schemas/ChildProduct" } }, "supplierOrganization": { "$ref": "#/components/schemas/SupplierOrganization" }, "supplierVerification": { "$ref": "#/components/schemas/SupplierVerification" }, "headerLogos": { "type": "array", "items": { "$ref": "#/components/schemas/HeaderLogo" } } } }, "SupplierOrganization": { "type": "object", "properties": { "organizationId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "externalReferenceId": { "type": "string" } } }, "SupplierVerification": { "type": "object", "properties": { "type": { "type": "string" }, "supplierVerificationValue": { "type": "string", "enum": [ "CONTAINS", "IS", "FREE_FROM", "EXEMPT", "NONE" ] }, "supplierVerificationStatus": { "type": "string", "enum": [ "ASSIGNED", "VERIFIED", "NOT_MY_PRODUCT", "NONE" ] } } }, "Sustainability": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "website": { "type": "string" }, "mandatory": { "type": "boolean" } } }, "URL": { "type": "object", "properties": { "url": { "type": "string" }, "linkText": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "string" } } }, "USDACertification": { "type": "object", "description": "USDA stamp on the product's packaging, if present.", "properties": { "inspectionCode": { "type": "string", "description": "relevant inspection code / establishment number", "examples": [ "EST.17823" ] }, "image": { "type": "string", "description": "Path to the image used for the USDA Certification logo on the product.", "examples": [ "https://logos.labelinsight.com/USDA_Inspection_mark_on_processed_products.jpeg" ] } } }, "UniqueIdentifier": { "type": "object", "description": "Deprecated", "properties": { "value": { "type": "string" } } }, "Usage": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "mandatory": { "type": "boolean" } } }, "UsageSection": { "type": "object", "description": "Usage claims applied to non-food products.", "properties": { "usages": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```