ItemMaster®

API Documentation

ITEMMASTER API v2.2

ItemMaster's API is an HTTP API using URL parameters to make queries with HTTP GET to retrieve data and POST to upload data.

The API is versioned and as the ItemMaster platform evolves, the API will change, both in the data that is available and the paradigm used to retrieve or upload data. When possible changes that don't break XSD schema validation will be made to existing API versions. When a change would change the schema in a breaking way, a new version of the API will be created. All updates will be documented and posted.

The ItemMaster platform is open and covered by terms of service agreements signed by your company and ItemMaster. A copy of that agreement can be found here for reference. Images provided by CDN can be downloaded into an end-point of your choice or linked directly to via our On Demand service.

Changes from v2.1

Add v=true parameter for filtering by verified items

Please use the updated XSD file for validating XML

API Documentation

An ItemMaster API request is an HTTP URL of the following form:

							https://api.itemmaster.com/v2.2/{service}?{parameters}
                        

Response Codes

The HTTP response should be checked after each success.

Status CodeReasonResponsibility
200 OKSuccessful request, no errorsNobody
400 Bad RequestThe API request was malformed, i.e. a required parameter was missing or a parameter value was invalid.Yours
403 ForbiddenHTTP Header credentials are missing or invalid.Yours
404 Not FoundThe API service does not existYours
405 Method Not AllowedThe API service does not allow a call to this URIYours
406 Not AcceptableYou have reached your daily limit for downloaded itemsYours
500 Internal Server ErrorThere was a bug in our code and the API call broke. If you see this, please let us know.Ours
503 Service UnavailableThe API server is down for temporary maintenance. When this occurs, try your call again in a few minutes.Ours

Service Calls

Manufacturer Search

Returns a listing of manufacturers (XSD) in the ItemMaster database.

Service:

                    			https://api.itemmaster.com/v2.2/manufacturer/{optional-path-parameter}
                            

Path parameter:

  • {manufacturerId} (optional) - manufacturer id to return data for single manufacturer (XSD)

Example

                    		$ curl --header "username:xxx" --header "password:yyy" 'https://api.itemmaster.com/v2.2/manufacturer'
                 			<manufacturers>
                 				 <numberOfResults>2012</numberOfResults>
                 				 <resultsPerPage>2147483647</resultsPerPage>
                 				 <startIndex>0</startIndex>
                 				 <manufacturer id="a12137b1-3458-11e0-946b-005056957023">
                 				  <name>1-2-3 Gluten Free, Inc.</name>
                 				 </manufacturer>
                 				 <manufacturer id="45193851-6c5b-11e1-9afb-005056ab0051">
                 				  <name>14 Hands Winery</name>
                 				 </manufacturer>
                 			</manufacturers>
                            

Paging

                    		$ curl --header "username:xxx" --header "password:yyy" 'https://api.itemmaster.com/v2.2/manufacturer?idx=1000'
                      <This will allow you to page through manufacturers 1000 at a time, starting from the 1000th manufacturer>
                            
                        $ curl --header "username:xxx" --header "password:yyy" 'https://api.itemmaster.com/v2.2/manufacturer?idx=1000&limit=1000'
                      <This will show 1000 manufacturers at most, starting from the 1000th manufacturer>
                        

Brand Search

Returns a listing of brands (XSD) in the ItemMaster database.

Service:

                    			https://api.itemmaster.com/v2.2/brand/{optional-path-parameter}
                            

Path parameter:

  • {brandId} (optional) - brand id to return data for single brand (XSD)

Example

                    		$ curl --header "username:xxx" --header "password:yyy" 'https://api.itemmaster.com/v2.2/brand'
                 			<brands>
                 				 <numberOfResults>3322</numberOfResults>
                 				 <resultsPerPage>2147483647</resultsPerPage>
                 				 <startIndex>0</startIndex>
                 				 <brand id="b79497d2-3458-11e0-946b-005056957023">
                 				  <name>1-2-3 Gluten Free, Inc.</name>
                 				 </brand>
                 				 <brand id="fde52ea2-e2dd-11e0-9852-005056957023">
                 				  <name>1-Day</name>
                 				 </brand>
                 			</brands>
                            

Paging

                    		$ curl --header "username:xxx" --header "password:yyy" 'https://api.itemmaster.com/v2.2/brand?idx=1000'
                      <This will allow you to page through brands 1000 at a time, starting from the 1000th brand>
                            
                        $ curl --header "username:xxx" --header "password:yyy" 'https://api.itemmaster.com/v2.2/brand?idx=1000&limit=1000'
                      <This will show 1000 brands at most, starting from the 1000th brand>
                            

Distributor Search

Returns a listing of distributors (XSD) in the ItemMaster database.

Service:

                                https://api.itemmaster.com/v2.2/distributor
                            

Example

                            $ curl --header "username:xxx" --header "password:yyy" 'https://api.itemmaster.com/v2.2/distributor'
                            <distributors>
                                 <numberOfResults>3322</numberOfResults>
                                 <resultsPerPage>2147483647</resultsPerPage>
                                 <startIndex>0</startIndex>
                                 <distributor id="b79497d2-3458-11e0-946b-005056957023">
                                  <name>1-2-3 Gluten Free, Inc.</name>
                                 </distributor>
                                 <distributor id="fde52ea2-e2dd-11e0-9852-005056957023">
                                  <name>1-Day</name>
                                 </distributor>
                            </distributors>
                            

Paging

                        $ curl --header "username:xxx" --header "password:yyy" 'https://api.itemmaster.com/v2.2/distributor?idx=1000'
                      <This will allow you to page through distributors 1000 at a time, starting from the 1000th distributor>
                            
                        $ curl --header "username:xxx" --header "password:yyy" 'https://api.itemmaster.com/v2.2/distributor?idx=1000&limit=1000'
                      <This will show 1000 distributors at most, starting from the 1000th distributor>
                            

Retailer Search

Returns a listing of retailers (XSD) in the ItemMaster database.

Service:

                    			https://api.itemmaster.com/v2.2/retailer/{optional-path-parameter}
                            

Path parameter:

  • {retailerId} (optional) - retailer id to return data for single retailer (XSD)

Example

                    		$ curl --header "username:xxx" --header "password:yyy" 'https://api.itemmaster.com/v2.2/retailer'
                 			<retailers>
                 				 <numberOfResults>1</numberOfResults>
                 				 <resultsPerPage>100</resultsPerPage>
                 				 <startIndex>0</startIndex>
                 				 <retailer id="000a0-966690-13e4-2e4-0050593340051">
                 				  <name>Some Company</name>
                 				 </retailer>
                 			</retailers>
                            

Paging

                    		$ curl --header "username:xxx" --header "password:yyy" 'https://api.itemmaster.com/v2.2/retailer?idx=1000'
                      <This will allow you to page through retailers 1000 at a time, starting from the 1000th retailer>
                            
                        $ curl --header "username:xxx" --header "password:yyy" 'https://api.itemmaster.com/v2.2/retailer?idx=1000&limit=1000'
                      <This will show 1000 retailers at most, starting from the 1000th retailer>
                            

Content+ Feed

Get API request returns the status of a identified Content+ feed (XSD). You can get the feed id from here

Service:

                                https://api.itemmaster.com/v2.2/feed/contentplus/{ feed id }
                            

Example

                                $ curl --header "username:xxx" --header "password:yyy" 'https://api.itemmaster.com/v2.2/feed/contentplus/{ feed id }'
                                <FeedStatusResponse xmlns="http://www.itemmaster.com/feed/status">
                                     <feedId>{ feed id }</feedId>
                                     <feedStatus>PROCESSED</feedStatus>
                                     <itemsReceived>1</itemsReceived>
                                     <itemsSucceeded>0</itemsSucceeded>
                                     <itemsProcessed>1</itemsProcessed>
                                     <itemsRejected>0</itemsRejected>
                                     <itemsFailed>0</itemsFailed>
                                     <itemsProcessing>0</itemsProcessing>
                                     <offset>0</offset>
                                     <limit>100</limit>
                                     <ItemDetails>
                                      <ItemIngestionStatus>
                                       <index>1</index>
                                       <ingestionStatus>PROCESSED</ingestionStatus>
                                       <ingestionRemarks>Content Plus Processed</ingestionRemarks>
                                      </ItemIngestionStatus>
                                     </ItemDetails>
                                </FeedStatusResponse>
                            


