es
Shopwiki logo
all stores. one search.


^^The API is still in a beta state!^^ ^^No further changes are expected, but I'll only feel a little bad if they happen.^^ XML Responses '''(NOTE: XML Responses are deprecated)''' !This documents the Showiki Search API, namely, the XML responses to API calls.

Basic Concepts

XML responses will always be element based; no attributes will be used. The XML response will always consist of a "response" element containing a number of response-specific elements. Some elements (or sub-elements) will always be sent (no matter what), some will usually be sent (unless there's an error), and some will sometimes be sent (if they're there). In the following sections, there will be sections labeled 'always', 'usually', and 'sometimes'. Use these labels as guides when deciding how to use a element and when to check for its existence. Responses in the following sections are specified using a similar language to the JSON format. It should be interpreted as follows: * "element_name" : ''string'' ** ''string'' is an XML-escaped string. '''&''', '''<''', '''>''', ''''''', and '''"''' are escaped as '''&''', '''<''', '''>''', ''''''', and '''"'''. ** The rain in Spain falls mainly on the plain. * "element_name" : ''integer'' ** 42 * "element_name" : ''real'' ** 3.14159235 * "element_name" : '''TYPE''' ** An element named 'element name' containing the elements specified in TYPE. ** Suppose TYPE consists of an ELEMENT1 and an ELEMENT2: *** ...... * "parent" : [ "child" : '''TYPE''' ] ** An element containing zero or more elements named "child", of type TYPE. ** .........

search

A search response contains the following elements.

always

* "results" : [ "search_result" : '''SEARCH_RESULT''' ]

usually

* "number_of_results" : '''' * "shopwiki_url" : '''' ** URL of this search on Shopwiki. ** You're probably required to include this link somewhere.

sometimes

* "related_searches" : [ "search_suggestion" : '''SEARCH_SUGGESTION''' ] ** A list of searches which we think are related to this search. * "spelling_correction" : ''string'' * "brands" : [ "brand" : ''string'' ]

stores

A stores or detail call returns the following elements:

always

* "item" : '''OFFER'''' * "offers" : [ "offer" : '''OFFER''' ]

usually

* "number_of_results" : '''' * "price_range" : '''RANGE''' * "shopwiki_url" : '''' ** URL of this search on Shopwiki. ** You're probably required to include this link somewhere. * "related_offers" : [ "offer" : '''OFFER''' ]

store-list

The response contains a list of store. * [ "store" : '''STORE''' ]

adbar-search

An adbar-search response contains the following elements.

always

* "offers" : [ "offer" : '''OFFER''' ]

usually

