ESC POS API

From eStyleCentral Help
(Difference between revisions)
Jump to: navigation, search
(New page: Category:Developers ==POS API== <table border=1> <tr><th>Element</th><th>Description</th><th>Type</th><th>Note</th></tr> <tr><td>product</td><td>attribute:id, Product ID is the uniq...)
Current revision (19:49, 18 May 2017) (view source)
(→POS API)
 
(3 intermediate revisions not shown.)
Line 9: Line 9:
<tr><td>catid</td><td>The 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.</td><td>Integer</td><td></td></tr>
<tr><td>catid</td><td>The 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.</td><td>Integer</td><td></td></tr>
<tr><td>allcatids</td><td>A comma separated list of all category ids a product is assigned to.  The catid from the previous element is also included</td><td>CSV</td><td></td></tr>
<tr><td>allcatids</td><td>A comma separated list of all category ids a product is assigned to.  The catid from the previous element is also included</td><td>CSV</td><td></td></tr>
-
<tr><td>manufseqid</td><td>The 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.</td><td></td><td></td></tr>
+
 
<tr><td>gpc</td><td>The 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.</td><td>Integer</td><td></td></tr>
<tr><td>gpc</td><td>The 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.</td><td>Integer</td><td></td></tr>
<tr><td>manufid</td><td>The unique ID of the vendor/designer/manufacturer within our system.</td><td>Integer</td><td></td></tr>
<tr><td>manufid</td><td>The unique ID of the vendor/designer/manufacturer within our system.</td><td>Integer</td><td></td></tr>
<tr><td>mastercolid</td><td>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</td><td>Integer</td><td></td></tr>
<tr><td>mastercolid</td><td>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</td><td>Integer</td><td></td></tr>
<tr><td>stylenum</td><td>The style number of the product as provided by the vendor/designer/manufacturer.</td><td>Alpha-numeric</td><td></td></tr>
<tr><td>stylenum</td><td>The style number of the product as provided by the vendor/designer/manufacturer.</td><td>Alpha-numeric</td><td></td></tr>
-
<tr><td>name</td><td>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.</td><td>Alpha-numeric</td><td></td></tr>
+
<tr><td>imageurl</td><td>Contains a thumbnail image of the style
-
<tr><td>images</td><td>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.</td><td>Container</td><td></td></tr>
+
-
<tr><td>image</td><td>Contains elements for various image sizes available for "image". Current available sizes are:<br><br>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.<br><br>bigimage: an image constrained by height to 457 pixels high and cropped to 700 pixels wide if necessary<br><br>
+
-
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.
+
</td><td>Container</td><td></td></tr>
</td><td>Container</td><td></td></tr>
<tr><td>shortdesc</td><td>A short description of the style.</td><td>Alpha-numeric</td><td></td></tr>
<tr><td>shortdesc</td><td>A short description of the style.</td><td>Alpha-numeric</td><td></td></tr>
-
<tr><td>desc</td><td>Long description of the style.</td><td>Alpha-numeric</td><td></td></tr>
 
-
<tr><td>keywords</td><td>Other keywords</td><td></td><td></td></tr>
 
<tr><td>sizes</td><td>Contains "size" elements.</td><td>Container</td><td></td></tr>
<tr><td>sizes</td><td>Contains "size" elements.</td><td>Container</td><td></td></tr>
<tr><td>size</td><td>A size available for the product. Attribute markup="25" indicates that the "size" has a $25 markup over the "price".</td><td>size: Alpha-numeric<br>markup: numeric</td><td></td></tr>
<tr><td>size</td><td>A size available for the product. Attribute markup="25" indicates that the "size" has a $25 markup over the "price".</td><td>size: Alpha-numeric<br>markup: numeric</td><td></td></tr>
Line 28: Line 23:
<tr><td>colorname</td><td>Name of the color.</td><td>Alpha-numeric</td><td></td></tr>
<tr><td>colorname</td><td>Name of the color.</td><td>Alpha-numeric</td><td></td></tr>
<tr><td>colorhex</td><td>Hex value of the color if provided.</td><td>Alpha-numeric</td><td></td>
<tr><td>colorhex</td><td>Hex value of the color if provided.</td><td>Alpha-numeric</td><td></td>
-
<tr><td>colorid</td><td>The unique color ID for the vendor -> master collection -> style -> color.  This ID is consistent from season to season</td><td>Integer</td><td></td>
+
<tr><td>gpccolorid</td><td>The unique color ID for the vendor -> master collection -> style -> color.  This ID is consistent from season to season</td><td>Integer</td><td></td>
-
<tr><td>colorstatus</td><td>Status of color, whether 'active' or 'discontinued'</td><td>Alpha-numeric</td><td></td>
+
-
</tr>
+
<tr><td>price</td><td>Price of the product.</td><td>Numeric</td><td></td></tr>
<tr><td>price</td><td>Price of the product.</td><td>Numeric</td><td></td></tr>
 +
<tr><td>costprice</td><td>Wholesale price of the product.</td><td>Numeric</td><td></td></tr>
 +
<tr><td>pricetype</td><td>The type of price in the "price" element, cost or msrp</td><td>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>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>releasedate</td><td>Date the current instance of the style was released</td><td>Alpha-numeric</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>
+
<tr><td>produrl</td><td>URL of the product on the store's web site</td><td>Alpha-numeric</td><td></td></tr>
-
 
+
</table>
</table>
Line 46: Line 40:
<products>
<products>
          
          
-
     <product id="6548963">  
+
     <product id="13459169">  
-
         <catid>66351</catid>
+
         <catid>87989</catid>
-
         <allcatids>66351,66889,87751</allcatids>
