itemMaster®

API Documentation
Home

Create Items: Request XML fields description


Input Container/Field

Type

plano

Presence

Meaning

ItemMaster provided Data

items

Array

Required

Items is a root element. Items contains list of item elements.


item

Collection

Required

Item contains all the information related to a product


item.type

String

Required

Type is Attribute of item to define type of the item

Item Types
grocery

companyTrackingId

Collection

Optional

Company tracking id contains all the information related to a item company


companyTrackingId.id

String

Required

ID for the item used by the company


companyTrackingId.name

String

Required

Name of the id for the specified item

This should be optional

ecommerceTitle

String

Required

Name of the item as it would appear in ecommerce channel


ecommerceDescription

String

Required

Factual prose product description that describes the item

frontOfPackageText

String

Optional

All copy/text on the front of package


restOfPackageText

String

Optional

All copy/text, callouts, on the rest of the package (back, top, bottom, sides)


productCodes

Array

Required

Array of product codes of the item
*Required for items with multiple UPCs (e.g. "Dan" single serve coke bottle)


productCodes.productCode

Collection

Required

Contains product code


productCodes.productCode.type

String

Required

Product GTIN

Types
GTIN

manufacturerId

String

Required

IMDB manufacturer identifier

This is an ItemMaster provided Id and will be provided by ItemMaster

categoryId

String

Required

Id is the Attribute of the category Ids (GS1 BRICKS as updated from time to time by ItemMaster), e.g. "Cereals Products Ready to Eat (Shelf Stable)" OR "Chips/Crisps/Snack Mixes Natural/Extruded (Shelf Stable)"

GS1 Category Ids and Values

privateLableItem

Boolean

Optional

Is Item private label/Own brand. Will default to No

Input Value Description
Y true
N false

distributorId

String

Optional

Id of the distributor in ItemMaster database

ItemMaster will provide list to manufacturer

importerId

String

Optional

Id of importer as provided by ItemMaster

ItemMaster will provide list to manufacturer

Media -   Collection -   Required   : Contains all media related information for the item

medium

Collection

Required

Medium is a element to specify all media file details. Medium should present 9 times in a root element media to input all the following 9 view type images.


medium.code

String

Optional

Code to determine if it is an original image or edited image

Possible Values : ORIGINAL and EDITED. Images will be considered as ORIGINAL if this attribute is not set

medium.view

String

Required

Attribute of the medium to represent the image view. Planogram images must be PNG with transparent masks per GS1 Image Standard Section 2.1 with 2500px as the largest dimension (one of W or H needs to be 2500px or greater). For Advertising views images must be per section 4 of the GS1 Image Standard (e.g. TIFF with 300dpi, clipping path named "Path 1", LZW compression, etc.) with 2500px as the largest dimension (one of W or H needs to be 2500px or greater)

View
description
A1C1 Planogram Front
A2C1 Planogram Left
A3C1 Planogram Top
A7C1 Planogram Back
A8C1 Planogram Right
A9C1 Planogram Bottom
A1A3 Advertising Front
A1R1 Advertising Front Side Right Angle
A1L1 Advertising Front Side Left Angle
DATA Item Data Images
OTHER Any other Media
MOBL ItemMaster Mobile Image
OOP Out of Package
OOPF Out of Package Fresh
GLAMOUR Glamour
FAMILY Family
SCALE Scale image
FACTS Image of the "Nutrition Facts" "Drug Facts" or "Supplement Facts" panel on the product packaging. If the product is a multipack and includes multiple facts panels, this image should combine all of them.
BARCODE An image of the bar code for the item, it should be printable and scannable.
INGREDIENTS An image with text listing the ingredients of the product if the product discloses ingredients.
FULLLABEL An image containing the combination of the facts panel and ingredients for the product.
ALT Alternate Image
ALT1 Alternate Image 1
ALT2 Alternate Image 2
ALT3 Alternate Image 3
ALT4 Alternate Image 4
ALT5 Alternate Image 5
ALT6 Alternate Image 6
ALT7 Alternate Image 7
ALT8 Alternate Image 8
ALT9 Alternate Image 9
ALT10 Alternate Image 10
A1L1_ALT1 Alternate Image Front Side Left Angle
A1A3_ALT1 Alternate Image Front Side
A1R1_ALT1 Alternate Image Front Side Right Angle

medium.url

String

Required

URL of the medium image location for ItemMaster to download the source from.


packageData -   Collection -   Required   : Contains all the packaging related information of the product

type

String

Required

Attribute of the packageData

Values
Product
Tray Pack
Case

approximation

Boolean

Required

Attribute of the packageData
Y/N

Defaults to "Yes".

length

Collection

Required

Length package measurement, per GS1 Package Measurement Rules


length.measure

Double

Required

The measurement value for the measurement

The value of the measurement, e.g. the length of 7.4

length.uom

String

Required

Unit measure information for the measure

Complex type made up of Dimensions see DimensionalMeasurementType

height

Collection

Required

Height package measurement, per GS1 Package Measurement Rules


height.measure

Double

