ESC XML Feed

From eStyleCentral Help
(Difference between revisions)
Jump to: navigation, search
Current revision (21:22, 19 December 2024) (view source)
 
Line 1: Line 1:
-
 
==Product Data Feed==
==Product Data Feed==
Line 47: Line 46:
<tr><td>sizechart</td><td>URL of the size chart for the product.</td><td>Alpha-numeric</td><td></td></tr>
<tr><td>sizechart</td><td>URL of the size chart for the product.</td><td>Alpha-numeric</td><td></td></tr>
<tr><td>instock</td><td>Indicates if a given product has any stock entered into the eSC admin inventory grid or not.</td><td>Bool</td><td></td></tr>
<tr><td>instock</td><td>Indicates if a given product has any stock entered into the eSC admin inventory grid or not.</td><td>Bool</td><td></td></tr>
-
<tr><td>attributes</td><td>Attributes for a style can include categories such as Back Style, Color Scheme, Embellishment, Fabric, Feature, Hemline/Train, Neckline, Occasion, Silhouette, Sleeve, Straps and Style Type</td><td>Alpha-numeric</td><td></td></tr>
+
 
</table>
</table>
Line 77: Line 76:
         <desc>The fabric in this style is Charmeuse</desc>  
         <desc>The fabric in this style is Charmeuse</desc>  
         <keywords>Tony Bowls Collection Dress 110C36</keywords>
         <keywords>Tony Bowls Collection Dress 110C36</keywords>
-
<attributes>
+
-
<attribute attid="123">A-line</attribute>
+
-
<attribute attid="173">Chiffon</attribute>
+
-
</attributes>
+
         <sizes>
         <sizes>
             <size markup="">2</size>
             <size markup="">2</size>

Current revision

Contents

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 consists of 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.



ElementDescriptionTypeNote
productattribute:id, Product ID is the unique ID of your instance of the product within the eSC system. Container
catidThe Category ID is the ID of the category to which the product has been assigned within the eSC admin panel. There is also a categories feed available. 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. A sample of the categories feed is shown below.Integer
allcatidsA comma separated list of all category ids a product is assigned to. The catid from the previous element is also includedCSV
manufseqidThe Manufacturer Sequence ID is the unique ID of the a particular style within our system for a specific season. 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 and different combinations of colors/sizes all share the same manufseqid.
gpcThe unique ID of the vendor -> master collection -> style number. This is equivalent to a UPC (but not a UPC) and the same ID is associated with a vendor -> master collection -> style number every season.Integer
manufidThe unique ID of the vendor/designer/manufacturer within our system.Integer
mastercolidThe 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=13Integer
stylenumThe style number of the product as provided by the vendor/designer/manufacturer.Alpha-numeric
nameThe 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
imagesContainer 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
imageContains 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
shortdescA short description of the style.Alpha-numeric
descLong description of the style.Alpha-numeric
keywordsOther keywords
sizesContains "size" elements.Container
sizeA size available for the product. Attribute markup="25" indicates that the "size" has a $25 markup over the "price".size: Alpha-numeric
markup: numeric
colorsContains all available colors for the product.Container
colorContains elements related to the color.Container
colornameName of the color.Alpha-numeric
colorhexHex value of the color if provided.Alpha-numeric
coloridThe unique color ID for the vendor -> master collection -> style -> color. This ID is consistent from season to seasonInteger
colorstatusStatus of color, whether 'active' or 'discontinued'Alpha-numeric
pricePrice of the product.Numeric
sizechartURL of the size chart for the product.Alpha-numeric
instockIndicates if a given product has any stock entered into the eSC admin inventory grid or not.Bool

Product Feed Sample XML

<?xml version="1.0"?>
<products>
 
    <product id="6548963"> 
        <catid>66351</catid>
        <allcatids>66351,66889,87751</allcatids>
        <manufseqid>210926</manufseqid>
        <gpc>12345</gpc>        
        <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>
 
        <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>000000</colorhex>
			<colorid>11234</colorid>
			<colorstatus>active</colorstatus>
		</color>
		<color>
			<colorname>White</colorname>
			<colorhex>ffffff</colorhex>
                        <colorid>11235</colorid>
                        <colorstatus>discontinued</colorstatus>
		</color>
        </colors>
        <price>1539.00</price>
        <instock>0</instock>
 
 
    </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>

Vendor Inventory Data Feed

<?xml version="1.0"?>
<inventory>
	<item id="1124798112">
        <manufid>50</manufid>
        <colorid>1233739</colorid>
        <size>12</size>
        <color>AB/Ivory</color>
        <qty>1</qty>
        <arrivaldate></arrivaldate>
    </item>
	<item id="1124798113">
        <manufid>50</manufid>
        <colorid>1233739</colorid>
        <size>14</size>
        <color>AB/Ivory</color>
        <qty>1</qty>
        <arrivaldate></arrivaldate>
    </item>
	<item id="1124798114">
        <manufid>50</manufid>
        <colorid>1233739</colorid>
        <size>16</size>
        <color>AB/Ivory</color>
        <qty>1</qty>
        <arrivaldate></arrivaldate>
    </item>
</inventory>

Associated Data Feeds

A feed listing the Master Collection Names and IDs is available at: http://efashioncentral.com/2coxins/feedmastercols.php

A feed listing the Manufacturer Names and IDs is available at: http://efashioncentral.com/2coxins/feedmanufs.php

Personal tools