Post API request creates adds or updates Content+ content for the listed items item (XSD) in the ItemMaster database.

Service:


                                https://api.itemmaster.com/v2.2/feed/contentplus/
                            
Retailer Search Link
Item Search Link

Example

                                $ curl --header "username:xxx" --header "password:yyy" --header "Content-Type: application/xml" --data "{path to the file}/datafile.txt" 'https://api.itemmaster.com/v2.2/feed/contentplus/'
                                <FeedAcknowledgement xmlns="http://www.itemmaster.com/feed">
                                     <feedId>{ a new feed id }</feedId>
                                </FeedStatusResponse>

                                Data file example:

                                <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                                 <contentPlus xmlns="http://www.itemmaster.com/feed/contentplus">
                                  <item id="{ item id 1 }">
                                   <retailer id="{ retailer id 1 }">
                                    <longDescription>Clif Bar Blueberry Crisp - 12 CT</longDescription>
                                    <ecommerceDescription>Clif® Bar Blueberry Crisp. Made with organic rolled oats. Provides nutrition for sustained energy. This energy bar is free from GMO's.</ecommerceDescription>
                                    <keywords>
                                     <keyword>clifbar</keyword>
                                     <keyword>blueberry</keyword>
                                    </keywords>
                                    <sellCopy>At Clif, we're passionate about food. Food that feeds and inspires the adventure in all of us. Whether you're going on a hike, hitting the slopes, or competing in a triathlon, our recipes are purposefully crafted to help provide the energy you need</sellCopy>
                                    <bulletPoints>
                                     <bulletPoint>Inspired by the home-baked flavor of blueberry crisp fresh from the oven.</bulletPoint>
                                    </bulletPoints>
                                    <images>
                                     <medium>
                                      <url>http://i.imgur.com/oUPIIMT.jpg</url>
                                      <description>Clif Bar Blueberry Crisp</description>
                                     </medium>
                                    </images>
                                    <logos>
                                     <medium>
                                      <url>http://i.imgur.com/oUPIIMT.jpg</url>
                                      <description>Clif Bar Blueberry Crisp - 12 CT</description>
                                     </medium>
                                    </logos>
                                    <videos>
                                     <medium>
                                      <url>https://www.youtube.com/embed/eo31rlrwkMk</url>
                                      <description>Clif Bar: Farmers Speak - A Call for the Next Generation</description>
                                     </medium>
                                    </videos>
                                    <mobile>
                                     <medium>
                                      <url>http://i.imgur.com/4AiXzf8.jpg</url>
                                      <description>Clif Bar Blueberry Crisp</description>
                                     </medium>
                                    </mobile>
                                    <other>
                                     <medium>
                                      <url>http://i.imgur.com/4wief8.jpg</url>
                                      <description>Clif Bar Triathlon Nutrition Program</description>
                                     </medium>
                                    </other>
                                   </retailer>
                                  </item>
                                 </contentPlus>
                            

Item Search

Returns a listing of items (XSD) in the ItemMaster database. The data contains full HTTP URL values to the images to download. If you do not pass an itemId as a path parameter then at least one of the following request parameters MUST be present with a value (q, m, b, upc, since,before)

NOTE: You must pass one of the following parameters with a value to receive image urls for the requested items (pi, pip, ef, eip, epl, epf, epr, etni, estd, estdin). See parameter information below for details regarding these parameters.

Service:

                    			https://api.itemmaster.com/v2.2/item/{optional-path-parameter}?{optional-request-parameters}
                            

Path parameter:

  • {itemId} (optional) - item id to return data for single item

Request parameter:

idxPagination: which item to start with (0-based). If not passed will be set to 0.Number
limitPagination: how many records to bring back.Number
qDescription: Retrieve all items that match the words in the descriptionString
mManufacturer Id: Retrieve all items for a particular manufacturerString
bBrand Id: Retrieve all items for a particular brandString
upcUPC Code: Retrieve all items for a particular UPC codeString
sinceUpdated Since Date: Return all items that have been updated since a particular date (inclusive). String (YYYYMMDD)
untilUpdated Until Date: Return all items that have been updated before a particular date (inclusive). String (YYYYMMDD)
piSpecifies if the planogram images returned should be the original (unedited) or the edited. Defaults to no images. String
Values:
  o - Original
  c - Edited
  b - Both
  none - None
ptgaSpecifies the file size for TGA-16 planogram images in kilobytes. Defaults to 100KB Number
Values:
  50 - (50KB)
  100 - (100KB)
pipThe resulting PPI of the planogram images. Specify only if you would like a different/lower PPI than the original image.Integer
efThe resulting format of the ecommerce images. String
Values:
  jpg, png, tif
eipThe resulting PPI of the ecommerce images. Specify only if you would like a different/lower PPI than the original image.Integer
epThe resulting size of the ecommerce planogram images. This parameter can be passed multiple times with different values to return multiple sizes for the image.
Note: Ecommerce images are square so passing a value of 150 will result in images of size 150x150.
Integer
Values:
  50, 100, 150
  200, 600, 900, 1000
eplThe resulting size of the ecommerce left image. This parameter can be passed multiple times with different values to return multiple sizes for the image.
Note: Ecommerce images are square so passing a value of 150 will result in images of size 150x150.
Integer
Values:
  50, 100, 150
  200, 600, 900, 1000
epfThe resulting size of the ecommerce front image. This parameter can be passed multiple times with different values to return multiple sizes for the image.
Note: Ecommerce images are square so passing a value of 150 will result in images of size 150x150.
Integer
Values:
  50, 100, 150
  200, 600, 900, 1000
eprThe resulting size of the ecommerce right image. This parameter can be passed multiple times with different values to return multiple sizes for the image.
Note: Ecommerce images are square so passing a value of 150 will result in images of size 150x150.
Integer
Values:
  50, 100, 150
  200, 600, 900, 1000
etniThe resulting size of the ecommerce thumbnail image. This parameter can be passed multiple times with different values to return multiple sizes for the image.
Note: Ecommerce images are square so passing a value of 150 will result in images of size 150x150.
Integer
Values:
  50, 100, 150
  200, 600, 900, 1000
estdThe resulting size of the ecommerce standard image. This parameter can be passed multiple times with different values to return multiple sizes for the image.
Note: Ecommerce images are square so passing a value of 150 will result in images of size 150x150.
Integer
Values:
  50, 100, 150
  200, 600, 900, 1000
estdinThe resulting size of the ecommerce standard info image. This parameter can be passed multiple times with different values to return multiple sizes for the image.
Note: Ecommerce images are square so passing a value of 150 will result in images of size 150x150.
Integer
Values:
  50, 100, 150
  200, 600, 900, 1000
esiRequest scale image Boolean
Values:
  true, false
allImgRequest all additional images String
Values:
  Y, N
Default:
  N
vLimit to verified items Boolean
Values:
  true, false
profileLimit to record type (default complete) String
Values:
  complete
standard
listing
analytics

Example

 
                    		$ curl --header "username:xxx" --header "password:yyy" 'https://api.itemmaster.com/v2.2/item?idx=0&limit=500&epl=50&epl=100&epf=50&epf=100&ef=png'