* "shopwiki_url" : '''' ** URL of this search on Shopwiki. ** You're probably required to include this link somewhere.

Examples

http://api.shopwiki.com/api/adbar-search.jsp?key=...&q=women's+shoes&n=3


	
		
			Dr. Scholl's Open Shoe Insoles with Massaging Gel, Women's size 6-10
			8.99
			http://www.drugstore.com/
			http://api.shopwiki.com/api/redir.jsp?k=...&u=...
			http://a1468.g.akamai.net/f/1468/580/1d/pics.Drugstore.com/prodimg/138598/200.jpg
			http://i.shopwiki.com/i/data/140x140/3/520/792/aHR0cDovL2ExNDY4LmcuYWthbWFpLm5ldC9mLzE0NjgvNTgwLzFkL3BpY3MuRHJ1Z3N0b3JlLmNvbS9wcm9kaW1nLzEzODU5OC8yMDAuanBn==.jpg
			http://i.shopwiki.com/i/data/0x0/3/520/792/aHR0cDovL2ExNDY4LmcuYWthbWFpLm5ldC9mLzE0NjgvNTgwLzFkL3BpY3MuRHJ1Z3N0b3JlLmNvbS9wcm9kaW1nLzEzODU5OC8yMDAuanBn==.jpg
			I think it is a good product but I would like it to be thicker for greater support and comfort. I also hope Dr. Scholl's will make one just for the balls of the shoe or half of the gel insole. This will help when wearing high heels.
			Dr Scholl s
			en_US
			0.21997122302703045
		
		
			Ultimate Shoe Charm Bracelet With Charms For Every Mood: Unique Jewelry Gift For Her
			119.0
			http://www.collectiblestoday.com/
			http://api.shopwiki.com/api/redir.jsp?k=...&u=...
			http://s7d4.scene7.com/is/image/CollectiblesToday/pdtl-103245001?$pdtl610$
			http://i.shopwiki.com/i/data/140x140/9/198/452/aHR0cDovL3M3ZDQuc2NlbmU3LmNvbS9pcy9pbWFnZS9Db2xsZWN0aWJsZXNUb2RheS9wZHRsLTEwMzI0NTAwMT8kcGR0bDYxMCQ===.jpg
			http://i.shopwiki.com/i/data/0x0/9/198/452/aHR0cDovL3M3ZDQuc2NlbmU3LmNvbS9pcy9pbWFnZS9Db2xsZWN0aWJsZXNUb2RheS9wZHRsLTEwMzI0NTAwMT8kcGR0bDYxMCQ===.jpg
			en_US
			0.17875000000000002
		
		
			Kenneth Cole Reaction Hug Her (Black) - Kenneth Cole Reaction Shoes
			83.0
			http://www.zappos.com/
			http://api.shopwiki.com/api/redir.jsp?k=...&u=...
			http://www.zappos.com/images/732/7327827/6219d.jpg
			http://i.shopwiki.com/i/data/140x140/0/331/585/aHR0cDovL3d3dy56YXBwb3MuY29tL2ltYWdlcy83MzIvNzMyNzgyNy82MjE5LTQzNzM2MC1kLmpwZw====.jpg
			http://i.shopwiki.com/i/data/0x0/0/331/585/aHR0cDovL3d3dy56YXBwb3MuY29tL2ltYWdlcy83MzIvNzMyNzgyNy82MjE5LTQzNzM2MC1kLmpwZw====.jpg
			Kenneth Cole Reaction's Hug Her -  This shoe is adorable! It does fit very snug across your "toe joint" as another reviewer said. I am ordering them 1/2 size bigger because of this. Love the rubber sole.
			7327827
			en_US
			0.16005585849667273
		
	
	http://www.shopwiki.com/search/women%27s_shoes

browse

A search response contains the following elements.

always

* "results" : [ "search_result" : '''SEARCH_RESULT''' ]

usually

* "number_of_results" : '''' * "shopwiki_url" : '''' ** URL of this search on Shopwiki. ** You're probably required to include this link somewhere.

Common objects (maps)

SEARCH_RESULT

always

* "offer" : '''OFFER''' * "score" : '''SCORE''' ** Two-component score, first component is relevancy (with respect to query), second component is bonus (prettiness of the offer).

sometimes

* "number_of_stores" : '''' ** 'detailed' information. * "price_range" : '''RANGE''' ** Lower and upper bounds on prices for this result. ** 'detailed' information. * "short_list" : [ "offer" : '''OFFER''' ] ** A short list of stores this offer is available from. ** 'detailed' information.

OFFER

always

* "title" : '''' * "price" : ''''

usually

* "url" : '''' ** The only time the "url" field will be absent is if there is an "affiliate_url" field, and vice versa. Both may be present, but one always will. * "affiliate_url" : '''' ** URL which will work with our affiliate program. ** This is the one you actually need to use. ** If affiliate_url is missing from an offer, default to url. ** affiliate_url may expire. No affiliate_url should be cached for more than a day. ** '''&v=''''''''''''' may be appended to the affiliate URL. *** This string is whatever visit id / user id you want it to be, from your own internal user tracking. *** The string can be up to 32 characters. *** This vid will be referenced in the reports you receive, indicating which transactions converted. * "image" : '''' ** URL of image on store's site * "thumbnail" : '''' ** URL of a 120x120 thumbnail of the image, hosted by ShopWiki. ** This uses the Shopwiki thumbnailing system. * "hosted_image" : '''' ** URL of image, hosted by ShopWiki. * "offer_id" : '''' ** Internal ID. Useful for requests to ShopWiki, not useful for anything else. Not guaranteed to be stable from day to day. * "site_id" : '''' ** Internal ID, one ID per store.

sometimes

* "description" : '''' * "model" : '''' * "brand" : '''' * "breadcrumbs" : '''' ** The breadcrumbs found for an offer. ** These may indicate some sort of category information, ie "Clothing > Pants > Jeans > Levi's". ** Maybe not, though. * "locale" : '''' ** In the form 'en_US', 'fr_FR'.

OFFER'

always

* "title" : '''' * "price" : ''''

usually

* "image" : '''' * "thumbnail" : '''' * "hosted_image" : ''''

sometimes

* "description" : ''''

SEARCH_SUGGESTION

always

* "search" : '''' * "filters" : ''''

STORE

always

* "site_id" : '''' ** Shopwiki Site Id. * "homepage_url" : '''' ** URL of the store's homepage, eg, "http://bobshardware.com/".

sometimes

* "store_name" : '''' ** Name of a store, eg, "Bob's Hardware Store". ** We might not have the name. We always have the URL, since we can't crawl the store otherwise, but the name has to be hand entered. We try to add store names whenever they're needed, but this field may be absent sometimes.

SCORE

always

* "relevancy" : '''' * "bonus" : ''''

RANGE

always

* "lower" : '''' * "upper" : ''''