Required

The measurement value for the measurement

The value of the measurement, e.g. the height of 7.4

height.uom

String

Required

Unit measure information for the measure

Complex type made up of Dimensions see DimensionalMeasurementType

width

Collection

Required

Width package measurement, per GS1 Package Measurement Rules


width.measure

Double

Required

The measurement value for the measuremen

The value of the measurement, e.g. the width of 7.4

width.uom

String

Required

Unit measure information for the the measure

Complex type made up of Dimensions see DimensionalMeasurementType

weight

Collection

Required

Width package measurement, per GS1 Package Measurement Rules


weight.measure

Double

Required

The measurement value for the measurement

The value of the measurement, e.g. the weight of 7.4 LB

weight.uom

String

Required

Unit measure information for the the measure

Complex type made up of Weight see WeightMeasurementType

unitsInPackage

Integer

Required

Number of unit in inner package in integer


itemCount

Integer

Optional

Package count in integer


packageType

Collection

Required

Type of the package

packageSize

Collection

Required

Package size measurement

Measure of the contents inside (e.g 23) - integer

packageSize.measure

Double

Required

The measurement value for the measurement


packageSize.uom

String

Required

Unit measure information for the measure

Complex type made up of the measure; see PackageMeasurementType (e.g.PACK)

dryWeight

Collection

Optional

Dry weight of the contents in the item

Measure of the contents inside (1.2)

dryWeight.measure

Double

Required

Dry weight value


dryWeight.uom

String

Required

Unit of measurement for the dry weight

Complex type made up of the measure; see WeightMeasurementType (e.g.OZ)

netWeight

Collection

Optional

Net weight information of the package

Measure of the contents inside (5)

netWeight.measure

Double

Required

Value of the net weight measurement


netWeight.uom

String

Required

Unit of measurement for the net weight

Complex type made up of the measure; see WeightMeasurementType (e.g.OZ)

information

String

Optional

Brief, human readable description about the item packaging, e.g. "Tear Across"


recyclable

Boolean

Optional

package is recyclable or not

Y (OR) N

packageManufacturer -   Collection -   Optional   : Contains all the packaging manufacturer related information of the product

name

String

Optional

Name of the package manufacturer


address

String

Optional

Primary address of package manufacturer


address2

String

Optional

Secondary address of package manufacturer


city

String

Optional

Package manufacturer city


state

String

Optional

Package manufacturer state


zip

String

Optional

Package manufacturer zip code


country

String

Optional

Package manufacturer country


email

String

Optional

Package manufacturer email


phone

String

Optional

Package manufacturer phone


url

String

Optional

Package manufacturer url


fax

String

Optional

Package manufacturer fax


packageDistributor -   Collection -   Optional   : Contains all the packaging distributor related information of the product

name

String

Optional

Name of the package distributor


address

String

Optional

Primary address of package distributor


address2

String

Optional

Secondary address of package distributor


city

String

Optional

Package distributor city


state

String

Optional

Package distributor state


zip

String

Optional

Package distributor zip code


country

String

Optional

Package distributor country


email

String

Optional

Package distributor email


phone

String

Optional

Package distributor phone


url

String

Optional

Package distributor url


fax

String

Optional

Package distributor fax


packageImporter -   Collection -   Optional   : Contains all the packaging importer related information of the product

name

String

Optional

Name of the package importer


address

String

Optional

Primary address of package importer


address2

String

Optional

Secondary address of package importer


city

String

Optional

Package importer city


state

String

Optional

Package importer state


zip

String

Optional

Package importer zip code


country

String

Optional

Package importer country


email

String

Optional

Package importer email


phone

String

Optional

Package importer phone


url

String

Optional

Package importer url


fax

String

Optional

Package importer fax


ContentPlus -   Collection -   Optional   : All the Manufacturer custom content.

images

Collection

Optional

Contains list of Manufacturer custom images


images.url

String

Required

URL to get Manufacturer custom images


images.description

String

Required

Description of the provided image


images.description.lang

String

Required

Description language

Supported value "en-US"

logo

Collection

Optional

Contains list of Manufacturer custom images


logo.url

String

Required

Contains list of Manufacturer custom logos


logo.description

String

Required

Description of the provided logo


logo.description.lang

String

Required

Description language

Supported value "en-US"

video

Collection

Optional

Contains list of Manufacturer provided videos


video.url

String

Required

Youtube/Vimeo video URL


video.description

String

Required

Description of the provided video


video.description.lang

String

Required

Description language

Supported value "en-US"

mobile

Collection

Optional

Contains list of Manufacturer custom mobile images


mobile.url

String

Required

URL to get Manufacturer custom mobile image.


mobile.description

String

Required

Description of the provided image


mobile.description.lang

String

Required

Description language

Supported value "en-US"

other

Collection

Optional

Contains list of Manufacturer custom content files


other.url

String

Required

Url of the file


other.description

String

Required

Description of the provided image


other.description.lang

String

Required

Description language

Supported value "en-US"

ecommerceDescription

String

Optional

Manufacturer supplied e-commerce description

