The XML search engine returns XML results described by the following XML Document Type Definition (DTD). Some of the result
fields are self-explanatory; others are described in more details below.
<!DOCTYPE searchresult [
<!ELEMENT searchresult (productcount,productlist,categorylist,manufacturerlist,merchantlist)>
<!ELEMENT productcount (#PCDATA)>
<!ELEMENT productlist (product*)>
<!ELEMENT categorylist (category*)>
<!ELEMENT manufacturerlist (manufacturer*)>
<!ELEMENT merchantlist (merchant*)>
<!ELEMENT product (prdtid,mercount,corenum,cat1num,category1,cat2num,category2,catnum,category3,
upc,isbn,mfgnum,mfgname,mfgmodel,mfgpartnumber,prdtrating,title,description,longdescription,
mernum,mername,merrating,mersku,merzip,price,shippingmin,shippingmax,prdturl,imageurl,condition,available,taxable,warranty)>
<!ELEMENT category (cat1num,category1,cat2num,category2,catnum,category3)>
<!ELEMENT manufacturer (mfgnum,mfgname,prdtcount)>
<!ELEMENT merchant (mernum,mername,prdtcount)>
<!ELEMENT prdtid (#PCDATA)>
<!ELEMENT mercount (#PCDATA)>
<!ELEMENT product_sku (#PCDATA)>
<!ELEMENT cat1num (#PCDATA)>
<!ELEMENT category1 (#PCDATA)>
<!ELEMENT cat2num (#PCDATA)>
<!ELEMENT category2 (#PCDATA)>
<!ELEMENT catnum (#PCDATA)>
<!ELEMENT category3 (#PCDATA)>
<!ELEMENT upc (#PCDATA)>
<!ELEMENT isbn (#PCDATA)>
<!ELEMENT mfgnum (#PCDATA)>
<!ELEMENT mfgname (#PCDATA)>
<!ELEMENT mfgmodel (#PCDATA)>
<!ELEMENT mfgpartnumber (#PCDATA)>
<!ELEMENT prdtrating (#PCDATA)>
<!ELEMENT title (#PCDATA)>
<!ELEMENT description (#PCDATA)>
<!ELEMENT longdescription (#PCDATA)>
<!ELEMENT mernum (#PCDATA)>
<!ELEMENT mername (#PCDATA)>
<!ELEMENT merrating (#PCDATA)>
<!ELEMENT mersku (#PCDATA)>
<!ELEMENT merzip (#PCDATA)>
<!ELEMENT price (#PCDATA)>
<!ELEMENT shippingmin (#PCDATA)>
<!ELEMENT shippingmax (#PCDATA)>
<!ELEMENT prdturl (#PCDATA)>
<!ELEMENT imageurl (#PCDATA)>
<!ELEMENT condition (#PCDATA)>
<!ELEMENT available (#PCDATA)>
<!ELEMENT taxable (#PCDATA)>
<!ELEMENT warranty (#PCDATA)>
<!ELEMENT prdtcount (#PCDATA)>
]>
productcount
The
productcount contains the total number of products found by the search engine,
although the search engine will only return detailed information for up to twenty products at a time. You can page
through the product details for all the products found by using the
limit and
offset
parameters in your XML search query (described in the previous section).
productlist
The
productlist contains the product details for up to twenty products.
|
product_sku
|
DFF's internal product SKU number for the standard DFF product.
|
|
prdtid
|
If the product is not a standard DFF product, it is a merchant product and is assigned a unique DFF prdtid.
|
|
mercount
|
Total number of merchants offering the standard DFF product.
|
|
merzip
|
The zip code of the only merchant offering the merchant product.
|
|
cat1num
|
Category number of the top-tier category to which the product belong, if any.
|
|
category1
|
Name of the top-tier category to which the product belong, if any.
|
|
cat2num
|
Category number of the second-tier category to which the product belong, if any.
|
|
category2
|
Name of the second-tier category to which the product belong, if any.
|
|
catnum
|
Category number of the third-tier category to which the product belong, if any.
|
|
category3
|
Name of the third-tier category to which the product belong, if any.
|
categorylist
The
categorylist contains a list of all the categories for which the search engine has found
results.
|
cat1num
|
Category number of the top-tier category.
|
|
category1
|
Name of the top-tier category.
|
|
cat2num
|
Category number of the second-tier category.
|
|
category2
|
Name of the second-tier category.
|
|
catnum
|
Category number of the third-tier category.
|
|
category3
|
Name of the third-tier category.
|
manufacturerlist
The
manufacturerlist contains a list of all the manufacturers for which the search engine has
found retults. The
prdtcount field in the list contains the number of products in the current
query which belong to each manufacturer.
merchantlist
The
merchantlist contains a list of all the merchants for which the search engine has
found retults. The
prdtcount in the list contains the number of products in the current
query which belong to each merchant.