<?xml version="1.0" encoding="UTF-8"?>
<items xmlns="http://www.itemmaster.com/item" start="0" count="7"
	total="7">
	<item id="0168ad60-da49-11e0-aa6d-005056957023" status="P">
		<name>3 Musketeers Chocolate Candy Bar</name>
		<marketingDescription>3 Musketeers&#174; Bars. 45% less fat. 2 to
			go. Whipped up, fluffy chocolate-on-chocolate taste. 45% less fat
			than average of the leading chocolate brands. A lighter way to enjoy
			Chocolate&#174;.</marketingDescription>
		<otherDescription>We value your questions or comments. Call
			1-800-551-0698 or visit us at www.3musketeers.com. Please save the
			unused product and wrapper. 6g fat per 47g serving vs. 12g average
			for leading chocolate brands. Big on chocolate, not on
			fat!&#174;. www.3musketeers.com. &#174;/&trade;)
			trademarks &#169;Mars, Incorporated.</otherDescription>
        <ecommerceDescription>ecommerce description</ecommerceDescription>
        <manufacturerEcommerceDescription>content+ ecommerce description</manufacturerEcommerceDescription>
		<upcs>
			<upc type="UPC">00040000006039</upc>
		</upcs>
		<categories>
			<category type="GS1" id="10000046">Chocolate/Sugar Candy Combination
				Confectionery</category>
		</categories>
		<created id="ItemMaster">2011-09-08T00:00:00.000-05:00</created>
		<lastUpdated id="d29a023d-bf8c-11e0-b129-005056957023">2011-11-02T00:00:00.000-05:00
		</lastUpdated>
		<media>
			<medium type="edited" view="A1C1" mimeType="image/tga"
				imageSource="ITEMMASTER" added="2011-10-25T00:00:00.000-05:00">
				<description>Planogram Front</description>
				<url>http://media.itemmaster.com/0/0/0/793/4c2a60bb-2812-4a4d-a11a-5b6b1e231c06.tga
				</url>
			</medium>
			<medium type="edited" view="A2C1" mimeType="image/tga"
				imageSource="ITEMMASTER" added="2011-10-25T00:00:00.000-05:00">
				<description>Planogram Left</description>
				<url>http://media.itemmaster.com/0/0/0/793/63543e5d-26ce-4aac-b88d-dc139320b884.tga
				</url>
			</medium>
			<medium type="edited" view="A3C1" mimeType="image/tga"
				imageSource="ITEMMASTER" added="2011-10-25T00:00:00.000-05:00">
				<description>Planogram Top</description>
				<url>http://media.itemmaster.com/0/0/0/793/52104ebc-5b47-4f65-9daa-4f41d5ddd612.tga
				</url>
			</medium>
			<medium type="edited" view="A7C1" mimeType="image/tga"
				imageSource="ITEMMASTER" added="2011-10-25T00:00:00.000-05:00">
				<description>Planogram Back</description>
				<url>http://media.itemmaster.com/0/0/0/793/9aed4ac4-7828-4fe2-a423-e444dea59299.tga
				</url>
			</medium>
			<medium type="edited" view="A8C1" mimeType="image/tga"
				imageSource="ITEMMASTER" added="2011-10-25T00:00:00.000-05:00">
				<description>Planogram Right</description>
				<url>http://media.itemmaster.com/0/0/0/793/f22f0dfc-bf0d-4b86-bf93-b9023f2cedef.tga
				</url>
			</medium>
			<medium type="edited" view="A9C1" mimeType="image/tga"
				imageSource="ITEMMASTER" added="2011-10-25T00:00:00.000-05:00">
				<description>Planogram Bottom</description>
				<url>http://media.itemmaster.com/0/0/0/793/1fdd93cd-0cb6-4623-a39c-cf1108bdfe8b.tga
				</url>
			</medium>
			</media>
		<packageData type="Item" approximation="true">
			<packageType id="b884ce0c-08f0-11de-abfb-1e0ad616ea54">BAR</packageType>
		</packageData>
		<products>
			<product sequence="1" id="006aec70-da49-11e0-aa6d-005056957023"
				type="">
				<description>3 Musketeers Chocolate Candy Bar</description>
				<brand id="0dde8c90-bc18-11df-b90a-005056957023">3 Musketeers</brand>
				<manufacturer id="d384d7b0-a566-11df-9431-005056957023">Mars Chocolate North America, LLC.
				</manufacturer>
				<warnings>
					<warning />
				</warnings>
				<grocery>
					<ingredients>Milk Chocolate (Sugar, Chocolate, Cocoa Butter, Skim
						Milk, Lactose, Milkfat, Soy Lecithin), Sugar, Corn Syrup,
						Hydrogenated Palm Kernel Oil and/or Palm Oil, less than 2% Cocoa
						Powder Processed with Alkali, Salt, Egg Whites, Artificial and
						Natural Flavors.</ingredients>
					<kosherCodes>
						<kosherCode />
						<kosherCode />
					</kosherCodes>
					<containerRefunds>
						<containerRefund>
                                                    <local>CA</local>
                                                    <amount>$0.1</amount>
						</containerRefund>
						<containerRefund>
                                                    <local>IL</local>
                                                    <amount>$0.15</amount>
						</containerRefund>
					</containerRefunds>
					<nutritions>
						<nutrition sequence="1">
							<numberOfServings>2</numberOfServings>
							<servingSizes>
								<servingSize type="other">
									<measure>1.0</measure>
									<uom>bar</uom>
								</servingSize>
							</servingSizes>
							<energy>200</energy>
							<totalFat uom="g" dailyPct="9" calories="60">6</totalFat>
							<saturatedFat uom="g" dailyPct="20" calories="">4
							</saturatedFat>
							<transFat uom="g">0</transFat>
							<cholesterol uom="mg" dailyPct="2">5</cholesterol>
							<sodium uom="mg" dailyPct="4">85</sodium>
							<carbohydrates uom="g" dailyPct="12">36</carbohydrates>
							<dietaryFiber uom="g">1</dietaryFiber>
							<sugars uom="g">31</sugars>
							<chromium uom="g">1</chromium>
							<folate uom="g">2</folate>
							<manganese uom="g">3</manganese>
							<pantothenicAcid uom="g">4</pantothenicAcid>
							<selenium uom="g">5</selenium>
							<vitaminK uom="g">6</vitaminK>
							<vitaminA uom="g">31</vitaminA>
							<vitaminC uom="g">1</vitaminC>
							<calcium uom="g">2</calcium>
							<iron uom="g">3</iron>
							<copper uom="g">4</copper>
							<folicAcid uom="g">5</folicAcid>
							<iodine uom="g">6</iodine>
							<magnesium uom="g">31</magnesium>
							<niacin uom="g">1</niacin>
							<vitaminE uom="g">2</vitaminE>
							<zinc uom="g">3</zinc>
							<phosphorous uom="g">4</phosphorous>
							<riboflavin uom="g">5</riboflavin>
							<thiamin uom="g">6</thiamin>
							<vitaminB12 uom="g">4</vitaminB12>
							<vitaminB6 uom="g">5</vitaminB6>
							<vitaminD uom="g">6</vitaminD>
							<protein uom="g" dailyPct="">1</protein>
							<dailyPercentOfVitaminA>0</dailyPercentOfVitaminA>
							<dailyPercentOfVitaminC>0</dailyPercentOfVitaminC>
							<dailyPercentOfCalcium>2</dailyPercentOfCalcium>
							<dailyPercentOfIron>0</dailyPercentOfIron>
							<dailyPercentOfChromium>1</dailyPercentOfChromium>
							<dailyPercentOfFolate>2</dailyPercentOfFolate>
							<dailyPercentOfManganese>3</dailyPercentOfManganese>
							<dailyPercentOfPantothenicAcid>4</dailyPercentOfPantothenicAcid>
							<dailyPercentOfSelenium>5</dailyPercentOfSelenium>
							<dailyPercentOfVitaminK>6</dailyPercentOfVitaminK>
						</nutrition>
					</nutritions>
				</grocery>
			</product>
		</products>
		<packageDistributor>
			<name>Mars Snackfood US, LLC</name>
			<address>Hackettstown, NJ 07840-1503 USA</address>
			<email />
			<phone>1-800-551-0698</phone>
			<url>www.3musketeers.com</url>
		</packageDistributor>
		<packageImporter>
			<name>Mars Snackfood US, LLC</name>
			<address>Hackettstown, NJ 07840-1503 USA</address>
			<email />
			<phone>1-800-551-0698</phone>
			<url>www.3musketeers.com</url>
		</packageImporter>
		<attributes />
	</item>
</items>
                            

Create items

There are two endpoints that can be used to ingest new item records with ItemMaster. These endpoints support creation of more than one item at a time. The API will return a token, which can then be used to poll at regular intervals for status on the ingestion of records.

Service Option 1 of 2 (All Commerce Items Only):

Use the following endpoint if you want explicit ingestion and validation responses for All Commerce Items ONLY - Listing and Standard items will not be ingested.

                                 https://api.itemmaster.com/v2.2/feed/items
                            

Request Body:

  • {ingestItems XML} (mandatory) - ingestItems xml with all mandatory data in request body to create items (XSD)

Request Headers:

  • username - xxx
  • password - yyy
  • Content-Type - application/xml
Ingest items Request and Response fields/attributes details

Example

                            $ curl -X POST --header "username:xxx" --header "password:yyy" --header "Content-Type:application/xml" -d @/home/items/ingestItems.xml 'https://api.itemmaster.com/v2.2/feed/items'

                            