longDescription

String

Optional

long description

sellCopy

String

Optional

How to write it, how to sell it, how to buy it

bulletPoints

Collection

Optional

List of manufacturer provided bulletPoints

bulletPoints.bulletPoint

String

Optinal

Manufacturer provided product related content.

keywords

Collection

Optional

List of manufacturer provided keywords

keywords.keyword

String

Optinal

Manufacturer provided product related keywords.

manufacturerContent -   Collection -   Optional   : All the retailer specific custom content.

retailers

Collection

Optional

Contains list of retailers custom content


retailers.id

String

Required

Retailer id


retailers.contentPlus

Collection

Optional

Content plus data corresponding to the retailer


planogramData -   Collection -   Optional   : All the Planogram information of the product

shelfManFlag

Boolean

Optional

Y or N


depthCount

Double

Optional

Value of the product depth Count


widthCount

Double

Optional

Value of the product width Count


heightCount

Double

Optional

Value of the product height Count


depthNesting

Double

Optional

Value of the product depth Nesting


verticalNesting

Double

Optional

Value of the product vertical Nesting


displayDepth

Double

Optional

Value of the product display Depth


displayHeight

Double

Optional

Value of the product display Height


displayWidth

Double

Optional

Value of the product display Width


divisionName

String

Optional

Division Name of the planogram Data


dualNesting

String

Optional

Dual Nesting of the planogram Data


multipleShelfFacings

Integer

Optional

Number of ShelfFacing


pegDown

Double

Optional

Value of the pegDown


pegRight

Double

Optional

Value of the pegRight planogram Data


trayCount

Double

Optional

Value of the tray Count planogram Data


trayDepth

Double

Optional

Value of the tray Depth planogram Data


trayWidth

Double

Optional

Value of the tray Width planogram Data


trayHeight

Double

Optional

Value of the tray Height planogram Data


products -   Collection -   Required   : Products Related Information for the item

product

Collection

Required

Contains product information


product.type

String

Required

Type is Attribute of item to define type of the item. "Grocery" is the required response.

Product Types
grocery

product.description

String

Required

Brief description of the product


product.distributorId

String

Optional

Id of the distributor in ItemMaster database

ItemMaster will provide list to manufacturer

product.importerId

String

Optional

Id of the importer in ItemMaster database

ItemMaster will provide list to manufacturer

product.brandId

String

Required

Id of the brand as supplied by ItemMaster

ItemMaster will provide list to manufacturer

product.subBrands

Array

Optional

All sub-brands of the product


product.subBrands.subBrand

String

Optional

Sub-brand id


product.brandDescription

String

Optional

Brief description of the primary brand


product.secondaryBrandDescription

String

Optional

Brief description of the secondary Brand


product.manufacturerId

String

Optional

Id of the Manufacturer as supplied by ItemMaster, if overriding the Manufacturer above.


product.line

String

Optional

Product Line name e.g. "Flavored Tea Drinks"


product.variety

String

Optional

Variety details of the products e.g. "Arnold Palmer" or "Mango-Peach"


product.seasonal

Boolean

Optional

Product is a Seasonal item with a set period of distribution

Y (OR) N

product.countryOfManufacturing

String

Optional

Comma separated list of countries where product is manufactured or assembled


product.warnings

Array

Optional

List of All the warnings


product.warnings.warning

String

Optional

Warning of the product


product.allergens

Array

Optional

List of all the allergens found in the product.


product.allergens.allergen

String

Optional

Information about one or more allergens (e.g. Contains Soy and Milk).


product.drugInteractions

Boolean

Optional

Item list drug Interactions or not

Y (OR) N

product.directions

String

Optional*

*If the product has directions, this is a required field and it must be populated

Directions for use of the product.


product.indications

String

Optional*

*If the product has indications, this is a required field and it must be populated

Indications/symptoms that the product aids


product.isAerosol Boolean

Optional

Product is Aerosol Y (OR) N
product.isChemical Boolean

Optional

Product is Chemical Y (OR) N
product.isPesticide Boolean

Optional

