{ "Alias": "Planogram Inner Pack Front View Image", "Id": "0ec6f74d-4b74-48a7-aa0b-429571c8ed82" }, { "Alias": "Planogram Inner Pack Right View Image", "Id": "a8401cf4-c8c5-4265-b819-521942e50fc6" }, { "Alias": "Planogram Inner Pack Top View Image", "Id": "b6ca7995-9326-42a1-a913-1a235a3e077a" }, { "Alias": "Planogram Straight on Back View Image-Unedited", "Id": "1ebac790-a97c-481b-be3d-9b9a82a5b19d" }, { "Alias": "Planogram Straight on Bottom View Image-Unedited", "Id": "6b017e59-22aa-4df7-b567-01d520ccdbf8" }, { "Alias": "Planogram Straight on Front Shot Image-Unedited", "Id": "1f59b67f-5bfd-4651-b9a1-593231af4979" }, { "Alias": "Planogram Straight on Left View Image-Unedited", "Id": "27937a28-b7cc-4a3c-918e-2d707f4b9152" }, { "Alias": "Planogram Straight on Right View Image-Unedited", "Id": "5229a7d4-3de9-4e07-822d-9151e708fcd4" }, { "Alias": "Planogram Straight on Top View Image", "Id": "1b39ba3d-501e-4951-ae61-4259a63ce400" }, { "Alias": "Open View", "Id": "232de838-cd14-4551-9823-aab8be22ad4f" }, { "Alias": "French Language Image", "Id": "0d3d34fd-90b3-437a-aa9f-4b30e594f783" }, { "Alias": "In the Package View", "Id": "6780e00d-5cf2

"MultiValues": [], "ContainerValues": [ { "ParentAttribute": "QuantityContained", "RowList": [ { "Values": [ { "Name": "Code", "ValuesByLocale": { "en-US": "g" }, "Recipient": "d2257835-5514-4032-841c-cc95245955f5", "Delete": false, "IsExplicitNullValue": false }, { "Name": "Value", "ValuesByLocale": { "en-US": "0.0" }, "Recipient": "d2257835-5514-4032-841c-cc95245955f5", "Delete": false, "IsExplicitNullValue": false } ], "MultiValues": [], "ContainerValues": [], "AssetValues": [], "IsExplicitNullValue": false } ], "Recipient": "d2257835-5514-4032-841c-cc95245955f5", "Delete": false, "IsExplicitNullValue": false } ], "AssetValues": [], "IsExplicitNullValue": false }, { "Values": [ { "Name": "NutrientTypeCode", "ValuesByLocale": { "en-US": "FAT" }, "Recipient": "d2257835-5514-4032-841c-cc95245955f5", "Delete": false, "IsExplicitNullValue": false }, { "Name": "DailyValueIntakePercent", "ValuesByLocale": { "en-US": "8.0" }, "Recipient": "d2257835-5514-4032-841c-cc95245955f5", "Delete": false, "IsExplicitNullValue": false } ], "MultiValues": [], "ContainerValues": [ { "ParentAttribute": "QuantityContained", "RowList": [ { "Values": [ { "Name": "Code", "ValuesByLocale": { "en-US": "g" }, "Recipient": "d2257835-5514-4032-841c-cc95245955f5", "Delete": false,

"IsExplicitNullValue": false }, { "Name": "Value", "ValuesByLocale": { "en-US": "170.0" }, "Recipient": "", "Delete": false, "IsExplicitNullValue": false } ], "MultiValues": [], "ContainerValues": [], "AssetValues": [], "IsExplicitNullValue": false } ], "Recipient": "", "Delete": false, "IsExplicitNullValue": false } ], "AssetValues": [], "IsExplicitNullValue": false } ], "Recipient": "", "Delete": false, "IsExplicitNullValue": false } ], "AssetValues": [], "IsExplicitNullValue": false } ], "Recipient": "", "Delete": false, "IsExplicitNullValue": false } ], "AssetValues": [], "IsExplicitNullValue": false }, "LifeCycle": { "CreatedDate": { "Value": "2020-06-25T03:20:29.287142Z", "Delete": false }, "DiscontinueDate": null, "DeleteDate": null }, "Values": [ { "Name": "1feaad72-2de4-40d2-bef0-559ccb0cc845", "ValuesByLocale": { "en-US": "Physical" }, "Recipient": "", "Delete": false, "IsExplicitNullValue": false }, { "Name": "b5111800-9728-4674-a746-c6eb78994ab8", "ValuesByLocale": { "en-US": "Physical" }, "Recipient": "", "Delete": false, "IsExplicitNullValue": false }, { "Name": "019a6691-7070-4233-8a28-4c7048da6dc3", "ValuesByLocale": { "en-US": "88fe195e-786e-4b69-9e85-2940332a1f8c" }, "Recipient": "", "Delete": false, "IsExplicitNullValue": false }, { "Name": "UPC", "ValuesByLocale": { "en-US": "00029000027268" }, "Recipient": "", "Delete": false, "IsExplicitNullValue": false }, { "Name": "ddceee17-f4db-4251-9329-74e210dbba59", "ValuesByLocale": { "en-US": "1" }, "Recipient": "", "Delete": false, "IsExplicitNullValue": false }, { "Name": "2088a982-6d72-41b2-81e6-9de5c3972307", "ValuesByLocale": { "en-US": "Sunflower Kernels" }, "Recipient": "", "Delete": false, "IsExplicitNullValue

xplicitNullValue": false }, { "Name": "cf587123-d882-4a8c-9815-6f00519d75dd", "ValuesByLocale": { "en-US": "N" }, "Recipient": "9a8bd2a5-73cb-4fd6-bd0c-31bb62c3df8b", "Delete": false, "IsExplicitNullValue": false }, { "Name": "a5bd697d-aab9-427d-a120-ebb6fcdd6851", "ValuesByLocale": { "en-US": "N" }, "Recipient": "9a8bd2a5-73cb-4fd6-bd0c-31bb62c3df8b", "Delete": false, "IsExplicitNullValue": false }, { "Name": "5c8aa028-2f85-45e9-af5d-ae4792e97772", "ValuesByLocale": { "en-US": "N" }, "Recipient": "9a8bd2a5-73cb-4fd6-bd0c-31bb62c3df8b", "Delete": false, "IsExplicitNullValue": false }, { "Name": "cb5248cc-9302-41f5-91a8-ae8ed5ddd812", "ValuesByLocale": { "en-US": "N" }, "Recipient": "9a8bd2a5-73cb-4fd6-bd0c-31bb62c3df8b", "Delete": false, "IsExplicitNullValue": false }, { "Name": "22ab6bb2-9eee-402a-9ae9-d5ee8142faad", "ValuesByLocale": { "en-US": "NA" }, "Recipient": "9a8bd2a5-73cb-4fd6-bd0c-31bb62c3df8b", "Delete": false, "IsExplicitNullValue": false }, { "Name": "717c02e0-a1a0-4b5f-8468-e54434bf09e6", "ValuesByLocale": { "en-US": "NA" }, "Recipient": "9a8bd2a5-73cb-4fd6-bd0c-31bb62c3df8b", "Delete": false, "IsExplicitNullValue": false }, { "Name": "63dbbef4-daa0-4338-8962-8380656f8f89", "ValuesByLocale": { "en-US": "NA" }, "Recipient": "9a8bd2a5-73cb-4fd6-bd0c-31bb62c3df8b", "Delete": false, "IsExplicitNullValue": false }, { "Name": "e36f9204-81f5-47f1-993f-9de6e664528d", "ValuesByLocale": { "en

Phases of Implementation Mapping & Data Validation Requirements Gap Closure Customer Vocab Creation(Update) Payload Build out Testing Move to Production Additional Calls to be implemeted based on API model: Checking Data Quality Publishing Checking for Recipient Feedback Post Implementation Adding Additional Recipients Updating Based on Requirement Set Updates Product Import and Publish Process There are many ways to implement our API and best method may change based on customer needs. Below is an one option that represents the most efficient sequence to import products, update products, imports assets, link to recipients, set category, check DQ, publish, check status, and retrieve feedback. Make sure to read the FAQ to avoid common mistakes and get answers to the most frequently asked questions. Gather Recipient IDs* Gather Taxonomy IDs* Gather all attributes (UI) Authentication Import Product or Update Product Check Data Quality per recipient** Verify call (needed for custom distributions, optional for

8b", "Delete": false, "IsExplicitNullValue": false }, { "Name": "6aa4a0c3-285f-4696-82fe-5466bd6b5234", "ValuesByLocale": { "en-US": "4406cd30-ffdf-4491-ba9b-18f6e68605b1" }, "Recipient": "9a8bd2a5-73cb-4fd6-bd0c-31bb62c3df8b", "Delete": false, "IsExplicitNullValue": false }, { "Name": "e730a004-f954-4b6f-86cf-13f03864ddf2", "ValuesByLocale": { "en-US": "d3f4be14-26f9-4fe3-bcb4-e5ead658b59b" }, "Recipient": "9a8bd2a5-73cb-4fd6-bd0c-31bb62c3df8b", "Delete": false, "IsExplicitNullValue": false }, { "Name": "31d93a71-0e95-4b27-bac3-8329794f7a7c", "ValuesByLocale": { "en-US": "1c9530d0-e74c-4e78-9603-49780ea0b61c" }, "Recipient": "9a8bd2a5-73cb-4fd6-bd0c-31bb62c3df8b", "Delete": false, "IsExplicitNullValue": false }, { "Name": "1b39ba3d-501e-4951-ae61-4259a63ce400", "ValuesByLocale": { "en-US": "a9662105-48a9-44ce-85ea-a479faf909de" }, "Recipient": "9a8bd2a5-73cb-4fd6-bd0c-31bb62c3df8b", "Delete": false, "IsExplicitNullValue": false }, { "Name": "93d22e97-989a-49ed-b499-53909ae70cc2", "ValuesByLocale": { "en-US": "1a0ca527-64c8-4725-90f9-bb6b2a15fbbd" }, "Recipient": "9a8bd2a5-73cb-4fd6-bd0c-31bb62c3df8b", "Delete": false, "IsExplicitNullValue": false }, { "Name": "864ca2dc-cd66-4ff0-9f12-fd808d4cc600", "ValuesByLocale": { "en-US": "42c30591-df98-4ead-a0d4-6838772e0161" }, "Recipient": "9a8bd2a5-73cb-4fd6-bd0c-31bb62c3df8b", "Delete": false, "IsExplicitNullValue": false }, { "Name

DFE µg 1 0 0 432 0 FOLFD Folate, food µg 1 0 0 212 0 FRUS Fructose g 1 0 0 287 0 GALS Galactose g 1 0 0 515 0 GLU_G Glutamic acid g 1 0 0 211 0 GLUS Glucose (dextrose) g 1 0 0 516 0 GLY_G Glycine g 1 0 0 512 0 HISTN_G Histidine g 1 0 0 521 0 HYP Hydroxyproline g 1 0 0 503 0 ILE_G Isoleucine g 1 0 0 213 0 LACS Lactose g 1 0 0 504 0 LEU_G Leucine g 1 0 0 338 0 LUT+ZEA Lutein + zeaxanthin µg 1 0 0 337 0 LYCPN Lycopene µg 1 0 0 505 0 LYS_G Lysine g 1 0 0 214 0 MALS Maltose g 1 0 0 506 0 MET_G Methionine g 1 0 0 304 0 MG Magnesium, Mg

ale String Alias or GUID of the recipient to which the value applies if it is recipient specific. Delete Required for AssetValues Boolean true/false Set to true to delete an existing value. IsExplicitNullValue Required for AssetValues Boolean true/false Indicates if value is intended to be published as empty. ContainerValues Optional Array Holds all attributes of type ContainerValue ComplexValues Optional Array Holds all attributes of type ComplexValue NutritionalInformationModule Optional Module Contains the nutrition panel(s) information ProductIdentifierProperty Required enum Determines the unique identifier attribute to be used as your product identifier, ProductIdentifierValue . Note that this must be unique or the API will not be able to determine which record to update. LifeCycle Optional String Contains multiple fields: CreatedDate {Value, Delete} DiscontinueDate DeleteDate Used to manage the product life cycle. CreatedDate is system generated. DiscontinueDate and DeleteDate can be set by user. See example for details ErrorMode Optional enum Ignore

To update the product medium, mention the following in the postman and then click Send . POST Query Parameters Expand to see the parameters and description Parameter   Parameter Type Data Type Accepted Values Description companyId Required String GUID GUID associated with your company account. Unique to each account vocabularyId Required String GUID Each account using the API has a vocabulary associated with their account that allows for customer defined aliases on attributes. This is the GUID to your company's customer vocabulay file verbose Optional Booleen true/false Defaults to false. provides more verbose output in the response. Does have a major performance cost so is best used only during testing/prototype/troubleshooting whatIf Optional Booleen true/false When set to "true" the importer will run through all of its logic and generate the response output but will not commit any data. Meant for testing shouldIncludeMissingVocabularyAttributes Optional Boolean true/false

Some of the frequently asked questions and responses can be seen here. Images How do you get an image for each returned food ? POST: https://trackapi.nutritionix.com/v2/natural/nutrients and look for the "photo.thumb" object. Check out our natural demo page to see what the photos look like. What are the dimensions of images that are returned from the API? All images returned by the API will be constrained to a specific width, and slightly varying height that will not exceed the width.  In the client, you should plan to scale down images proportionally, and vertically center the images in your UI to ensure they always look uniform. For /search/instant endpoint : Small thumbnails of CPG products and common foods 150px width, variable height up to 150px For /natural/nutrient & /natural/exercise endpoints : Small thumbnails and large images of foods and exercises. small: 150px width, variable height

"RowList": [ { "Values": [ { "Name": "Code", "ValuesByLocale": { "en-US": "MGM" }, "SourceParty": "", "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17", "Delete": false, "IsExplicitNullValue": false } ], "MultiValues": [], "ContainerValues": [], "AssetValues": [], "IsExplicitNullValue": false } ], "SourceParty": "949e31b4-db30-4afb-9bf6-c9494d098a17", "Recipient": "", "Delete": false, "IsExplicitNullValue": false } ], "AssetValues": [], "IsExplicitNullValue": false }, { "Values": [ { "Name": "NutrientTypeCode", "ValuesByLocale": { "en-US": "K" }, "SourceParty": "", "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17", "Delete": false, "IsExplicitNullValue": false } ], "MultiValues": [], "ContainerValues": [ { "ParentAttribute": "QuantityContained", "RowList": [ { "Values": [ { "Name": "Code", "ValuesByLocale": { "en-US": "MGM" }, "SourceParty": "", "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17", "Delete": false, "IsExplicitNullValue": false } ], "MultiValues": [], "ContainerValues": [], "AssetValues": [], "IsExplicitNullValue": false } ], "SourceParty": "949e31b4-db30-4afb-9bf6-c9494d098a17", "Recipient": "", "Delete": false, "IsExplicitNullValue": false } ], "AssetValues": [], "IsExplicitNullValue": false } ], "SourceParty": "",