ingestItems.xml

<?xml version="1.0" encoding="UTF-8"?> <items xmlns="http://www.itemmaster.com/feed/item">   <item type="grocery" xmlns="http://www.itemmaster.com/feed/item">    <companyTrackingId id="17456789" name="Chocolove"/>    <ecommerceTitle>Chocolove Salted Caramel In Dark Chocolate</ecommerceTitle>    <ecommerceDescription>    <entry lang="en-US">Ecommerce description.</entry>    </ecommerceDescription>    <frontOfPackageText>Testing marketing desc</frontOfPackageText>    <restOfPackageText>Testing other desc</restOfPackageText>    <productCodes>    <productCode type="GTIN">00086069203569</productCode>    </productCodes>    <manufacturerId>a2f49b62-4779-11e1-b4af-005056957023</manufacturerId>    <categoryId>10000045</categoryId>    <privateLabelItem>N</privateLabelItem>    <distributorId>0002a020-c8a4-11e2-9b8d-005056ab0051</distributorId>    <importerId>005252d1-ef77-11e5-9f4e-005056b61af0</importerId>    <media>    <medium view="A1C1">    <url> http://media.itemmaster.com/0/0/0/755/15cfc5e6-17ad-4ee4-bc7c-740f825650db.png    </url>    </medium>    <medium view="A2C1">    <url> http://media.itemmaster.com/0/0/0/755/15cfc5e6-17ad-4ee4-bc7c-740f825650db.png    </url>    </medium>    <medium view="A3C1">    <url> http://media.itemmaster.com/0/0/0/755/15cfc5e6-17ad-4ee4-bc7c-740f825650db.png    </url>    </medium>    <medium view="A7C1">    <url> http://media.itemmaster.com/0/0/0/755/15cfc5e6-17ad-4ee4-bc7c-740f825650db.png    </url>    </medium>    <medium view="A8C1">    <url> http://media.itemmaster.com/0/0/0/755/15cfc5e6-17ad-4ee4-bc7c-740f825650db.png    </url>    </medium>    <medium view="A9C1">    <url> http://media.itemmaster.com/0/0/0/755/15cfc5e6-17ad-4ee4-bc7c-740f825650db.png    </url>    </medium>    <medium view="A1A3">    <url> http://media.itemmaster.com/0/0/0/515/5eb3c876-5103-4d2a-aea7-6b06c0902642.tif    </url>    </medium>    <medium view="A1R1">    <url> http://media.itemmaster.com/0/0/0/515/5eb3c876-5103-4d2a-aea7-6b06c0902642.tif    </url>    </medium>    <medium view="A1L1">    <url> http://media.itemmaster.com/0/0/0/515/5eb3c876-5103-4d2a-aea7-6b06c0902642.tif    </url>    </medium>    </media>    <packageData type="Product" approximation="N">    <length>    <measure>0.525</measure>    <uom>IN</uom>    </length>    <height>    <measure>5.82</measure>    <uom>IN</uom>    </height>    <width>    <measure>2.905</measure>    <uom>IN</uom>    </width>    <weight>    <measure>0.21</measure>    <uom>LB</uom>    </weight>    <unitsInPackage>1</unitsInPackage>    <packageType>BAR</packageType>    <packageSize>    <measure>3.2</measure>    <uom>PACK</uom>    </packageSize>    <netWeight>    <measure>3.2</measure>    <uom>OZ</uom>    </netWeight>    </packageData>    <contentPlus>    <images>    <medium>    <url>http://media.itemmaster.com/0/0/0/595/4d895e59-ac75-4380-8ce9-e76e5b930e02.png</url>    <description>    <entry lang="en-US">Chocolove Salted Caramel</entry> >    </description>    </medium>    </images>    <logos>    <medium>    <url>http://media.itemmaster.com/0/0/0/595/4d895e59-ac75-4380-8ce9-e76e5b930e02.png</url>    <description>    <entry lang="en-US">Chocolove Salted Caramel Logo</entry>    </description>    </medium>    </logos>    <videos>    <medium>    <url>https://www.youtube.com/watch?v=Pb90kInBxd8</url>    <description>    <entry lang="en-US">Chocolove product release</entry>    </description>    </medium>    </videos>    <mobile>    <medium>    <url>http://media.itemmaster.com/0/0/0/595/4d895e59-ac75-4380-8ce9-e76e5b930e02.png</url>    <description>    <entry lang="en-US">Mobile image</entry>    </description>    </medium>    </mobile>    <other>    <medium>    <url>http://www.pepsi.com/PepsiLegacy_Book.pdf</url>    <description>    <entry lang="en-US">Chocolove product image</entry>    </description>    </medium>    </other>    <sellCopy>How to sell it.</sellCopy>    <ecommerceDescription>    <entry lang="en-US">Ecommerce description.</entry>    </ecommerceDescription>    <longDescription>    <entry lang="en-US">Long description.</entry>    </longDescription>    <bulletPoints>    <bulletPoint>Chocolove Salted Caramel.</bulletPoint>    </bulletPoints>    <keywords>    <keyword>Chocolove.</keyword>    </keywords>    </contentPlus>    <manufacturerContent>    <retailers id="b7f96d20-c0d9-11e3-833c-005056ab0051">    <contentPlus>    <images>    <medium>    <url>http://media.itemmaster.com/0/0/0/595/4d895e59-ac75-4380-8ce9-e76e5b930e02.png</url>    <description>    <entry lang="en-US">Retailer Specific Chocolove Salted Caramel</entry>    </description>    </medium>    </images>    <logos>    <medium>    <url>http://media.itemmaster.com/0/0/0/595/4d895e59-ac75-4380-8ce9-e76e5b930e02.png</url>    <description>    <entry lang="en-US">Retailer Specific Chocolove Salted Caramel Logo</entry>    </description>    </medium>    </logos>    <videos>    <medium>    <url>https://www.youtube.com/watch?v=Pb90kInBxd8</url>    <description>    <entry lang="en-US">Retailer Specific Chocolove product release</entry>    </description>    </medium>    </videos>    <mobile>    <medium>    <url>http://media.itemmaster.com/0/0/0/595/4d895e59-ac75-4380-8ce9-e76e5b930e02.png</url>    <description>    <entry lang="en-US">Mobile image</entry>    </description>    </medium>    </mobile>    <other>    <medium>    <url>http://www.pepsi.com/PepsiLegacy_Book.pdf</url>    <description>    <entry lang="en-US">Chocolove product image</entry>    </description>    </medium>    </other>    <sellCopy>How to sell it.</sellCopy>    <ecommerceDescription>    <entry lang="en-US">Ecommerce description.</entry>    </ecommerceDescription>    <longDescription>    <entry lang="en-US">Long description.</entry>    </longDescription>    <bulletPoints>    <bulletPoint>Chocolove Salted Caramel.</bulletPoint>    </bulletPoints>    <keywords>    <keyword>Chocolove.</keyword>    </keywords>    </contentPlus>    </retailers>    </manufacturerContent>    <products>    <product type="grocery">    <description>Chocolove Salted Caramel In Dark Chocolate</description>    <brandId>7124a49f-2344-11e0-8608-005056957023</brandId>    <brandDescription>Chocolove</brandDescription>    <manufacturerId>a2f49b62-4779-11e1-b4af-005056957023</manufacturerId>    <seasonal>N</seasonal>    <countryOfOrigin>USA</countryOfOrigin>    <warnings>    <warning>May contain traces of wheat, peanuts or other nuts.</warning>    </warnings>    <directions>Tastes best at 70 degrees F. Store at 55 degrees - 65 degrees F.</directions>    <isAerosol>Y</isAerosol>    <isChemical>Y</isChemical>    <isPesticide>Y</isPesticide>    <hasBatteries>Y</hasBatteries>    <containsMercury>Y</containsMercury>    <hasFuelContainer>Y</hasFuelContainer>    <containsPaperWood>Y</containsPaperWood>    <compositeWoodCertificationCode>1</compositeWoodCertificationCode>    <hasExpiration>Y</hasExpiration>    <hasWarranty>Y</hasWarranty>    <isProp65WarningRequired>Y</isProp65WarningRequired>    <isTemperatureSensitive>Y</isTemperatureSensitive>    <smallPartsWarnings>0</smallPartsWarnings>    <isControlledSubstance>Y</isControlledSubstance>    <hasStateRestrictions>Y</hasStateRestrictions>    <isNutritionFactsLabelRequired>Y</isNutritionFactsLabelRequired>    <isBoxTopsForEducationEligible>Y</isBoxTopsForEducationEligible>    <grocery>    <ingredients>Dark Chocolate (Cocoa Liquor*, Sugar, Cocoa Butter*, Soy Lecithin, Vanilla), Caramel (Organic Tapioca Syrup, Organic Cane Sugar, Organic Nonfat Milk, Organic Heavy Cream, Organic Butter (Cream, Salt), Salt, Carrageenan, Sodium Citrate, Organic Vanilla Extract (2 Fold), Organic Soy Lecithin as an Emulsifier, Vitamin E (Mixed Tocopherols) added to preserve freshness), Palm Oil, Butter Oil, Sea Salt.</ingredients>    <kosherCodes>    <kosherCode>18</kosherCode>    <kosherCode>13</kosherCode>    </kosherCodes>    <foodRelatedIndicators>    <temperatureIndicator>Shelf Stable</temperatureIndicator>    <kosher>Y</kosher>    </foodRelatedIndicators>    <nutritions>    <nutrition sequence="1">    <numberOfServings>3</numberOfServings>    <servingSizes>    <servingSize type="other">    <measure>0.3</measure>    <uom>bar</uom>    </servingSize>    <servingSize type="metric">    <measure>30.0</measure>    <uom>g</uom>    </servingSize>    </servingSizes>    <energy>150</energy>    <totalFat uom="g" dailyPct="15" calories="90">10</totalFat>    <saturatedFat uom="g" dailyPct="28" calories="">6</saturatedFat>    <transFat uom="g">0</transFat>    <cholesterol uom="mg" dailyPct="1">0</cholesterol>    <sodium uom="mg" dailyPct="2">55</sodium>    <carbohydrates uom="g" dailyPct="6">17</carbohydrates>    <dietaryFiber uom="g" dailyPct="7">2</dietaryFiber>    <sugars uom="g">13</sugars>    <chromium uom="g">1</chromium>    <folateDFE uom="g">2</folateDFE>    <manganese uom="g">3</manganese>    <pantothenicAcid uom="g">4</pantothenicAcid>    <selenium uom="g">5</selenium>    <vitaminK uom="g">6</vitaminK>    <protein uom="g" dailyPct="">1</protein>    <dailyPercentOfVitaminA>0</dailyPercentOfVitaminA>    <dailyPercentOfVitaminC>0</dailyPercentOfVitaminC>    <dailyPercentOfCalcium>2</dailyPercentOfCalcium>    <dailyPercentOfIron>15</dailyPercentOfIron>    <dailyPercentOfChromium>1</dailyPercentOfChromium>    <dailyPercentOfFolate>2</dailyPercentOfFolate>    <dailyPercentOfManganese>3</dailyPercentOfManganese>    <dailyPercentOfPantothenicAcid>4</dailyPercentOfPantothenicAcid>    <dailyPercentOfSelenium>5</dailyPercentOfSelenium>    <dailyPercentOfVitaminK>6</dailyPercentOfVitaminK>   </nutrition>   </nutritions>   </grocery>   </product>   </products>   <attributes/>   </item> </items>