Product is Pesticide Y (OR) N
product.hasBatteries Boolean Optional Product has Batteries Y (OR) N
product.containsMercury Boolean Optional Product contains Mercury Y (OR) N
product.hasFuelContainer Boolean Optional Product has Fuel Container Y (OR) N
product.containsPaperWood Boolean Optional Product contains PaperWood Y (OR) N
product.compositeWoodCertificationCode Integer Optional Product composite wood certification Code
Code
Description
1 Does not contain composite wood
2 Compliant with phase 1 emission levels. Not compliant for sale in California
3 Compliant with phase 2 emission levels
4 Compliant with NAF (no added formaldehyde) as certified by CARB
5 Compliant with ULEF (ultra low emitting formaldehyde) as certified by CARB
product.hasExpiration Boolean Optional Product has Expiration date or a best used by date Y (OR) N
product.hasWarranty Boolean Optional Product has Warranty Y (OR) N
product.isProp65WarningRequired Boolean Required Product is Prop65Warning Required Y (OR) N
product.isTemperatureSensitive Boolean Optional Product is temperature sensitive Y (OR) N
product.smallPartsWarnings Integer Optional Product small Parts Warnings Code
Code
Description
0 Not Applicable
1 Any ball with a diameter of 1.75 inches (44.4mm) or less that is intended for use by children 3 years or older
2 Any toy or game intended for children 3 years or older but less than 8 years that contains a small ball
3 Any toy and game with small parts intended for use by children at least 3 years old but under 6 years
4 Any latex balloon, or toy or game that contains a latex balloon
5 Any marble intended for children 3 years or older
6 Any toy and game intended for children at least 3 years old but less than 8 years which contains a marble
product.isControlledSubstance Boolean Optional Product is Controlled Substance Y (OR) N
product.hasStateRestrictions Boolean Optional Product has State Restrictions Y (OR) N
product.isNutritionFactsLabelRequired Boolean Optional Product is Nutrition Facts Label Required Y (OR) N
product.isBoxTopsForEducationEligible Boolean Optional Product is Box Tops For Education Eligible Y (OR) N
product.flavor String Optional Flavor of the product
product.food Boolean Optional Product is food Y (OR) N
product.prop65Warning String Optional Prop65 warning text of the product
product.dietaryNeed String Optional Dietary need of the product

product.grocery

Collection

Optional

Product all grocery information


product.grocery.ndcCode

String

Optional

NdcCode of grocery


product.grocery.npnCode

String

Optional

NpnCode of grocery


product.grocery.dinCode

String

Optional

DinCode of grocery


product.grocery.alcoholByVolumePercent

Integer

Optional*

*If the product contains alcohol this is a required field and it must be populated

Percentage of the alcohol by volume for the product.


product.grocery.alcoholType

String

Optional

Type of the alcohol contained, e.g. Gin,Whiskey


product.grocery.ingredients

String

Optional*

*if the product packaging lists ingredients this field is required and must be populated.

All the ingredients details from the packaging


product.grocery.vitaminsAndMinerals

String

Optional*

*if the product lists vitamins and minerals this field is required and must be populated.

List of vitaminsAndMinerals in the product ingredients or nutritional information


product.grocery.nutritionalClaims

Collection

Optional*

*if the product packaging lists any of the below attributes they are required fields and must be populated.

Details of the nutritional claims of the product


product.grocery.nutritionalClaims.fatFree

Boolean

Optional*

*if the product packaging lists this nutritional claim, the field is required and must be populated.

Product is fat Free or not

Y (OR) N

product.grocery.nutritionalClaims.goodSourceOfFiber

Boolean

Optional*

*if the product packaging lists this nutritional claim, the field is required and must be populated.

Product has good fiber source

Y (OR) N

product.grocery.nutritionalClaims.lowFat

Boolean

Optional*

*if the product packaging lists thisnutritional claim, the field is required and must be populated.

Product has low fat

Y (OR) N

product.grocery.nutritionalClaims.lowSodium

Boolean

Optional*

*if the product packaging lists this nutritional claim, the field is required and must be populated.

Product has low sodium

Y (OR) N

product.grocery.nutritionalClaims.sugarFree

Boolean

Optional*

*if the product packaging lists this nutritional claim, the field is required and must be populated

Product is sugar free or not

Y (OR) N

product.grocery.kosherCodes

Array

Optional*

*if the product packaging lists kosher codes, the field is required and must be populated.

All the kosherCodes


product.grocery.kosherCodes.kosherCode

Integer

Optional*

*if the product packaging lists kosher codes, the field is required and must be populated.

Kosher Code of the product

kosherCode Information

product.grocery.containerRefunds

Array

Optional*

*if the product packaging lists container refunds this field is required and must be populated.

All the Container Refunds/Return values and information

Container refunds are listed by state and amount where state law charges a refundable container charge, generally to encourage recycling

product.grocery.containerRefunds.containerRefund

Collection

Optional*

*if the product packaging lists any of the below attributes they are required fields and must be populated.

All the Container Refund/Return value and information


product.grocery.containerRefunds.containerRefund.local

String

Optional

Local state abbreviation of the Container Refund/Return value

Two letter state code e.g- "ME,VT,MA,NY,HI,IA,OR,CT,MI"

product.grocery.containerRefunds.containerRefund.amount

Integer

Optional

Amount(USD) of the Container Refund/Return value

The Container Refund.amount e.g."5¢,5¢,5¢,5¢,5¢,5¢,5¢,5¢,10¢"

product.grocery.certifications

Array

Optional*

*if the product packaging lists any of the below attributes they are required fields and must be populated.

All the certificates listed on the product packaging


product.grocery.certifications.certificate

Integer

Optional

Certificate code of product

product.grocery.recipes

Array

Optional

All the recipe


product.grocery.recipes.recipe

String

Optional

On-pack recipe(s) that the item can be used in (e.g Rice Krispie Treats on Rice Krispie Cereal Box)


product.grocery.foodRelatedIndicators

Collection

Optional*

