ESC XML Feed

Views

From eStyleCentral Help

(Difference between revisions)

Revision as of 16:30, 10 July 2013

Product Data Feed

Getting product data through the XML feed works in the following way. We set up a script to automatically update an XML file each morning around 1AM. You can also trigger an update within 5 minutes from your admin panel at any time.

You can use your admin panel to manage products as usual, but now all of this data will also be available in the XML file. The category and product IDs of the products on your site are included in the XML file.

The feed is actually two XML files, the products feed, and the categories feed. The categories feed supports our Manage Collection/Category Headers tool which allows categories and collections to be grouped into subcategories. Group id 0 and 1 are for category that have not been assigned to any subcategory.

The feed includes links to all images we have available for a given style. You are welcome to directly link to our images to simplify the process of integration. High bandwidth usage may require a higher hosting tier.

Element	Description	Type	Note
product	attribute:id, Product ID is the unique ID of your instance of the product within the eSC system.	Container
catid	The Category ID is the ID of the category to which the product has been assigned within the eSC admin panel. There are actually two xml files, the products feed, and the categories feed. The categories feed supports our Manage Collection/Category Headers tool which allows categories and collections to be grouped into subcategories. Group id 0 and 1 are for category that have not been assigned to any subcategory. I've attached a sample of the categories feed.	Integer
manufseqid	The Manufacturer Sequence ID is the unique ID of the a particular style within our system. This is not equivalent to a UPC because styles can get a new Manufacturer Sequence ID when a style is carried over to a new season.
manufid	The unique ID of the vendor/designer/manufacturer within our system.	Integer
mastercolid	The unique ID of the Master Collection defined within the eSC system. The Master Collection does not change from season to season. For example, Jovani Evenings Sping 2014 belongs to the Master Collection called "Evenings" with mastercolid=13. Jovani Evenings Fall 2014 and Jovani Evenings Spring 2015 will also belong to "Evenings" with mastercolid=13	Integer
stylenum	The style number of the product as provided by the vendor/designer/manufacturer.	Alpha-numeric
name	The name of the style for product display purposes. This automatically defaults to the Master Collection name and the Style Number, but can be changed on an individual product basis under "Edit Product" within the eSC Admin.	Alpha-numeric
images	Container for "image" elements. There is no preset limit on the number of images we provide, but there aren't typically more than 30. We try to include as many quality images as we receive from the vendor/designer/manufacturer.	Container
image	Contains elements for various image sizes available for "image". Current available sizes are: smallimage: thumbnail constrained by height (238 pixels) and width (179 pixel). A portrait thumbnail will always be 238 pixels high, but a landscape thumbnail will start to decrease in height as the aspect ratio changes. bigimage: an image constrained by height to 457 pixels high and cropped to 700 pixels wide if necessary zoomimage: an image constrained to 1200 pixels high by any width. The zoomimage height can be less than 1200 pixels if the original source image we received from the vendor/designer/manufacturer was less than 1200 pixels high.	Container
shortdesc	A short description of the style.	Alpha-numeric
desc	Long description of the style.	Alpha-numeric
keywords	Other keywords
sizes	Contains "size" elements.	Container
size	A size available for the product. Attribute markup="25" indicates that the "size" has a $25 markup over the "price".	size: Alpha-numeric markup: numeric
colors	Contains all available colors for the product.	Container
color	Contains elements related to the color.	Container
colorname	Name of the color.	Alpha-numeric
colorhex	Hex value of the color if provided.	Alpha-numeric
price	Price of the product.	Numeric
sizechart	URL of the size chart for the product.	Alpha-numeric
instock	Indicates if a given product has any stock entered into the eSC admin inventory grid or not.	Bool
attributes			Coming soon
inventorytypes			Coming soon

Product Feed Sample XML