Response xml

<?xml version="1.0" encoding="UTF-8"?>   <FeedAcknowledgement: xmlns="http://www.itemmaster.com/item ">   <feedId>09a3f1b2-3852-4b87-b7e4-2715b3d7a52e</feedId> </FeedAcknowledgement>

Service Option 2 of 2 (Listing, Standard, All Commerce Items Accepted):

The following endpoint will ingest and auto-classify your items into a Content Profile Type. The endpoint accepts Listing, Standard, and All Commerce profiles. If you do not know the profile type of your item, use this endpoint.

                                https://api.itemmaster.com/v2.2/feed/mfg/items
                            

Request Body:

  • {ingestItems XML} (mandatory) - ingestItems xml with all mandatory (and optional) data in request body to create items of any profile type; Allows All Commerce Item XSD OR Standard Item XSD OR Listing Item XSD and performs auto-classification by validating against the different profile type schemas, going from most data (All Commerce) to least data (Listing).

Request Headers:

  • username - xxx
  • password - yyy
  • Content-Type - application/xml
Ingest items Request and Response fields/attributes details for All Commerce Items, please see above XSDs for Standard and Listing Items.

Example (a Listing Item)

                                $ curl -X POST --header "username:xxx" --header "password:yyy" --header "Content-Type:application/xml" -d @/home/items/ingestItems-LISTING.xml 'https://api.itemmaster.com/v2.2/mfg/feed/items'

                                

ingestItems-LISTING.xml

<?xml version="1.0" encoding="UTF-8"?> <items xmlns="http://www.itemmaster.com/feed/item">   <item type="grocery" xmlns="http://www.itemmaster.com/feed/item">    <companyTrackingId id="17456789" name="Chocolove"/>    <ecommerceTitle>Chocolove Salted Caramel In Dark Chocolate</ecommerceTitle>    <ecommerceDescription>    <entry lang="en-US">Ecommerce description.</entry>    </ecommerceDescription>    <frontOfPackageText>Testing marketing desc</frontOfPackageText>    <restOfPackageText>Testing other desc</restOfPackageText>    <productCodes>    <productCode type="GTIN">00086069203569</productCode>    </productCodes>    <manufacturerId>a2f49b62-4779-11e1-b4af-005056957023</manufacturerId>    <categoryId>10000045</categoryId>    <privateLabelItem>N</privateLabelItem>    <distributorId>0002a020-c8a4-11e2-9b8d-005056ab0051</distributorId>    <importerId>005252d1-ef77-11e5-9f4e-005056b61af0</importerId>    <media>    <medium view="THUMBNAIL">    <url> http://media.itemmaster.com/0/0/0/755/15cfc5e6-17ad-4ee4-bc7c-740f825650db.png    </url>    </medium>    </media>    <products>    <product type="grocery">    <description>Chocolove Salted Caramel In Dark Chocolate</description>    <brandId>7124a49f-2344-11e0-8608-005056957023</brandId>   </product>   </products>   </item> </items>

Response xml

<?xml version="1.0" encoding="UTF-8"?>   <FeedAcknowledgement: xmlns="http://www.itemmaster.com/item ">   <feedId>09a3f1b2-3852-4b87-b7e4-2715b3d7a52e</feedId> </FeedAcknowledgement>

Update item

This endpoint can be used to update an already existing published item in ItemMaster.
You can only update one item at a time.
UPC provided in endpoint URI should match the UPC in payload.
This endpoint should only be used to update the "E-Commerce description" and "Content Plus" of the item. All the other elements/attributes present in the payload will be ignored.
Any content plus data provided will be added to the already existing content plus data for the item.
API will return a token, which can then be used to poll at regular intervals for status on the ingestion of records.
NOTE: Re-Sending the already existing content plus data will result in duplication.

Service:

                                 https://api.itemmaster.com/v2.2/feed/items/{upc}
                            

Path parameter:

  • {upc} (mandatory) - upc of the item that needs updation.

Request Body:

  • {ingestItems XML} (mandatory) - ingestItems xml with all mandatory data in request body to create items (XSD)

Request Headers:

  • username - xxx
  • password - yyy
  • Content-Type - application/xml
Ingest items Request and Response fields/attributes details

Example

                            $ curl -X PUT --header "username:xxx" --header "password:yyy" --header "Content-Type:application/xml" -d @/home/items/ingestItems.xml 'https://api.itemmaster.com/v2.2/feed/items/00086069203569'

                            

ingestItems.xml