*if the product packaging lists any of the below attributes they are required fields and must be populated.

All the foodIndicators information


product.grocery.foodRelatedIndicators.vegan

Boolean

Optional

Food Indicators is vegan

Y (OR) N

product.grocery.foodRelatedIndicators.vegetarian

Boolean

Optional

Product is vegetarian

Y (OR) N

product.grocery.foodRelatedIndicators.lactoseFree

Boolean

Optional

Product is lactose free

Y (OR) N

product.grocery.foodRelatedIndicators.flavor

Boolean

Optional

Product contains flavor

Y (OR) N

product.grocery.foodRelatedIndicators.antibioticFree

Boolean

Optional

Product is antibiotic free

Y (OR) N

product.grocery.foodRelatedIndicators.temperatureIndicator

String

Required

Temperature Indication of the product

Temperature Indication Values
Frozen
Chilled
Perishable
Shelf Stable

product.grocery.foodRelatedIndicators.wheatFree

Boolean

Optional*

*if the package contains this indicator this field is required and must be populated.

Product is wheat free

Y (OR) N

product.grocery.foodRelatedIndicators.glutenFree

Boolean

Optional*

*if the package contains this indicator this field is required and must be populated.

Product is gluten free

Y (OR) N

product.grocery.foodRelatedIndicators.hormoneFree

Boolean

Optional*

*if the package contains this indicator this field is required and must be populated.

Product is hormone free

Y (OR) N

product.grocery.foodRelatedIndicators.natural

Boolean

Optional*

*if the package contains this indicator this field is required and must be populated.

Product is natural

Y (OR) N

product.grocery.foodRelatedIndicators.nitratesFree

Boolean

Optional*

*if the package contains this indicator this field is required and must be populated.

Product is nitrates free

Y (OR) N

product.grocery.foodRelatedIndicators.nitritesFree

Boolean

Optional*

Product is nitrites free

Y (OR) N

product.grocery.foodRelatedIndicators.organic

Boolean

Optional*

*if the package contains this indicator this field is required and must be populated.

Product is organic or not

Y (OR) N

product.grocery.foodRelatedIndicators.peanutFree

Boolean

Optional*

*if the package contains this indicator this field is required and must be populated.

Product is peanut free

Y (OR) N

product.grocery.foodRelatedIndicators.readyToCook

Boolean

Optional

Product is ready to cook

Y (OR) N

product.grocery.foodRelatedIndicators.readyToHeat

Boolean

Optional

Product is ready to heat

Y (OR) N

product.grocery.foodRelatedIndicators.dairyFree

Boolean

Optional*

*if the package contains this indicator this field is required and must be populated.

Product is dairy free

Y (OR) N

product.grocery.foodRelatedIndicators.eggFree

Boolean

Optional*

*if the package contains this indicator this field is required and must be populated.

Product is egg free

Y (OR) N

product.grocery.foodRelatedIndicators.nonGmo

Boolean

Optional*

*if the package contains this indicator this field is required and must be populated.

Product is non Gmo

Y (OR) N

product.grocery.foodRelatedIndicators.kosher

Boolean

Optional*

*if the package contains this indicator this field is required and must be populated.

Product has kosher code

Y (OR) N

product.grocery.foodRelatedIndicators.shellfishFree

Boolean

Optional*

*if the package contains this indicator this field is required and must be populated.

Product is shell fish free

Y (OR) N

product.grocery.foodRelatedIndicators.soyFree

Boolean

Optional*

*if the package contains this indicator this field is required and must be populated.

Product is soy free

Y (OR) N

product.grocery.foodRelatedIndicators.milkFree

Boolean

Optional*

*if the package contains this indicator this field is required and must be populated.

Product is milk free

Y (OR) N

product.grocery.foodRelatedIndicators.crustaceanFree

Boolean

Optional*

*if the package contains this indicator this field is required and must be populated.

Product is crustacean free

Y (OR) N

product.grocery.foodRelatedIndicators.fishFree

Boolean

Optional*

*if the package contains this indicator this field is required and must be populated.

Product is fish free

Y (OR) N

product.grocery.foodRelatedIndicators.sesameFree

Boolean

Optional*

*if the package contains this indicator this field is required and must be populated.

Product is sesame free

Y (OR) N

product.grocery.foodRelatedIndicators.nutFree

Boolean

Optional*

*if the package contains this indicator this field is required and must be populated.

Product is nut free

Y (OR) N

product.grocery.foodRelatedIndicators.halal

Boolean

Optional*

*if the package contains this indicator this field is required and must be populated.

Product is halal or not

Y (OR) N

product.grocery.foodRelatedIndicators.paleo

Boolean

Optional*

*if the package contains this indicator this field is required and must be populated.

Product is paleo

Y (OR) N

product.grocery.recycleCodes

String

Optional*

*if the package contains this indicator this field is required and must be populated.

Codes are recycle codes

Y (OR) N

product.grocery.nutritions

Array

Optional*

All the nutrition details/information


product.grocery.nutritions.nutrition

Collection

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Nutrition information of the product


