Docs

XML Samples

XML Product Feed

<?xml version="1.0" encoding="utf-8"?>  
<feed>  
    <catalog>
        <schema>
            <fieldName>occasion</fieldName>
            <dataType>text</dataType>
            <multiValued>true</multiValued>
            <autoSuggest>false</autoSuggest>
        </schema>
        <schema>
            <fieldName>fabric</fieldName>
            <dataType>text</dataType>
            <multiValued>true</multiValued>
            <autoSuggest>false</autoSuggest>
        </schema>
        <schema>
            <fieldName>gallery</fieldName>
            <dataType>link</dataType>
            <multiValued>true</multiValued>
            <autoSuggest>false</autoSuggest>
        </schema>
        <schema>
            <fieldName>qty</fieldName>
            <dataType>number</dataType>
            <multiValued>false</multiValued>
            <autoSuggest>false</autoSuggest>
        </schema>
        <schema>
            <fieldName>createdAt</fieldName>
            <dataType>date</dataType>
            <multiValued>false</multiValued>
            <autoSuggest>false</autoSuggest>
        </schema>
        <schema>
            <fieldName>updatedAt</fieldName>
            <dataType>date</dataType>
            <multiValued>false</multiValued>
            <autoSuggest>false</autoSuggest>
        </schema>
        <schema>
            <fieldName>isFeatured</fieldName>
            <dataType>bool</dataType>
            <multiValued>false</multiValued>
            <autoSuggest>false</autoSuggest>
        </schema>
        <add>
            <items>
                <uniqueId>5315b8555e4016e5737be1e5</uniqueId>
                <title>Fitted Navy Stripe Wool Sportcoat</title>
                <brand>The Kooples</brand>
                <sku>EXMP1</sku>
                <category>Men</category>
                <category>Apparel</category>
                <category>Suits</category>
                <category>Formal</category>
                <catlevel1Name>Men</catlevel1Name>
                <catlevel2Name>Apparel</catlevel2Name>
                <catlevel3Name>Suits</catlevel3Name>
                <catlevel4Name>Formal</catlevel4Name>
                <color>Navy</color>
                <gender>men</gender>
                <price>845</price>
                <imageUrl>http://www.example.com/p-1.jpg</imageUrl>
                <size>M</size>
                <size>X</size>
                <size>XL</size>
                <productUrl>http://www.forexample.com/p-1.html</productUrl>
                <availability>true</availability>
                <createdAt>2012-02-16T06:02:32Z</createdAt>
                <updatedAt>2012-07-18T05:42:31Z</updatedAt>
                <occasion>Wedding</occasion>
                <qty>34</qty>
                <isFeatured>true</isFeatured>
                <gallery>http://www.example.com/p-1-1.jpg</gallery>
                <gallery>http://www.example.com/p-1-2.jpg</gallery>
                <gallery>http://www.example.com/p-1-3.jpg</gallery>
                <gallery>http://www.example.com/p-1-4.jpg</gallery>
                <description>Pin-dot stripes pattern a handsome, two-button wool sportcoat tailored in a lean, modern fit with peak lapels.</description>
            </items>
            <items>
                <uniqueId>5315b8555e4016e5737be1d8</uniqueId>
                <title>Floral Print Shorts</title>
                <brand>Olive and Oak</brand>
                <sku>EXMP2</sku>
                <category>Women</category>
                <category>Apparel</category>
                <category>Shorts</category>
                <catlevel1Name>Women</catlevel1Name>
                <catlevel2Name>Apparel</catlevel2Name>
                <catlevel3Name>Shorts</catlevel3Name>
                <color>Red</color>
                <gender>Women</gender>
                <price>300</price>
                <imageUrl>http://www.example.com/p-2.jpg</imageUrl>
                <size>S</size>
                <size>M</size>
                <size>L</size>
                <productUrl>http://www.example.com/p-2.html</productUrl>
                <availability>true</availability>
                <createdAt>2012-05-26T06:01:16Z</createdAt>
                <updatedAt>2012-09-18T05:41:51Z</updatedAt>
                <qty>22</qty>
                <isFeatured>false</isFeatured>
                <fabric>rayon</fabric>
                <gallery>http://www.example.com/p-2-1.jpg</gallery>
                <gallery>http://www.example.com/p-2-2.jpg</gallery>
                <gallery>http://www.example.com/p-2-3.jpg</gallery>
                <gallery>http://www.example.com/p-2-4.jpg</gallery>
                <description>A ditsy floral print adds sweet charm to soft challis shorts with an adjustable drawstring topping the breezy fit.</description>
            </items>
        </add>
        <update>
            <items>
                <uniqueId>5315b8555e4016e5737be1d8</uniqueId>
                <qty>20</qty>
            </items>
        </update>
        <delete>
            <items>
                <uniqueId>5315b85235e4016e5735be1d8</uniqueId>
            </items>
        </delete>
    </catalog>
</feed>  

