REST-API

get
Get Search Results

https://www.addwish.com/api/v1/search/partnerSearch
The search endpoint.
Request
Response
Request
Query Parameters
filters[]
optional
string
Limit results to those matching the specified filter(s). By default, you can filter by price, inStock, hierarchies (categories), isOnSale, brand & created. If you want to filter by other product attributes, then just contact support. For more information about filters see documentation below.
return_filters
optional
string
Defaults to false. If set to true it will return all filters you can supply as a filter for the filters[] parameter.
product_fields
optional
string
A comma separated list of what fields you would like to have returned in the response. Defaults to all standard fields.
product_start
optional
number
This is used for pagination, and is the offset. Defaults to 0. If you want results for page two you would put it to 10 (if you have 10 products per page)
product_count
optional
number
The number of results you want to have returned. Default is 10.
format
optional
string
Format for the response. Options are json or html. Defaults to html.
key
required
string
This is the primary ID of the Search configuration. See below how you can find it.
q
required
string
The search phrase you want to search for. You can search for * if you want to find all the results.
Response
200: OK
Example:
{
"results": 33,
"start": 0,
"didTrackSearch": true,
"results": [
{
"title": "Pikachu bamse",
"imgUrl": "https://pokemonbutik.dk/wp-content/uploads/2016/12/Pikachu_bamse_1-150x150.jpg",
"price": 100.0,
"currency": "DKK",
"url": "https://pokemonbutik.dk/butik/bamser/pikachu/#aw_source=ps-cbcad7ef-3848-4e01-9e21-c06d6518e6b8",
"priceFormatted": "100,00",
"description": "Pikachu plysdyr, er fremstillet i en flot kvalitet med broderede øjne, næse, mund og kinder. Alle børn elsker denne Pokémon maskot, der er den mest kendte Pokémon af dem alle. Han er en oplagt gave til enhver Pokémon fan.\n\n<iframe width=\"560\" height=\"315\" src=\"https://www.youtube.com/embed/Ir2bC_F8mFk\" frameborder=\"0\" allowfullscreen></iframe>",
"keywords": "bamse, pikachu",
"inStock": true,
"extraData": {
"itemNumber": "0001"
},
"productNumber": "21"
},
...
...
],
categories: [
{
"title": "Skor",
"description": "A description for skor",
"url": "mydomain.com/skor",
"keywords": "skor - beautiful shoes",
"hierarchy": [
"shoes",
"female"
]
],
brands: [
{
"title": "Skor",
"description": "A description for skor",
"url": "mydomain.com/skor",
"keywords": "skor - beautiful shoes",
"hierarchy": [
"nike"
]
]
}

Example

https://www.addwish.com/api/v1/search/partnerSearch?key={your config key}&product_count=10&q=pika&format=json&product_start=0

You can read about filters here.

You can find the response values here.