product.grocery.nutritions.nutrition.sequence

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Sub Attribute of the nutritional information


product.grocery.nutritions.nutrition.title

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Title name/header of the nutrition section


product.grocery.nutritions.nutrition.numberServedInPackage

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Details of number of served packages


product.grocery.nutritions.nutrition.numberOfServings

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of the number of servings


product.grocery.nutritions.nutrition.servingSizes

Array

Optional*

*if the package lists this nutrition information this field is required and must be populated.

All the serving size data


product.grocery.nutritions.nutrition.servingSizes.servingSize

Collection

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Serving Size information


product.grocery.nutritions.nutrition.servingSizes.servingSize.Type

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Attribute of the serving size


product.grocery.nutritions.nutrition.servingSizes.servingSize.measure

Double

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of the measurement size


product.grocery.nutritions.nutrition.servingSizes.servingSize.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement for the size

Uom
Description

kg

Kilo grams

g

Grams

mg

Milli grams

mcg/μg

Micro grams

IU

International Units
PCT

Note: Use this data for all applicable following nutrition UOM fields.

product.grocery.nutritions.nutrition.servingSizeFullTxt

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Serving size full text copy written on package


product.grocery.nutritions.nutrition.raccAmt

Collection

Optional*

*if the product lists any of the following attributes, then these fields are required and must be populated

Reference amountinformation (e.g values, daily %, unit of measure)


product.grocery.nutritions.nutrition.raccAmt.measure

Double

Optional

Value of the reference amount measurement


product.grocery.nutritions.nutrition.raccAmt.uom

String

Optional

Unit of measurement for the reference amount


product.grocery.nutritions.nutrition.energy

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of the calories in the product contains


product.grocery.nutritions.nutrition.totalFat

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of the fat amount


product.grocery.nutritions.nutrition.totalFat.calories

Integer

Optional

Attribute of the total fat in calories


product.grocery.nutritions.nutrition.totalFat.dailyPct

Integer

Optional

Attribute of total in daily percentage


product.grocery.nutritions.nutrition.totalFat.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the total fat


product.grocery.nutritions.nutrition.saturatedFat

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of the saturatedFat


product.grocery.nutritions.nutrition.saturatedFat.calories

Integer

Optional

Attribute of the saturated fat in calories


product.grocery.nutritions.nutrition.saturatedFat.dailyPct

Integer

Optional

Attribute of saturated fat in daily percentage


product.grocery.nutritions.nutrition.saturatedFat.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of saturated fat


product.grocery.nutritions.nutrition.polyunsaturatedFat

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of the polyunsaturated fat


product.grocery.nutritions.nutrition.polyunsaturatedFat.dailyPct

Integer

Optional

Attribute of the polyunsaturated fat in daily percentage


product.grocery.nutritions.nutrition.polyunsaturatedFat.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the polyunsaturated fat


product.grocery.nutritions.nutrition.monounsaturatedFat

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of the monounsaturatedFat


product.grocery.nutritions.nutrition.monounsaturatedFat.dailyPct

Integer

Optional

Attribute of monounsaturated fat in daily percentage


product.grocery.nutritions.nutrition.monounsaturatedFat.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of monounsaturated fat


product.grocery.nutritions.nutrition.transFat

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of trans fat


product.grocery.nutritions.nutrition.transFat.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of trans fat


product.grocery.nutritions.nutrition.cholesterol

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of cholesterol


product.grocery.nutritions.nutrition.cholesterol.dailyPct

Integer

Optional

Attribute of the cholesterol in daily percentage


product.grocery.nutritions.nutrition.cholesterol.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the cholesterol


product.grocery.nutritions.nutrition.sodium

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of sodium


product.grocery.nutritions.nutrition.sodium.dailyPct

Integer

Optional

Attribute of sodium in daily percentage


product.grocery.nutritions.nutrition.sodium.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of sodium


product.grocery.nutritions.nutrition.potassium

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of potassium


product.grocery.nutritions.nutrition.potassium.dailyPct

Integer

Optional

Attribute of potassium in daily percentage


product.grocery.nutritions.nutrition.potassium.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of potassium


product.grocery.nutritions.nutrition.carbohydrates

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of the carbohydrates


product.grocery.nutritions.nutrition.carbohydrates.dailyPct

Integer

Optional

Attribute of carbohydrates in daily percentage


product.grocery.nutritions.nutrition.carbohydrates.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of carbohydrates


product.grocery.nutritions.nutrition.dietaryFiber

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of the dietaryFiber


product.grocery.nutritions.nutrition.dietaryFiber.dailyPct

Integer

Optional

Attribute of the dietary fiber in daily percentage


product.grocery.nutritions.nutrition.dietaryFiber.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the dietary fiber


product.grocery.nutritions.nutrition.soluableFiber

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of the soluable fiber


product.grocery.nutritions.nutrition.soluableFiber.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the soluable fiber


product.grocery.nutritions.nutrition.insoluableFiber

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of insoluableFiber


product.grocery.nutritions.nutrition.insoluableFiber.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of insoluable fiber