XML Redirect Response

The response format in XML is given below:

<?xml version="1.0" encoding="UTF-8" ?>  
<response>  
    <lst name="searchMetaData">
        <lst name="queryParams">
            <str name="q">women watch</str>
        </lst>
        <int name="status">0</int>
    </lst>
    <lst name="redirect">
        <str name="type">url</str>
        <str name="value">/clothing/women/sec/womenCategory</str>
    </lst>
</response>  

XML Facet Response

The response format in XML is given below:

<?xml version="1.0" encoding="UTF-8" ?>  
<facet>  
   <Brand_fq>
      <type>facet_fields</type>
      <values>
         <field>Spigen</field>
         <value>109</value>
         <field>Amzer</field>
         <value>91</value>
         <field>Rock</field>
         <value>52</value>
      </values>
   </Brand_fq>
   <Colour_fq>
      <type>facet_fields</type>
      <values>
         <field>Blue</field>
         <value>1811</value>
         <field>Black</field>
         <value>1575</value>
         <field>White</field>
         <value>1423</value>
      </values>
   </Colour_fq>
   <Gender_fq>
      <type>facet_fields</type>
      <values>
         <field>Men</field>
         <value>3805</value>
         <field>Women</field>
         <value>3351</value>
         <field>Unisex</field>
         <value>101</value>
      </values>
   </Gender_fq>
   <Material_fq>
      <type>facet_fields</type>
      <values>
         <field>Silicone</field>
         <value>1281</value>
         <field>Leather</field>
         <value>797</value>
      </values>
   </Material_fq>
   <Style_fq>
      <type>facet_fields</type>
      <values>
         <field>Designer</field>
         <value>1714</value>
         <field>Plain</field>
         <value>1447</value>
         <field>Classic</field>
         <value>468</value>
      </values>
   </Style_fq>
   <price_fq>
      <type>facet_ranges</type>
      <values>
         <counts>
            <field>100.0</field>
            <value>216</field>
            <field>200.0</field>
            <value>1875</value>
            <field>300.0</field>
            <value>2188</value>
            <field>400.0</field>
            <value>1213</value>
            <field>500.0</field>
            <value>435</value>
         </counts>
         <end>10000.0</end>
         <gap>100.0</gap>
         <start>100.0</start>
      </values>
   </price_fq>
</facet>  

Did You Mean Response

<?xml version="1.0" encoding="UTF-8" ?>

        <didYouMean> 
        <0>
        <suggestion>value</suggestion>
        <frequency>value</frequency>
    </0>
    <1>
        <suggestion>value</suggestion>
        <frequency>value</frequency>
    </1>
        </didYouMean> 

Autosuggest Response

<?xml version="1.0" encoding="UTF-8" ?>  
<root>  
    <response>
        <parsererror style="display: block; white-space: pre; border: 2px solid #c77; padding: 0 1em 0 1em; margin: 1em; background-color: #fdd; color: black">
            <h3>This page contains the following errors:</h3>
            <h3>Below is a rendering of the page up to the first error.</h3>
            <div style="font-family:monospace;font-size:12px">error on line 54 at column 2: Extra content at the end of the document</div>
        </parsererror>
        <lst name="searchMetaData">
            <int name="status">value</int>
            <int name="queryTime">value</int>
            <lst name="queryParams">
                <str name="q">value</str>
                <str name="topQueries.count">value</str>
                <str name="json.wrf">jQuery11515510874409456_145824823539</str>
                <str name="keywordSuggestions.count">value</str>
                <str name="popularProducts.count">value</str>
                <str name="inFields.count">value</str>
                <str name="wt">value</str>
                <str name="_">value</str>
            </lst>
        </lst>
        <result name="response" numberOfProducts="value" start="value">
            <product>
                <str name="autosuggest">value</str>
                <str name="doctype">TOP_SEARCH_QUERIES</str>
                <str name="uniqueId">Random value</str>
                <double name="unbxdAutosuggestScore">value</double>
            </product>
            <product>
                <str name="autosuggest">value</str>
                <str name="doctype">IN_FIELD</str>
                <str name="unbxdAutosuggestSrc">value</str>
                <str name="uniqueId">Random value</str>
                <arr name="value_in">
                    <str>value</str>
                </arr>
            </product>
            <product>
                <str name="autosuggest">value</str>
                <str name="doctype">POPULAR_PRODUCTS</str>
                <str name="name">value</str>
                <str name="url_path">value</str>
                <str name="sku">value</str>
                <str name="uniqueId">popularProduct_value</str>
                <double name="price">value</double>
                <double name="unbxdAutosuggestScore">value</double>
                <arr name="imageUrl">
                    <str>value</str>
                </arr>
            </product>
            <product>
                <str name="autosuggest">value</str>
                <str name="doctype">KEYWORD_SUGGESTION</str>
                <str name="uniqueId">Random value</str>
            </product>
        </result>
    </response>
</root>