To update the product full schema, mention the following in the postman and then click Send . POST Query Parameters Expand to see the parameters and description Parameter   Parameter Type Data Type Accepted Values Description companyId Required String GUID GUID associated with your company account. Unique to each account vocabularyId Required String GUID Each account using the API has a vocabulary associated with their account that allows for customer defined aliases on attributes. This is the GUID to your company's customer vocabulay file verbose Optional Booleen true/false Defaults to false. provides more verbose output in the response. Does have a major performance cost so is best used only during testing/prototype/troubleshooting whatIf Optional Booleen true/false When set to "true" the importer will run through all of its logic and generate the response output but will not commit any data. Meant for testing shouldIncludeMissingVocabularyAttributes Optional Boolean true

"Values": [ { "Name": "Code", "ValuesByLocale": { "en-US": "GRM" }, "Recipient": "", "Delete": false, "IsExplicitNullValue": false }, { "Name": "Value", "ValuesByLocale": { "en-US": "0.0" }, "Recipient": "", "Delete": false, "IsExplicitNullValue": false } ], "MultiValues": [], "ContainerValues": [], "AssetValues": [], "IsExplicitNullValue": false } ], "Recipient": "", "Delete": false, "IsExplicitNullValue": false } ], "AssetValues": [], "IsExplicitNullValue": false }, { "Values": [ { "Name": "NutrientTypeCode", "ValuesByLocale": { "en-US": "ENER-" }, "Recipient": "", "Delete": false, "IsExplicitNullValue": false } ], "MultiValues": [], "ContainerValues": [ { "ParentAttribute": "QuantityContained", "RowList": [ { "Values": [ { "Name": "Code", "ValuesByLocale": { "en-US": "E14" }, "Recipient": "", "Delete": false, "IsExplicitNullValue": false }, { "Name": "Value", "ValuesByLocale": { "en-US": "100.0" }, "Recipient": "", "Delete": false, "IsExplicitNullValue": false } ], "MultiValues": [], "ContainerValues": [], "AssetValues": [], "IsExplicitNullValue": false } ], "Recipient": "",

This topic describes the API request header for authentication. It is assumed that you have already set-up all the prerequisites as required before using the API. You must pass certain parameters in the header of each request based on the approach used for authenticating the request. The following table lists the header parameters and the description for the same using the APP ID and APP KEY that are passed in the API Request header for all the endpoints: Name Required for Authentication Description x-app-id string (header) Yes Your Application ID issued from developer.nutritionix.com. A unique identifier to represent the end-user who is accessing the Nutritionix API. x-app-key string (header) Yes Your Application Key issued from developer.nutritionix.com. A unique identifier to represent the end-user who is accessing the Nutritionix API. x-remote-user-id If in development mode, set this

To post data quality of multiple products, mention the following in the postman and then click Send . POST Query Parameters Expand to see the parameters and description Parameter   Parameter Type Data Type Accepted Values Description vocabularyID Required String GUID GUID Headers Authorization : Specify required Auth Token in the header. Request Parameters Expand to see the parameters and description Parameter   Parameter Type Data Type Accepted Values Description dataOwner Required String GUIDs Company identifier identifierValue Required String Dependent on identifierName The unique identifier of the product in question identifierName Required String Dependent on customer vocab Sets the identifier attribute type to be searched targetPartyAlias Required String GUID or recipient alias The recipient that will be used to check data quality against Additional search parameters are available. This uses the same filter options as product search. Important! Your vocabulary must include the top-level attribute "ProductIdentifierProperty" for example: globalTradeItemNumber (GTIN). The attribute

Below you can see how the Asset metadata is structured. GET Headers Authorization : Specify required Auth Token in the header. Request Parameters Expand to see the parameters and description Parameter   Parameter Type Data Type Accepted Values Description Name Required String An asset filename. Specifies the asset's filename. Tags Optional Array of Strings Any tags desired. Provides an array of tags applicable to an asset. BinaryAssetId Required String GUID Binary asset identifier. CollectionCount Optional Integer Collection count A number of collections. UploadDate Required Integer YYYY-MM-DD Determines an upload date. SourceUrl Required String An asset's source URL Ensures the asset is not duplicated.  Stats Required Array of Strings Asset details Includes information about the asset file. Id Part of Stats String An asset GUID It's an asset identifier. BinaryId Part of Stats String The binary file GUID Identifier of a binary file. Hash Part of Stats

Recipients may use more than one requirement set. In this scenario you can specify which requirement set you want linked to your product. Important Keep in mind that this scenario is rare and most recipients have ONLY ONE requirement set defined. To link a product with a specific requirement set, mention the following in the postman and then click Send . POST Query Parameters Expand to see the parameters and description Parameter   Parameter Type Data Type Accepted Values Description companyId Required String GUID GUID associated with your company account. Unique to each account vocabularyId Required String GUID Each account using the API has a vocabulary associated with their account that allows for customer defined aliases on attributes. This is the GUID to your company's customer vocabulay file verbose Optional Booleen true/false Defaults to false. provides more verbose output in the response. Does have a major performance cost so

"MultiValues": [], "ContainerValues": [ { "ParentAttribute": "QuantityContained", "RowList": [ { "Values": [ { "Name": "Code", "ValuesByLocale": { "en-US": "MC" }, "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17", "Delete": false, "IsExplicitNullValue": false } ], "MultiValues": [], "ContainerValues": [], "AssetValues": [], "IsExplicitNullValue": false } ], "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17", "Delete": false, "IsExplicitNullValue": false } ], "AssetValues": [], "IsExplicitNullValue": false }, { "Values": [ { "Name": "NutrientTypeCode", "ValuesByLocale": { "en-US": "CA" }, "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17", "Delete": false, "IsExplicitNullValue": false } ], "MultiValues": [], "ContainerValues": [ { "ParentAttribute": "QuantityContained", "RowList": [ { "Values": [ { "Name": "Code", "ValuesByLocale": { "en-US": "MGM" }, "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17", "Delete": false, "IsExplicitNullValue": false } ], "MultiValues": [], "ContainerValues": [], "AssetValues": [], "IsExplicitNullValue": false } ], "Recipient": "949e31b4-db30-4afb-9bf6-c9494d098a17", "Delete": false, "IsExplicitNullValue": false } ], "AssetValues": [], "IsExplicitNullValue": false }, { "Values": [ { "Name": "Nutri

"tag_name": "hamburger bun", "serving_qty": 1, "common_type": null, "tag_id": "226", "photo": { "thumb": "https://nix-tag-images.s3.amazonaws.com/226_thumb.jpg" }, "locale": "en_US" }, { "food_name": "lean hamburger", "serving_unit": "oz", "tag_name": "lean hamburger", "serving_qty": 3, "common_type": null, "tag_id": "9084", "photo": { "thumb": "https://nix-tag-images.s3.amazonaws.com/9084_thumb.jpg" }, "locale": "en_US" }, { "food_name": "hamburger meat", "serving_unit": "oz, cooked", "tag_name": "ground beef", "serving_qty": 4, "common_type": null, "tag_id": "47", "photo": { "thumb": "https://nix-tag-images.s3.amazonaws.com/47_thumb.jpg" }, "locale": "en_US" }, { "food_name": "hamburger taco", "serving_unit": "taco", "tag_name": "beef taco", "serving_qty": 1, "common_type": null, "tag_id": "2531", "photo": { "thumb": "https://nix-tag-images.s3.amazonaws.com/2531_thumb.jpg" }, "locale": "en_US" }, { "food_name": "hamburger patty", "serving_unit": "oz", "tag_name": "hamburger patty", "serving_qty": 3, "common

t to assoicated recipient default requirement set(s). May have one or more RecipientsToLink. WorkflowId Optional String GUID or as mapped in customer vocabulary Imports or updates and adds it to the Workflow step RecipientsRequirementSets Optional Array Array of recipient requirement sets Recipient with Array of requirement sets Values Optional Array Contains all attribute values to be imported or updated.  MultiValues Optional Array Holds all attributes of type MultiValue AssetValues Optional Array Array of asset attributes. "Name", "ValuesByLocale", "Url", "SourceUrl", "Format" The array of asset attributes. Contains assets' attributes and URLs. Name Optional, Required for AssetValues String Asset attribute name. ValuesByLocale Optional, Required for AssetValues Object Contains attribute's locales e.g. "en-US": {} Object for locale values. Name Part of ValuesByLocale String Asset name as it should appear in the UI. URL Part of ValuesByLocale String URL of the asset in the supplier's asset library. SourceUrl Optional for