Join the Overstock.com Affiliate Program now.

Affiliate Resources
General Information
|
I.
Introduction:Overstock.com is proud to announce the
release of the XML feed for the Affiliate Program. This
document gives a detailed look into all the information available
from this XML feed. Topics to be discussed are calls, returns,
expectations, and contact information.
Please direct all
inquires regarding Datafeeds to affiliategroup@overstock.com |
II. Overview of XML:
XML, or Extensible Markup Language, is a means by which a data set can be delivered without concern for the display level or production level. XML is a way to deliver raw and pure data. In the case of this project, the XML delivers all the needed data to display and merchandise any of Overstock.com’s 800,000+ products on hand. More importantly, the XML feed does not place such a large strain on your system as compared to the CSV datafeed file.
To use XML, you will use a scripting or programming language to request the information set from Overstock.com. You will then need to parse this information into your own presentation level or site |
III. Calls:Overstock.com has launched this
version of the XML project with a basic level call set. These calls
will be described in detail in the following order: (1) raw calls,
and (2) quickies, or preformatted results.
1. Raw
Calls
Raw calls are simply direct calls to the
Overstock.com data base of products. To initiate a call to the data
base you must use the following
URL:
http://www.overstock.com/productxml?
This
call must be accompanied by a requesting string in the URL. Most
calls for this process will request a record set from our database
based on a Store, Department, Category or Sub Category. Below is an example of a
call for 15 products from the apparel store. The record set returned
includes the product name (Name) and short description
(ShortDescription):
http://www.overstock.com/productxml?dep=1&count=3&Name=Y&ShortDescription=Y
The
following are acceptable field
requests:
BrandName Dimensions ISBN LargeImageURL LongDescrition Manufacturer ManufacturerPartNumber Materials ModelNumber MSRP Name Origin Price Quality QuantityOnHand ShortDescription ShortName SKU ThumbnailURL UPC Warranty ProductURL
For each field value in the output, a field request must be addedto the URL parameters in the form of "...&Fieldname=Y"
Standard Results:
The standard
results are the result set that you get when you are using raw
calls. To demonstrate what information is returned, I will revisit
my previous
request:
http://www.overstock.com/productxml?dep=1&count=3&Name=Y&ShortDescription=Y
which
results:
Result Set
#1: <?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<OSTKXML xmlns="http://affiliates.overstock.com/xml/o1" > <OSTKPRODUCT>
<Name>Ultimate 4-inch Memory Foam Mattress Topper</Name>
<ShortDescription><br><li>Hypoallergenic, anti-bacterial foam is ideal for those who suffer from allergies<li>Temperature sensitive for a custom feel <li>Mattress topper simulates a floatation effect <li>Constructed from Visco elastic memory foam</ShortDescription>
</OSTKPRODUCT>
<OSTKPRODUCT>
<Name>Serta 4-inch Memory Foam Topper with Contour Pillows</Name>
<ShortDescription><br><li>Sleep in true comfort on a Serta 4-inch Pad
<li>Bedding set includes two contour pillows
<li>High density 3-lb solid Visco Elastic memory foam</ShortDescription>
</OSTKPRODUCT>
<OSTKPRODUCT>
<Name>14-inch Pillow Top King Size Memory Foam Mattress</Name>
<ShortDescription><br><li>Unique Memory Foam mattress will provide deep, relaxing sleep
<li>Pillow top provides the ultimate in Memory Foam surface feel and comfort
<li>Uncomfortable pressure-points common in most innerspring mattresses is eliminated
</ShortDescription>
</OSTKPRODUCT>
</OSTKXML>
As shown above,
we have now pulled three products from the store list of 1 which
are:
Product
1: Name
= Ultimate 4-inch Memory Foam Mattress Topper
ShortDescription
= Hypoallergenic, anti-bacterial foam is ideal for those who suffer from allergies Temperature sensitive for a custom feel Mattress topper simulates a floatation effect Constructed from Visco elastic memory foam
Product
2: Name
= Serta 4-inch Memory Foam Topper with Contour Pillows
ShortDescription
= Sleep in true comfort on a Serta 4-inch Pad Bedding set includes two contour pillows High density 3-lb solid Visco Elastic memory foam
Product
3: Name
= 14-inch Pillow Top King Size Memory Foam Mattress ShortDescription
= Unique Memory Foam mattress will provide deep, relaxing sleep Pillow top provides the ultimate in Memory Foam surface feel and comfort Uncomfortable pressure-points common in most innerspring mattresses is eliminated |
2. Quick Lists (Preformatted
Results):Overstock.com recognizes four major results sets
that will be used as a mainstream for most affiliates. These results
are as follows:
Quick List
1
ISBN
MSRP
Name
Price
ShortDescription
SKU
ThumbnailURL
UPC
Quick List
2
ISBN
Name
Price
ShortDescription
SKU
ThumbnailURL
UPC
Quick List
3
ISBN
LargeImageURL
LongDescription
Name
Price
SKU
UPC
Quick List
4
ISBN
LargeImageURL
LongDescription
MSRP
Name
Price
SKU
UPC
The quickies are built to work with SKU, ISBN and UPC
numbers. Here is an example of the user of SKU with a
quickie:
http://www.overstock.com/productxml?quicklist=1&SKU=123456
The
results from the above request are as follows:
Result Set
#2: <?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<OSTKXML xmlns="http://affiliates.overstock.com/xml/o1">
<OSTKPRODUCT>
<MSRP>450</MSRP>
<Name>Royal Heritage Luxury 1000 Thread Count Sateen Sheet Set<Name>
<Price>89.99</Price>
<ShortDescription><br><ul>
<li>Enhance the look of your bedroom with this amazing sheet set
<li>This exquisite sheet set includes a flat sheet, fitted sheet and two pillow cases
<li>Bedding is available in white, ivory, crystal, chocolate, linen and gold color options</ShortDescription>
<SKU>10776978</SKU>
<ThumbnailURL>http://cdn.overstock.com/images/products/T10776978.jpg</ThumbnailURL>
</OSTKPRODUCT>
</OSTKXML>
Above you will see the request returned
the following pieces of information:
ISBN =
Name = Royal Heritage Luxury 1000 Thread Count Sateen Sheet Set
Price
= 89.99
ShortDescription =
Enhance the look of your bedroom with this amazing sheet set
<li>This exquisite sheet set includes a flat sheet, fitted sheet and two pillow cases
Bedding is available in white, ivory, crystal, chocolate, linen and gold color options
SKU =
10776978 ThumbnailURL =
http://cdn.overstock.com/images/products/T10776978.jpg
UPC =
|
IV. Linking:The last step is to use LinkShare
to link to the products requested by the XML feed. If you have ever
worked with our CSV datafeed, then you are already familiar with
this process. Using this
link:
http://linksynergy.overstock.com/fs-bin/statform?id=[SITE.CODE]&offerid=52439&bnid=888&subid=0&OSSKU=[SKU]
Replace
[SKU] with the XML generated SKU for the product to the end of the
Linkshare code.
Using result set #2 as an example, you will
see that SKU 10224 was added to the end of the code to link to the
product.
http://linksynergy.overstock.com/fs-bin/statform?id=[SITE.CODE]&offerid=52439&bnid=888&subid=0&OSSKU=[SKU]
|
V. Offset & Limitations:In order to limit
the strain on the Overstock.com systems we have built in some
limitations. The first limitation is size of a data pull. We have
limited all data pulls to a 50 item max. This means that when using
the count variable you will not be able to pull a number higher than
50. As a default if the count variable is not used, the data set
will return up to 50 items in it.
To work around this
limitation we have built in an offset variable. This variable allows
you to pull a data set with a specific starting point. Here is an
example where your customer visits your site and you show them the
first 10 products of a
category:
http://www.overstock.com/productxml?dep=1&count=10&Name=Y&ShortDescription=Y&Price=Y
After
viewing all ten products on this page your customer decides he/ she
would like to see another 10 products. To accomplish this you add an
offset to the
query.
http://www.overstock.com/productxml?storelist=1&count=3&Name=Y&ShortDescription=Y&Price=Y&Offset=10
This
will result in the next ten products of that same
category.
V. Store & Category Listings:
As noted
in raw calls (Section III, 1) you can specify the Store, Department, Category or Sub Category from which you wish to pull your record set. To do so
you must call one of these four
variables:
sto dep cat sub
Keyword Search:
The page supports keyword search along with one of the category parameters in the preview section. To use this feature you would specify the parameter "keywords" in the request.
http://www.overstock.com/productxml?keywords=king+sheets&dep=1&quicklist=1
For more information on the corresponding values, please see
appendix 1. |
Important Information:In the interest of your
users we discourage the use of a query on store 3. Because of the
size of this store the system may take an extended amount of time to
respond to the request.
We instead suggest that you pull a
query on storelist 9, 11, 34, 10, 35, and 12. These storelist ids
are the next step down in the taxonomy.
If you have any
questions about this please feel free to email affiliategroup@overstock.com.
|
Work Log:We would like to encourage each
of our affiliates to provide feedback on this program, simply email
affiliategroup@overstock.com
any suggestion, questions or comments you have in regards to this
program. |
|