+
         <allcatids>87989</allcatids>
-
         <manufseqid>210926</manufseqid>
+
         <manufseqid>395470</manufseqid>  
-
         <gpc>12345</gpc>      
+
         <gpc>65185</gpc>
-
         <manufid>3</manufid>
+
         <manufid>19</manufid>
-
         <mastercolid>16</mastercolid>
+
         <mastercolid>398</mastercolid>
-
         <stylenum>110C36</stylenum>
+
         <stylenum>6192</stylenum>
-
         <name>Tony Bowls Collection Dress 110C36</name>
+
         <imageurl>http://isrv2.efcsite.com/manufcols/alycedesigns/alyce-current/images/6192.jpg</imageurl>
-
        <images>
+
         <shortdesc>Alyce Paris Prom</shortdesc>
-
<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>
         <sizes>
 +
            <size markup="">0</size>
             <size markup="">2</size>
             <size markup="">2</size>
             <size markup="">4</size>
             <size markup="">4</size>
Line 76: Line 58:
             <size markup="">10</size>
             <size markup="">10</size>
             <size markup="">12</size>
             <size markup="">12</size>
-
            <size markup="">14</size>
 
-
            <size markup="">16</size>
 
-
            <size markup="50">18</size>
 
-
            <size markup="50">20</size>
 
         </sizes>         
         </sizes>         
 +
       
         <colors>
         <colors>
<color>
<color>
-
<colorname>Green/Black</colorname>
+
<colorname>Absinthe</colorname>
-
<colorhex>000000</colorhex>
+
<colorhex></colorhex>
-
<colorid>11234</colorid>
+
<gpccolorid>374205</gpccolorid>
-
<colorstatus>active</colorstatus>
+
</color>
</color>
<color>
<color>
-
<colorname>White</colorname>
+
<colorname>Wow Pink</colorname>
-
<colorhex>ffffff</colorhex>
+
<colorhex></colorhex>
-
                        <colorid>11235</colorid>
+
<gpccolorid>374206</gpccolorid>
-
                        <colorstatus>discontinued</colorstatus>
+
</color>
 +
<color>
 +
<colorname>Pearl Pink/Nude</colorname>
 +
<colorhex></colorhex>
 +
<gpccolorid>374207</gpccolorid>
 +
</color>
 +
<color>
 +
<colorname>Electric Blue</colorname>
 +
<colorhex></colorhex>
 +
<gpccolorid>374208</gpccolorid>
</color>
</color>
         </colors>
         </colors>
-
         <price>1539.00</price>
+
       
-
         <instock>0</instock>
+
         <price>550</price>
-
+
         <costprice>300</costprice>
-
+
        <pricetype>msrp</pricetype>
 +
        <sizechart>http://www.efashioncentral.com/ar/sizecharts.php?id=4</sizechart>
 +
        <releasedate>2016-10-11</releasedate>
 +
        <produrl>http://www.storedomainname.com/detail.php?ProdId=13459169</produrl>
     </product>       
     </product>       
            
            
Line 105: Line 95:
</source>
</source>
-
 
-
 
==Associated Data Feeds==
==Associated Data Feeds==

Current revision


POS API

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
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
imageurlContains a thumbnail image of the style Container
shortdescA short description of the style.Alpha-numeric
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
gpccoloridThe unique color ID for the vendor -> master collection -> style -> color. This ID is consistent from season to seasonInteger
pricePrice of the product.Numeric
costpriceWholesale price of the product.Numeric
pricetypeThe type of price in the "price" element, cost or msrpNumeric
sizechartURL of the size chart for the product.Alpha-numeric
releasedateDate the current instance of the style was releasedAlpha-numeric
produrlURL of the product on the store's web siteAlpha-numeric

API Sample XML

<?xml version="1.0"?>
<products>
 
    <product id="13459169"> 
        <catid>87989</catid>
        <allcatids>87989</allcatids>
        <manufseqid>395470</manufseqid>   
        <gpc>65185</gpc>
        <manufid>19</manufid>
        <mastercolid>398</mastercolid>
        <stylenum>6192</stylenum>
        <imageurl>http://isrv2.efcsite.com/manufcols/alycedesigns/alyce-current/images/6192.jpg</imageurl>
        <shortdesc>Alyce Paris Prom</shortdesc>
        <sizes>
            <size markup="">0</size>
            <size markup="">2</size>
            <size markup="">4</size>
            <size markup="">6</size>
            <size markup="">8</size>
            <size markup="">10</size>
            <size markup="">12</size>
        </sizes>        
 
        <colors>
		<color>
			<colorname>Absinthe</colorname>
			<colorhex></colorhex>
			<gpccolorid>374205</gpccolorid>
		</color>
		<color>
			<colorname>Wow Pink</colorname>
			<colorhex></colorhex>
			<gpccolorid>374206</gpccolorid>
		</color>
		<color>
			<colorname>Pearl Pink/Nude</colorname>
			<colorhex></colorhex>
			<gpccolorid>374207</gpccolorid>
		</color>
		<color>
			<colorname>Electric Blue</colorname>
			<colorhex></colorhex>
			<gpccolorid>374208</gpccolorid>
		</color>
        </colors>
 
        <price>550</price>
        <costprice>300</costprice>
        <pricetype>msrp</pricetype>
        <sizechart>http://www.efashioncentral.com/ar/sizecharts.php?id=4</sizechart>
        <releasedate>2016-10-11</releasedate>
        <produrl>http://www.storedomainname.com/detail.php?ProdId=13459169</produrl>
    </product>      
 
 
    </products>

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

Retrieved from "http://efcmailserver.com/wiki/index.php/ESC_POS_API"
Personal tools