<?xml version="1.0" encoding="UTF-8"?> <items xmlns="http://www.itemmaster.com/feed/item">   <item type="grocery">    <companyTrackingId id="17456789" name="Chocolove"/>    <ecommerceTitle>Chocolove Salted Caramel In Dark Chocolate</ecommerceTitle>    <ecommerceDescription>    <entry lang="en-US">Ecommerce description.</entry>    </ecommerceDescription>    <frontOfPackageText>Testing marketing desc</frontOfPackageText>    <restOfPackageText>Testing other desc</restOfPackageText>    <productCodes>    <productCode type="GTIN">00086069203569</productCode>    </productCodes>    <manufacturerId>a2f49b62-4779-11e1-b4af-005056957023</manufacturerId>    <categoryId>10000045</categoryId>    <privateLabelItem>N</privateLabelItem>    <distributorId>0002a020-c8a4-11e2-9b8d-005056ab0051</distributorId>    <importerId>005252d1-ef77-11e5-9f4e-005056b61af0</importerId>    <media>    <medium view="A1C1">    <url> http://media.itemmaster.com/0/0/0/755/15cfc5e6-17ad-4ee4-bc7c-740f825650db.png    </url>    </medium>    <medium view="A2C1">    <url> http://media.itemmaster.com/0/0/0/755/15cfc5e6-17ad-4ee4-bc7c-740f825650db.png    </url>    </medium>    <medium view="A3C1">    <url> http://media.itemmaster.com/0/0/0/755/15cfc5e6-17ad-4ee4-bc7c-740f825650db.png    </url>    </medium>    <medium view="A7C1">    <url> http://media.itemmaster.com/0/0/0/755/15cfc5e6-17ad-4ee4-bc7c-740f825650db.png    </url>    </medium>    <medium view="A8C1">    <url> http://media.itemmaster.com/0/0/0/755/15cfc5e6-17ad-4ee4-bc7c-740f825650db.png    </url>    </medium>    <medium view="A9C1">    <url> http://media.itemmaster.com/0/0/0/755/15cfc5e6-17ad-4ee4-bc7c-740f825650db.png    </url>    </medium>    <medium view="A1A3">    <url> http://media.itemmaster.com/0/0/0/515/5eb3c876-5103-4d2a-aea7-6b06c0902642.tif    </url>    </medium>    <medium view="A1R1">    <url> http://media.itemmaster.com/0/0/0/515/5eb3c876-5103-4d2a-aea7-6b06c0902642.tif    </url>    </medium>    <medium view="A1L1">    <url> http://media.itemmaster.com/0/0/0/515/5eb3c876-5103-4d2a-aea7-6b06c0902642.tif    </url>    </medium>    </media>    <packageData type="Product" approximation="N">    <length>    <measure>0.525</measure>    <uom>IN</uom>    </length>    <height>    <measure>5.82</measure>    <uom>IN</uom>    </height>    <width>    <measure>2.905</measure>    <uom>IN</uom>    </width>    <weight>    <measure>0.21</measure>    <uom>LB</uom>    </weight>    <unitsInPackage>1</unitsInPackage>    <packageType>BAR</packageType>    <packageSize>    <measure>3.2</measure>    <uom>PACK</uom>    </packageSize>    <netWeight>    <measure>3.2</measure>    <uom>OZ</uom>    </netWeight>    </packageData>    <contentPlus>    <images>    <medium>    <url>http://media.itemmaster.com/0/0/0/595/4d895e59-ac75-4380-8ce9-e76e5b930e02.png</url>    <description>    <entry lang="en-US">Chocolove Salted Caramel</entry>    </description>    </medium>    </images>    <logos>    <medium>    <url>http://media.itemmaster.com/0/0/0/595/4d895e59-ac75-4380-8ce9-e76e5b930e02.png</url>    <description>    <entry lang="en-US">Chocolove Salted Caramel Logo</entry>    </description>    </medium>    </logos>    <videos>    <medium>    <url>https://www.youtube.com/watch?v=Pb90kInBxd8</url>    <description>    <entry lang="en-US">Chocolove product release</entry>    </description>    </medium>    </videos>    <mobile>    <medium>    <url>http://media.itemmaster.com/0/0/0/595/4d895e59-ac75-4380-8ce9-e76e5b930e02.png</url>    <description>    <entry lang="en-US">Mobile image</entry>    </description>    </medium>    </mobile>    <other>    <medium>    <url>http://www.pepsi.com/PepsiLegacy_Book.pdf</url>    <description>    <entry lang="en-US">Chocolove product image</entry>    </description>    </medium>    </other>    <sellCopy>How to sell it.</sellCopy>    <ecommerceDescription>    <entry lang="en-US">Ecommerce description.</entry>    </ecommerceDescription>    <longDescription>    <entry lang="en-US">Long description.</entry>    </longDescription>    <bulletPoints>    <bulletPoint>Chocolove Salted Caramel.</bulletPoint>    </bulletPoints>    <keywords>    <keyword>Chocolove.</keyword>    </keywords>    </contentPlus>    <manufacturerContent>    <retailers id="b7f96d20-c0d9-11e3-833c-005056ab0051">    <contentPlus>    <images>    <medium>    <url>http://media.itemmaster.com/0/0/0/595/4d895e59-ac75-4380-8ce9-e76e5b930e02.png</url>    <description>    <entry lang="en-US">Retailer Specific Chocolove Salted Caramel</entry>    </description>    </medium>    </images>    <logos>    <medium>    <url>http://media.itemmaster.com/0/0/0/595/4d895e59-ac75-4380-8ce9-e76e5b930e02.png</url>    <description>    <entry lang="en-US">Retailer Specific Chocolove Salted Caramel Logo</entry>    </description>    </medium>    </logos>    <videos>    <medium>    <url>https://www.youtube.com/watch?v=Pb90kInBxd8</url>    <description>    <entry lang="en-US">Retailer Specific Chocolove product release</entry>    </description>    </medium>    </videos>    <mobile>    <medium>    <url>http://media.itemmaster.com/0/0/0/595/4d895e59-ac75-4380-8ce9-e76e5b930e02.png</url>    <description>    <entry lang="en-US">Mobile image</entry>    </description>    </medium>    </mobile>    <other>    <medium>    <url>http://www.pepsi.com/PepsiLegacy_Book.pdf</url>    <description>    <entry lang="en-US">Chocolove product image</entry>    </description>    </medium>    </other>    <sellCopy>How to sell it.</sellCopy>    <ecommerceDescription>    <entry lang="en-US">Ecommerce description.</entry>    </ecommerceDescription>    <longDescription>    <entry lang="en-US">Long description.</entry>    </longDescription>    <bulletPoints>    <bulletPoint>Chocolove Salted Caramel.</bulletPoint>    </bulletPoints>    <keywords>    <keyword>Chocolove.</keyword>    </keywords>    </contentPlus>    </retailers>    </manufacturerContent>    <products>    <product type="grocery">    <description>Chocolove Salted Caramel In Dark Chocolate</description>    <brandId>7124a49f-2344-11e0-8608-005056957023</brandId>    <brandDescription>Chocolove</brandDescription>    <manufacturerId>a2f49b62-4779-11e1-b4af-005056957023</manufacturerId>    <seasonal>N</seasonal>    <countryOfOrigin>USA</countryOfOrigin>    <warnings>    <warning>May contain traces of wheat, peanuts or other nuts.</warning>    </warnings>    <directions>Tastes best at 70 degrees F. Store at 55 degrees - 65 degrees F.</directions>    <isAerosol>Y</isAerosol>    <isChemical>Y</isChemical>    <isPesticide>Y</isPesticide>    <hasBatteries>Y</hasBatteries>    <containsMercury>Y</containsMercury>    <hasFuelContainer>Y</hasFuelContainer>    <containsPaperWood>Y</containsPaperWood>    <compositeWoodCertificationCode>1</compositeWoodCertificationCode>    <hasExpiration>Y</hasExpiration>    <hasWarranty>Y</hasWarranty>    <isProp65WarningRequired>Y</isProp65WarningRequired>    <isTemperatureSensitive>Y</isTemperatureSensitive>    <smallPartsWarnings>0</smallPartsWarnings>    <isControlledSubstance>Y</isControlledSubstance>    <hasStateRestrictions>Y</hasStateRestrictions>    <isNutritionFactsLabelRequired>Y</isNutritionFactsLabelRequired>    <grocery>    <ingredients>Dark Chocolate (Cocoa Liquor*, Sugar, Cocoa Butter*, Soy Lecithin, Vanilla), Caramel (Organic Tapioca Syrup, Organic Cane Sugar, Organic Nonfat Milk, Organic Heavy Cream, Organic Butter (Cream, Salt), Salt, Carrageenan, Sodium Citrate, Organic Vanilla Extract (2 Fold), Organic Soy Lecithin as an Emulsifier, Vitamin E (Mixed Tocopherols) added to preserve freshness), Palm Oil, Butter Oil, Sea Salt.</ingredients>    <kosherCodes>    <kosherCode>18</kosherCode>    <kosherCode>13</kosherCode>    </kosherCodes>    <foodRelatedIndicators>    <temperatureIndicator>Shelf Stable</temperatureIndicator>    <kosher>Y</kosher>    </foodRelatedIndicators>    <nutritions>    <nutrition sequence="1">    <numberOfServings>3</numberOfServings>    <servingSizes>    <servingSize type="other">    <measure>0.3</measure>    <uom>bar</uom>    </servingSize>    <servingSize type="metric">    <measure>30.0</measure>    <uom>g</uom>    </servingSize>    </servingSizes>    <energy>150</energy>    <totalFat uom="g" dailyPct="15" calories="90">10</totalFat>    <saturatedFat uom="g" dailyPct="28" calories="">6</saturatedFat>    <transFat uom="g">0</transFat>    <cholesterol uom="mg" dailyPct="1">0</cholesterol>    <sodium uom="mg" dailyPct="2">55</sodium>    <carbohydrates uom="g" dailyPct="6">17</carbohydrates>    <dietaryFiber uom="g" dailyPct="7">2</dietaryFiber>    <sugars uom="g">13</sugars>    <chromium uom="g">1</chromium>    <folate uom="g">2</folate>    <manganese uom="g">3</manganese>    <pantothenicAcid uom="g">4</pantothenicAcid>    <selenium uom="g">5</selenium>    <vitaminK uom="g">6</vitaminK>    <protein uom="g" dailyPct="">1</protein>    <dailyPercentOfVitaminA>0</dailyPercentOfVitaminA>    <dailyPercentOfVitaminC>0</dailyPercentOfVitaminC>    <dailyPercentOfCalcium>2</dailyPercentOfCalcium>    <dailyPercentOfIron>15</dailyPercentOfIron>    <dailyPercentOfChromium>1</dailyPercentOfChromium>    <dailyPercentOfFolate>2</dailyPercentOfFolate>    <dailyPercentOfManganese>3</dailyPercentOfManganese>    <dailyPercentOfPantothenicAcid>4</dailyPercentOfPantothenicAcid>    <dailyPercentOfSelenium>5</dailyPercentOfSelenium>    <dailyPercentOfVitaminK>6</dailyPercentOfVitaminK>   </nutrition>   </nutritions>   </grocery>   </product>   </products>   </item> </items>

