Parameter | Brief description |
---|---|
shopkey | Identification number of the requesting shop, consisting of 32 hex digits (1-9/A-F). The shopkey can be found in the customer account → Account → Master data. |
shopurl | Absolute URL of the requesting shop (e.g. shop.de or sub.shop.de). |
userip | IP address of the searching user. This data is used for billing and for the user identifier. The data remains under lock and key! |
referer | The referer URL of the searching user. To track the search history. These data remain under lock and key! |
revision | Version of the shop plugin. It is used to identify the version of the plugin. |
Parameter | Brief description |
---|---|
query | The searched query parameter. |
attrib[<name>][]1) | List of discrete attributes to be applied 2) Filter |
attrib[<name>][min] | Minimum value of a constant attribute3). |
attrib[<name>][max] | Maximum value of a constant attribute. |
order | Sorting of the results see below. |
properties[] | Name of the additional optional export columns, whose contents are to be output (only relevant for XML output). |
outputAttrib[] | Name of the attributes which may be available in the template (only relevant for Direct Integration). |
pushAttrib[<key>][<value>] | Name and value of the filter which should be pushed. |
The values dynamic and asc/desc can be added to every value listed below, f.e.: salesfrequency dynamic desc.
The values asc/desc are specifying whether to sort the results ascending (asc) or descending (desc).
The value dynamic is calculating the specified value in a dynamic way and does not sort the results hard. This means that the textual relevance, the configured merchandising features and boosting via the personalization API is still influencing the sorting.
Value | Description |
---|---|
salesfrequency | Sort by sales rank / most-sold items. |
shopsort | Sort by the values, that are exported via the feed in the field //sort//. |
price | Sort by price. |
label | Alphabetic sorting. |
dateadded | Sort by date. |
detailviewcount | Sort by product detail page views. |
addtocartcount | Sort by cart adds. |
checkoutcount | Sort by number of checkouts. |
<empty> or rank | Sort by default order, that was specified (If the default order is empty, the sort order will be textual relevance only). |
Parameter | Brief description | Default value |
---|---|---|
count | Number of items to be displayed (page size - max. 32767, higher values will get set to this) | 10 |
first | First item to be displayed on the page, 0-based (NOT page number, but rather the index of the item, the page with the 1st item starts with 0, the page with the 2nd with 1, first=count indicates the second page; the page number is thus equal to first/count+1 ). | 0 |
identifier | ID of an item, only this item is returned (query is ignored) | null |
group[]4) | Customer groups to be searched 5) | empty list |
Filters of the query output are performed using the attrib
parameter.
The name and value of the filter are case-sensitive.
As a rule, the cat
key is used for categories.
attrib[cat][]=Men
Hierarchies are interlinked by means of underscores (“_”) in accordance with the shop hierarchy.
attrib[cat][]=Men_Trousers
As a rule, the vendor
key is used for categories.
attrib[vendor][]=Findologic
The price range is limited by min
and max
values.
attrib[price][min]=10.5&attrib[price][max]=200.0
If the color
attribute is stored for shop items, a color
filter can be applied as follows.
attrib[color][]=red
Multiple values are (currently) “AND-ed” exclusively. This means that only those products are output that meet satisfy all filters in the event of multiple values for one filter type.
attrib[color][]=red&attrib[color][]=blue
In the above example, only those products are output that are red and blue.
It is also possible to push products within the request.
The pushing is done with the help of the attributes and is performed by using the pushAttrib
parameter.
pushAttrib[color][red]=3
There can be more than one attribute pushed.
pushAttrib[color][blue]=0.5&pushAttrib[gender][woman]=1.5
More on this topic can be found in the manual for our personalization.