product.grocery.nutritions.nutrition.sugars

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of the sugar


product.grocery.nutritions.nutrition.sugars.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the sugar


product.grocery.nutritions.nutrition.addedSugars

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of the addedSugars


product.grocery.nutritions.nutrition.addedSugars.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the addedSugars


product.grocery.nutritions.nutrition.chromium

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of the chromium


product.grocery.nutritions.nutrition.chromium.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the chromium


product.grocery.nutritions.nutrition.folate

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of the folate


product.grocery.nutritions.nutrition.folate.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the folate


product.grocery.nutritions.nutrition.manganese

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of the manganese


product.grocery.nutritions.nutrition.manganese.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the manganese


product.grocery.nutritions.nutrition.pantothenicAcid

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of the pantothenicAcid


product.grocery.nutritions.nutrition.pantothenicAcid.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the pantothenicAcid


product.grocery.nutritions.nutrition.selenium

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of the selenium


product.grocery.nutritions.nutrition.selenium.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the selenium


product.grocery.nutritions.nutrition.VitaminK

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of the VitaminK


product.grocery.nutritions.nutrition.VitaminK.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the VitaminK


product.grocery.nutritions.nutrition.vitaminA.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the vitaminA


product.grocery.nutritions.nutrition.vitaminC.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the vitaminC


product.grocery.nutritions.nutrition.calcium.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the calcium


product.grocery.nutritions.nutrition.iron.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the iron


product.grocery.nutritions.nutrition.copper.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the copper


product.grocery.nutritions.nutrition.folicAcid.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the folicAcid


product.grocery.nutritions.nutrition.iodine.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the iodine


product.grocery.nutritions.nutrition.magnesium.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the magnesium


product.grocery.nutritions.nutrition.niacin.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the niacin


product.grocery.nutritions.nutrition.vitaminE.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the vitaminE


product.grocery.nutritions.nutrition.zinc.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the zinc


product.grocery.nutritions.nutrition.phosphorous.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the phosphorous


product.grocery.nutritions.nutrition.riboflavin.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the riboflavin


product.grocery.nutritions.nutrition.thiamin.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the thiamin


product.grocery.nutritions.nutrition.vitaminB12.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the vitaminB12


product.grocery.nutritions.nutrition.vitaminB6.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the vitaminB6


product.grocery.nutritions.nutrition.vitaminD.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the vitaminD


product.grocery.nutritions.nutrition.sugarAlchohol

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of sugarAlchohol


product.grocery.nutritions.nutrition.sugarAlchohol.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

unit of measurement of sugar Alcohol


product.grocery.nutritions.nutrition.otherCarbohydrates

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of carbohydrates


product.grocery.nutritions.nutrition.otherCarbohydrates.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of carbohydrates


product.grocery.nutritions.nutrition.protein

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of protein


product.grocery.nutritions.nutrition.protein.dailyPct

Integer

Optional

Attribute of the protein in daily percentage


product.grocery.nutritions.nutrition.protein.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of protein


product.grocery.nutritions.nutrition.choline

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of choline


product.grocery.nutritions.nutrition.choline.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the choline


product.grocery.nutritions.nutrition.biotin

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of biotin


product.grocery.nutritions.nutrition.biotin.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the biotin


product.grocery.nutritions.nutrition.chloride

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of chloride


product.grocery.nutritions.nutrition.chloride.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the chloride


product.grocery.nutritions.nutrition.inositol

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of inositol


product.grocery.nutritions.nutrition.inositol.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the inositol


product.grocery.nutritions.nutrition.linoleic

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of linoleic


product.grocery.nutritions.nutrition.linoleic.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the linoleic


product.grocery.nutritions.nutrition.molybdenum

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of molybdenum


product.grocery.nutritions.nutrition.molybdenum.uom

String

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Unit of measurement of the molybdenum


product.grocery.nutritions.nutrition.dailyPercentOfVitaminA

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Vitamin A


product.grocery.nutritions.nutrition.dailyPercentOfVitaminC

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Vitamin C


product.grocery.nutritions.nutrition.dailyPercentOfCalcium

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Calcium


product.grocery.nutritions.nutrition.dailyPercentOfIron

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Iron


product.grocery.nutritions.nutrition.dailyPercentOfCopper

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Copper


product.grocery.nutritions.nutrition.dailyPercentOfFolicAcid

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Folic Acid


product.grocery.nutritions.nutrition.dailyPercentOfIodine

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Iodine


product.grocery.nutritions.nutrition.dailyPercentOfMagnesium

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Magnesium


product.grocery.nutritions.nutrition.dailyPercentOfNiacin

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Niacin


product.grocery.nutritions.nutrition.dailyPercentOfPhosphorous

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Phosphorous


product.grocery.nutritions.nutrition.dailyPercentOfRiboflavin

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Riboflavin


product.grocery.nutritions.nutrition.dailyPercentOfThiamin

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Thia min


product.grocery.nutritions.nutrition.dailyPercentOfVitaminB12

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Vitamin B12