<?xml version="1.0"?>
<products>
 
    <product id="6548963"> 
        <catid>66351</catid>
        <manufseqid>210926</manufseqid>         
        <manufid>3</manufid>
        <mastercolid>16</mastercolid>
        <stylenum>110C36</stylenum>
        <name>Tony Bowls Collection Dress 110C36</name> 
        <images>
		<image>
			<smallimage>http://isrv.efcsite.com/manufcols/moncheri/tbeveandcollection-current/thumbnails/110C36_006.jpg</smallimage>
			<bigimage>http://isrv.efcsite.com/manufcols/moncheri/tbeveandcollection-current/images/110C36_006.jpg</bigimage>
			<zoomimage>http://isrv.efcsite.com/manufcols/moncheri/tbeveandcollection-current/zoom/110C36_006.jpg</zoomimage>
		</image>
        </images>
        <shortdesc>Tony Bowls Collection</shortdesc> 
        <desc>The fabric in this style is Charmeuse</desc> 
        <keywords>Tony Bowls Collection Dress 110C36</keywords>
	<attributes>
		<attribute attid="123">A-line</attribute>
		<attribute attid="173">Chiffon</attribute>
	</attributes>
        <sizes>
            <size markup="">2</size>
            <size markup="">4</size>
            <size markup="">6</size>
            <size markup="">8</size>
            <size markup="">10</size>
            <size markup="">12</size>
            <size markup="">14</size>
            <size markup="">16</size>
            <size markup="50">18</size>
            <size markup="50">20</size>
        </sizes>        
        <colors>
		<color>
			<colorname>Green/Black</colorname>
			<colorhex></colorhex>			
		</color>
		<color>
			<colorname>White</colorname>
			<colorhex></colorhex>
		</color>
        </colors>
        <price>1539.00</price>
        <instock>0</instock>
	<inventorytypes>
	<inventory type="at-store">
		<item>
		<colorname>Green/Black</colorname>
		<size>4</size>
		<qty>2</qty>
		<avldate>na</avldate>
		</item>
		<item>
		<colorname>White</colorname>
		<size>6</size>
		<qty>1</qty>
		<avldate>na</avldate>
		</item>
	</inventory>
	<inventory type="incoming-store">
		<item>
		<colorname>Green/Black</colorname>
		<size>6</size>
		<qty>1</qty>
		<avldate>2013-07-01</avldate>
		</item>		
	</inventory>
	<inventory type="at-vendor">
		<item>
		<colorname>Green/Black</colorname>
		<size>6</size>
		<qty>8</qty>
		<avldate>na</avldate>
		</item>		
	</inventory>
	<inventory type="incoming-vendor">
		<item>
		<colorname>White</colorname>
		<size>2</size>
		<qty>23</qty>
		<avldate>2013-08-10</avldate>
		</item>
		<item>
		<colorname>Green/Black</colorname>
		<size>6</size>
		<qty>9</qty>
		<avldate>2013-08-10</avldate>
		</item>			
	</inventory>
	</inventorytypes>
 
    </product>      
 
 
    </products>

Category Feed Sample XML

<?xml version="1.0"?>
<classifications>
<collections>
	<group id="186067">
		<groupname>Prom Collections</groupname>
		<category id="67541">Faviana Prom</category>
		<category id="67542">Glamour by Faviana</category>
		<category id="67534">Jovani Prom</category>
		<category id="67667">La Femme prom</category>
		<category id="67530">Sherri Hill Prom</category>
		<category id="67540">Terani Cocktail</category>
		<category id="67539">Terani Prom</category>
	</group>
	<group id="186068">
		<groupname>Plus Size Prom</groupname>
		<category id="67543">Faviana Prom-Plus Sizes</category>
	</group>
	<group id="186069">
		<groupname>Sophisticated Prom </groupname>
		<category id="67533">Jovani Evening</category>		
		<category id="67538">Terani Evening</category>
	</group>
	<group id="1">
                <groupname></groupname>
	</group>
</collections>
<categories>
	<group id="0">
                <groupname></groupname>
		<category id="67547">Accessories</category>
		<category id="67584">Casual Wear</category>
		<category id="67537">Evening Dresses</category>
		<category id="67546">Featured</category>
		<category id="67691">Jewelry and Accessories</category>
		<category id="67544">Plus Size Prom</category>
		<category id="67536">Prom Dresses</category>
		<category id="67532">Short &amp; Cocktail Dresses</category>
	</group>
</categories>
</classifications>

Retrieved from "http://efcmailserver.com/wiki/index.php/ESC_XML_Feed"

Category: Developers

@@ Line 3: / Line 3: @@
 ==Product Data Feed==
-Getting product data through the XML feed works in the following way. We set up a script to automatically update an XML file each morning around 1am. You would also be able to trigger an update within 5 minutes from your admin panel at any time.
+Getting product data through the XML feed works in the following way. We set up a script to automatically update an XML file each morning around 1AM. You can also trigger an update within 5 minutes from your admin panel at any time.
-You would use your admin panel to manage products as usual, but now all of this data will also be available in the XML file. The category and product IDs of the products on your site are included in the XML file. I have attached a sample file.
+You can use your admin panel to manage products as usual, but now all of this data will also be available in the XML file. The category and product IDs of the products on your site are included in the XML file.
@@ Line 12: / Line 12: @@
-The feed includes links to all images we have available for a given style. You are welcome to directly link to our images to simplify the process of integration.
+The feed includes links to all images we have available for a given style. You are welcome to directly link to our images to simplify the process of integration.  High bandwidth usage may require a higher hosting tier.

Views

Revision as of 16:30, 10 July 2013

Product Data Feed

Product Feed Sample XML

Category Feed Sample XML

Navigation

Search

Toolbox

Personal tools