Response xml

<?xml version="1.0" encoding="UTF-8"?>   <FeedAcknowledgement: xmlns="http://www.itemmaster.com/item ">   <feedId>09a3f1b2-3852-4b87-b7e4-2715b3d7a52e</feedId> </FeedAcknowledgement>

Refresh/Re-Create items

This endpoint can be used to Refresh/Re-Create new item records with ItemMaster. You can use the create request API endpoint in compliance with the specified request format below. This endpoint supports creation of more than one item at a time. API will return a token, which can then be used to poll at regular intervals for status on the ingestion of records.

Service:

                                 https://api.itemmaster.com/v2.2/feed/items/refresh
                            

Request Body:

  • {ingestItems XML} (mandatory) - ingestItems xml with all mandatory data in request body to create items (XSD)

Request Headers:

  • username - xxx
  • password - yyy
  • Content-Type - application/xml
Ingest items Request and Response fields/attributes details

Example

                            $ curl -X POST --header "username:xxx" --header "password:yyy" --header "Content-Type:application/xml" -d @/home/items/ingestItems.xml 'https://api.itemmaster.com/v2.2/feed/items/refresh'

                            

ingestItems.xml

<?xml version="1.0" encoding="UTF-8"?> <items xmlns="http://www.itemmaster.com/feed/item">   <item type="grocery" xmlns="http://www.itemmaster.com/feed/item">    <companyTrackingId id="17456789" name="Chocolove"/>    <ecommerceTitle>Chocolove Salted Caramel In Dark Chocolate</ecommerceTitle>    <ecommerceDescription>    <entry lang="en-US">Ecommerce description.</entry>    </ecommerceDescription>    <frontOfPackageText>Testing marketing desc</frontOfPackageText>    <restOfPackageText>Testing other desc</restOfPackageText>    <productCodes>    <productCode type="GTIN">00086069203569</productCode>    </productCodes>    <manufacturerId>a2f49b62-4779-11e1-b4af-005056957023</manufacturerId>    <categoryId>10000045</categoryId>    <privateLabelItem>N</privateLabelItem>    <distributorId>0002a020-c8a4-11e2-9b8d-005056ab0051</distributorId>    <importerId>005252d1-ef77-11e5-9f4e-005056b61af0</importerId>    <media>    <medium view="A1C1">    <url> http://media.itemmaster.com/0/0/0/755/15cfc5e6-17ad-4ee4-bc7c-740f825650db.png    </url>    </medium>    <medium view="A2C1">    <url> http://media.itemmaster.com/0/0/0/755/15cfc5e6-17ad-4ee4-bc7c-740f825650db.png    </url>    </medium>    <medium view="A3C1">    <url> http://media.itemmaster.com/0/0/0/755/15cfc5e6-17ad-4ee4-bc7c-740f825650db.png    </url>    </medium>    <medium view="A7C1">    <url> http://media.itemmaster.com/0/0/0/755/15cfc5e6-17ad-4ee4-bc7c-740f825650db.png    </url>    </medium>    <medium view="A8C1">    <url> http://media.itemmaster.com/0/0/0/755/15cfc5e6-17ad-4ee4-bc7c-740f825650db.png    </url>    </medium>    <medium view="A9C1">    <url> http://media.itemmaster.com/0/0/0/755/15cfc5e6-17ad-4ee4-bc7c-740f825650db.png    </url>    </medium>    <medium view="A1A3">    <url> http://media.itemmaster.com/0/0/0/515/5eb3c876-5103-4d2a-aea7-6b06c0902642.tif    </url>    </medium>    <medium view="A1R1">    <url> http://media.itemmaster.com/0/0/0/515/5eb3c876-5103-4d2a-aea7-6b06c0902642.tif    </url>    </medium>    <medium view="A1L1">    <url> http://media.itemmaster.com/0/0/0/515/5eb3c876-5103-4d2a-aea7-6b06c0902642.tif    </url>    </medium>    </media>    <packageData type="Product" approximation="N">    <length>    <measure>0.525</measure>    <uom>IN</uom>    </length>    <height>    <measure>5.82</measure>    <uom>IN</uom>    </height>    <width>    <measure>2.905</measure>    <uom>IN</uom>    </width>    <weight>    <measure>0.21</measure>    <uom>LB</uom>    </weight>    <unitsInPackage>1</unitsInPackage>    <packageType>BAR</packageType>    <packageSize>    <measure>3.2</measure>    <uom>PACK</uom>    </packageSize>    <netWeight>    <measure>3.2</measure>    <uom>OZ</uom>    </netWeight>    </packageData>    <contentPlus>    <images>    <medium>    <url>http://media.itemmaster.com/0/0/0/595/4d895e59-ac75-4380-8ce9-e76e5b930e02.png</url>    <description>    <entry lang="en-US">Chocolove Salted Caramel</entry>    </description>    </medium>    </images>    <logos>    <medium>    <url>http://media.itemmaster.com/0/0/0/595/4d895e59-ac75-4380-8ce9-e76e5b930e02.png</url>    <description>    <entry lang="en-US">Chocolove Salted Caramel Logo</entry>    </description>    </medium>    </logos>    <videos>    <medium>    <url>https://www.youtube.com/watch?v=Pb90kInBxd8</url>    <description>    <entry lang="en-US">Chocolove product release</entry>    </description>    </medium>    </videos>    <mobile>    <medium>    <url>http://media.itemmaster.com/0/0/0/595/4d895e59-ac75-4380-8ce9-e76e5b930e02.png</url>    <description>    <entry lang="en-US">Mobile image</entry>    </description>    </medium>    </mobile>    <other>    <medium>    <url>http://www.pepsi.com/PepsiLegacy_Book.pdf</url>    <description>    <entry lang="en-US">Chocolove product image</entry>    </description>    </medium>    </other>    <sellCopy>How to sell it.</sellCopy>    <ecommerceDescription>    <entry lang="en-US">Ecommerce description.</entry>    </ecommerceDescription>    <longDescription>    <entry lang="en-US">Long description.</entry>    </longDescription>    <bulletPoints>    <bulletPoint>Chocolove Salted Caramel.</bulletPoint>    </bulletPoints>    <keywords>    <keyword>Chocolove.</keyword>    </keywords>    </contentPlus>    <manufacturerContent>    <retailers id="b7f96d20-c0d9-11e3-833c-005056ab0051">    <contentPlus>    <images>    <medium>    <url>http://media.itemmaster.com/0/0/0/595/4d895e59-ac75-4380-8ce9-e76e5b930e02.png</url>    <description>    <entry lang="en-US">Retailer Specific Chocolove Salted Caramel</entry> >    </description>    </medium>    </images>    <logos>    <medium>    <url>http://media.itemmaster.com/0/0/0/595/4d895e59-ac75-4380-8ce9-e76e5b930e02.png</url>    <description>    <entry lang="en-US">Retailer Specific Chocolove Salted Caramel Logo</entry>    </description>    </medium>    </logos>    <videos>    <medium>    <url>https://www.youtube.com/watch?v=Pb90kInBxd8</url>    <description>    <entry lang="en-US">Retailer Specific Chocolove product release</entry>    </description>    </medium>    </videos>    <mobile>    <medium>    <url>http://media.itemmaster.com/0/0/0/595/4d895e59-ac75-4380-8ce9-e76e5b930e02.png</url>    <description>    <entry lang="en-US">Mobile image</entry>    </description>    </medium>    </mobile>    <other>    <medium>    <url>http://www.pepsi.com/PepsiLegacy_Book.pdf</url>    <description>    <entry lang="en-US">Chocolove product image</entry>    </description>    </medium>    </other>    <sellCopy>How to sell it.</sellCopy>    <ecommerceDescription>    <entry lang="en-US">Ecommerce description.</entry>    </ecommerceDescription>    <longDescription>    <entry lang="en-US">Long description.</entry>    </longDescription>    <bulletPoints>    <bulletPoint>Chocolove Salted Caramel.</bulletPoint>    </bulletPoints>    <keywords>    <keyword>Chocolove.</keyword>    </keywords>    </contentPlus>    </retailers>    </manufacturerContent>    <products>    <product type="grocery">    <description>Chocolove Salted Caramel In Dark Chocolate</description>    <brandId>7124a49f-2344-11e0-8608-005056957023</brandId>    <brandDescription>Chocolove</brandDescription>    <manufacturerId>a2f49b62-4779-11e1-b4af-005056957023</manufacturerId>    <seasonal>N</seasonal>    <countryOfOrigin>USA</countryOfOrigin>    <warnings>    <warning>May contain traces of wheat, peanuts or other nuts.</warning>    </warnings>    <directions>Tastes best at 70 degrees F. Store at 55 degrees - 65 degrees F.</directions>    <isAerosol>Y</isAerosol>    <isChemical>Y</isChemical>    <isPesticide>Y</isPesticide>    <hasBatteries>Y</hasBatteries>    <containsMercury>Y</containsMercury>    <hasFuelContainer>Y</hasFuelContainer>    <containsPaperWood>Y</containsPaperWood>    <compositeWoodCertificationCode>1</compositeWoodCertificationCode>    <hasExpiration>Y</hasExpiration>    <hasWarranty>Y</hasWarranty>    <isProp65WarningRequired>Y</isProp65WarningRequired>    <isTemperatureSensitive>Y</isTemperatureSensitive>    <smallPartsWarnings>0</smallPartsWarnings>    <isControlledSubstance>Y</isControlledSubstance>    <hasStateRestrictions>Y</hasStateRestrictions>    <isNutritionFactsLabelRequired>Y</isNutritionFactsLabelRequired>    <grocery>    <ingredients>Dark Chocolate (Cocoa Liquor*, Sugar, Cocoa Butter*, Soy Lecithin, Vanilla), Caramel (Organic Tapioca Syrup, Organic Cane Sugar, Organic Nonfat Milk, Organic Heavy Cream, Organic Butter (Cream, Salt), Salt, Carrageenan, Sodium Citrate, Organic Vanilla Extract (2 Fold), Organic Soy Lecithin as an Emulsifier, Vitamin E (Mixed Tocopherols) added to preserve freshness), Palm Oil, Butter Oil, Sea Salt.</ingredients>    <kosherCodes>    <kosherCode>18</kosherCode>    <kosherCode>13</kosherCode>    </kosherCodes>    <foodRelatedIndicators>    <temperatureIndicator>Shelf Stable</temperatureIndicator>    <kosher>Y</kosher>    </foodRelatedIndicators>    <nutritions>    <nutrition sequence="1">    <numberOfServings>3</numberOfServings>    <servingSizes>    <servingSize type="other">    <measure>0.3</measure>    <uom>bar</uom>    </servingSize>    <servingSize type="metric">    <measure>30.0</measure>    <uom>g</uom>    </servingSize>    </servingSizes>    <energy>150</energy>    <totalFat uom="g" dailyPct="15" calories="90">10</totalFat>    <saturatedFat uom="g" dailyPct="28" calories="">6</saturatedFat>    <transFat uom="g">0</transFat>    <cholesterol uom="mg" dailyPct="1">0</cholesterol>    <sodium uom="mg" dailyPct="2">55</sodium>    <carbohydrates uom="g" dailyPct="6">17</carbohydrates>    <dietaryFiber uom="g" dailyPct="7">2</dietaryFiber>    <sugars uom="g">13</sugars>    <chromium uom="g">1</chromium>    <folate uom="g">2</folate>    <manganese uom="g">3</manganese>    <pantothenicAcid uom="g">4</pantothenicAcid>    <selenium uom="g">5</selenium>    <vitaminK uom="g">6</vitaminK>    <protein uom="g" dailyPct="">1</protein>    <dailyPercentOfVitaminA>0</dailyPercentOfVitaminA>    <dailyPercentOfVitaminC>0</dailyPercentOfVitaminC>    <dailyPercentOfCalcium>2</dailyPercentOfCalcium>    <dailyPercentOfIron>15</dailyPercentOfIron>    <dailyPercentOfChromium>1</dailyPercentOfChromium>    <dailyPercentOfFolate>2</dailyPercentOfFolate>    <dailyPercentOfManganese>3</dailyPercentOfManganese>    <dailyPercentOfPantothenicAcid>4</dailyPercentOfPantothenicAcid>    <dailyPercentOfSelenium>5</dailyPercentOfSelenium>    <dailyPercentOfVitaminK>6</dailyPercentOfVitaminK>   </nutrition>   </nutritions>   </grocery>   </product>   </products>   <attributes/>   </item> </items>