product.grocery.nutritions.nutrition.dailyPercentOfVitaminB6

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Vitamin B6


product.grocery.nutritions.nutrition.dailyPercentOfVitaminD

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Vitamin D


product.grocery.nutritions.nutrition.dailyPercentOfVitaminE

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Vitamin E


product.grocery.nutritions.nutrition.dailyPercentOfVitaminZinc

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Vitamin Zinc


product.grocery.nutritions.nutrition.dailyPercentOfAddedSugars

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Added Sugars


product.grocery.nutritions.nutrition.dailyPercentOfChromium

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Chromium


product.grocery.nutritions.nutrition.dailyPercentOfFolate

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Folate


product.grocery.nutritions.nutrition.dailyPercentOfManganese

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Manganese


product.grocery.nutritions.nutrition.dailyPercentOfPantothenicAcid

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Pantothenic Acid


product.grocery.nutritions.nutrition.dailyPercentOfSelenium

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Selenium


product.grocery.nutritions.nutrition.dailyPercentOfVitaminK

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Vitamin K


product.grocery.nutritions.nutrition.dailyPercentOfCholine

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Choline


product.grocery.nutritions.nutrition.dailyPercentOfBiotin

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Biotin


product.grocery.nutritions.nutrition.dailyPercentOfInositol

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Inositol


product.grocery.nutritions.nutrition.dailyPercentOfLinoleic

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Linoleic


product.grocery.nutritions.nutrition.dailyPercentOfMolybdenum

Integer

Optional*

*if the package lists this nutrition information this field is required and must be populated.

Value of daily percentage of Molybdenum


MeasurementType -  Complex Type

MeasurementType

Collection

Required

Complex type used for measurement attributes


measure

Double

Required

The measurement value for the measurement


uom

String

Required

Unit measure information for the measurement

A unit of measure designation, e.g. IN, OZ, ML, CM.

DimensionalMeasurementType -   derived from MeasurementType

DimensionalMeasurementType

Collection

Required

Used for dimensional measurements

Dimensional measurements are length, width, height

measure

Double

Required

The measurement value for the measurement

The value of the measurement, e.g. the length of 7.4

uom

String

Required

Unit measure information for the the measure

Complex type made up of Dimensions, Weight, Liquid value, and Package

FT

Foot

IN

Inch

CM

Centimeter

YARDS

Yard

SQ FT

Square foot

SQ IN

Square inch

SQ CM

Square Centimeter

WeightMeasurementType -   derived from MeasurementType

WeightMeasurementType

Collection

Required

Used for weight measurements

Weight measurements are ounce, pound, gram, kilogram

measure

Double

Required

The measurement value for the measurement

The weight measurement, e.g. the weight of 7.4

uom

String

Required

Unit measure information for the measure

Complex type made up of Dimensions, Weight, Liquid value, and Package

OZ

Ounce

LB

Pound

MG

Milligram

G

Gram

KG

Kilogram

LiquidMeasurementType -   derived from MeasurementType

LiquidMeasurementType

Collection

Required

Used for Liquid measurements

Liquid measurements e.g. FL OZ, L or ML

measure

Double

Required

The measurement value for the measurement

Liquid measurement, e.g. 7.4 L

uom

String

Required

Unit measure information for the measure

Complex type made up of Dimensions, Weight, Liquid value, and Package

FL OZ

Fluid Ounce

GAL

Gallon

PT

Pint

QT

Quart

ML

Milliliter

L

Liter

PackageMeasurementType -   derived from MeasurementType

PackageMeasurementType

Collection

Required

Used for package measurements


measure

Double

Required

The measurement value for the measurement

Package measurement e.g. Pack, Kit, Box, Case

uom

String

Required

Unit measure information for the measure

Complex type made up of Dimensions, Weight, Liquid value, and Package

Uom
Description

BAR

Number of bars

BOX

Number of boxes

CT

Number of things

CUP

Number of cups

FL OZ

Fluid Ounce

FT

Foot

G

Gram

GAL

Gallon

IN

Inch

KIT

Number of kits

KG

Kilogram

KT

Synonym of KIT

L

Liter

LB

Pound

MG

Milligram

ML

Milliliter

OZ

Ounce

PACK

Number packs

PACKAGE

Synonym of PACK

PIECE(S)

Number of pieces in a set

PR

Pair

PT

Pint

QT

Quart

SQ FT

Square foot

SQ IN

Square inch

TBS

Tablespoon

YARDS

Yard

attributes -   Collection -   Optional   : Attributes of the product

attribute

Collection

Optional

Attribute information

Additional attributes as name/value pairs to be included in the product record and shared with distribution partners

attribute.name

String

Required

Name of the Attribute

Name of the custom attribute, e.g. packagingRevision, 2018PackagingCompliant

attribute.value

String

Required

Value of the Attribute

Value of the custom attribute, e.g. 2017Q1r3 or true


Create Items: Response XML fields description


Input Container/Field

Type

Occurrence

Meaning

feedId String Required

 A correlation id to partners so that they can query the status and response later for the feed.