The GOAT Store, LLC

Our XML Product Engine supports a number of different requests which allows you to display different information on your web site. Sample applications would include displaying our product listings in the same look and feel of your own web site or displaying individual product descriptions similar to the examples on our XML demonstration page.

There are four requests that our XML engine will support:

  • System Index - provides a list of systems similar to the sidebar on this page.
  • System Listing - provides a list of products for one or more systems. (Similar to a product listing page)
  • Product Information - provides information for one or more products. (Similar to a product description page)
  • Search Engine - provides a list of products using specified search criteria.

XML Engine Access

All XML Product Engine requests should be made to the following URL:

http://www.goatstore.com/xml/engine.php?API=<% API %>&XML=<% XML %>

In place of <% API %> and <% XML %>, use the values specified in the sections below specific to your request.

System Index

To receive a system index, the API value should be "Index" and the XML value should contain the following request:

<IndexRequest Username="username" Password="password" />

Above where it states Username, fill in your affiliate number and for Password, use your affiliate account password.

Click here to view the DTD document for an index response.

Click here to view sample output from a System Index Request.

The output from the request lists each system grouped by manufacturer and contains the range of product ID numbers (Base and Max) for the manufacturer or system. Additionally, hyperlinks to each system listing page on www.goatstore.com is included and contains the appropriate affiliate referral information.

System Listing

To receive a listing of products for a system, the API value should be "System" and the XML value should contain the following request:

<SystemRequest Username="username" Password="password">
<System ID="0">[ System ID ]</System>
</SystemRequest>

Above where it states Username, fill in your affiliate number and for Password, use your affiliate account password.

If you are requesting multiple systems in one request, you must increment the value of the ID attribute on the System tag. This is done to ensure that you receive the correct data in the response.

Inside the System tag, should be the System ID or Base value from the system index for the system you wish to retrieve products for.

Click here to view the DTD document for a system response.

Click here to view sample output from a System Listing Request.

The System Listing includes products by group and for each item, information such as title, condition, and cost are included. Additionally, a hyperlink to the product description page on www.goatstore.com is included and contains the appropriate affiliate referral information.

Product Information

To receive detailed information for a product, or group of products, the API value should be "Product" and the XML value should contain the following request:

<ProductRequest Username="username" Password="password">
<Item ID="372001" Related="Yes" />
</ProductRequest>

Above where it states Username, fill in your affiliate number and for Password, use your affiliate account password.

The ID attribute of the Item tag should contain the product ID number for the item you wish to retrieve information for.

The Related attribute is optional and may be omitted. When setting the value of this attribute to "Yes" a list of related items will be generated.

If you are requesting multiple items in one request, each item must have its own Item tag.

Click here to view the DTD document for a product response.

Click here to view sample output from a Product Information Request without related items.

Click here to view sample output from a Product Information Request with related items.

Search Engine

To perform a search using our product search engine, the API value should be "Search" and the XML value should contain the following requsest:

<SearchRequest Username="username" Password="password">
<SearchText>[ search text ]</SearchText>
<SearchType>[ AND, OR, EXACT ]</SearchType>
<System>[ any, system # ]</System>
<Condition>[ no-pref, new, used-good, used-any ]</Condition>
<Box>[ no-pref, box-good, box-any ]</Box>
<Instructions>[ no-pref, inst-good, inst-any ]</Instructions>
<OldItems>[ true, false ]</OldItems>
</SearchRequest>

Listed below is the minimum request that can be made for a simple search.

<SearchRequest Username="username" Password="password">
<SearchText>[ search text ]</SearchText>
</SearchRequest>

Above where it states Username, fill in your affiliate number and for Password, use your affiliate account password.

The above options are available to perform advanced search options. After the main request tag, the only required tag is the SearchText tag. Omitting the option tags after the SearchText tag will cause them to use their default values.

For each option tag, all of the accepted values are listed seperated by commas. When specifying a system, the word "any" can be used for all systems otherwise the system base number obtained from the System Index (listed above) must be used.

The results returned from the search will be similiar to those of a standard system listing.

Click here to view the DTD document for a search response.