Response xml

<?xml version="1.0" encoding="UTF-8"?>   <FeedAcknowledgement: xmlns="http://www.itemmaster.com/item ">   <feedId>09a3f1b2-3852-4b87-b7e4-2715b3d7a52e</feedId> </FeedAcknowledgement>

Polling status

items status end-point to get the status of a specific feed.

Service:

                               https://api.itemmaster.com/v2.2/feed/items/{optional-path-parameter}?{optional-request-parameters}
                            

Path parameter:

  • {feedId} (Optional) - feed id to get the status of specific feed.

Request parameter:

offsetPagination: which item to start with. If not passed will be set to 0.Number
limitPagination: Which item to end with. If not passed will be set to 100.Number
Items status Response fields/attributes details

Example

                            $ curl --header "username:xxx" --header "password:yyy" 'https://api.itemmaster.com/v2.2/feed/items/3dfed856-258e-45ec-9fe0-a1a1f1b8018c?offset=0&limit=50'

						    

Response xml

<?xml version="1.0" encoding="utf-8"?>  <FeedStatusResponse xmlns="http://www.itemmaster.com/item">   <feedId>09a3f1b2-3852-4b87-b7e4-2715b3d7a52e</feedId>   <feedStatus>INPROGRESS</feedStatus>   <itemsReceived>1</itemsReceived>   <itemsSucceeded>1</itemsSucceeded>   <itemsFailed>0</itemsFailed>   <itemsProcessing>0</itemsProcessing>   <offset>0</offset>   <limit>2</limit>   <ItemDetails>     <ItemIngestionStatus>     <productCode>00086069203569</productCode>     <index>1</index>     <ingestionStatus>SUCCESS</ingestionStatus>     <ingestionErrors/>     </ItemIngestionStatus>   </ItemDetails>  </FeedStatusResponse>