integration_documentation:request
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
integration_documentation:request [2019/03/14 12:22] markus [The request parameters in detail] |
integration_documentation:request [2019/05/22 12:36] florian ↷ Links adapted because of a move operation |
||
|---|---|---|---|
| Line 63: | Line 63: | ||
| \\ | \\ | ||
| - | === Required parameters === | + | ==== Required parameters ==== |
| ^ Parameter ^ Brief description ^ | ^ Parameter ^ Brief description ^ | ||
| Line 74: | Line 74: | ||
| \\ | \\ | ||
| - | === Search parameter === | + | ==== Search parameter ==== |
| ^ Parameter ^ Brief description ^ | ^ Parameter ^ Brief description ^ | ||
| Line 88: | Line 88: | ||
| \\ | \\ | ||
| - | === Values of the ''order'' parameter === | + | ==== Values of the ''order'' parameter ==== |
| - | No value can be set as a default. | + | The values //dynamic// and //ASC/DESC// can be added to every value listed below, f.e.: //salesfrequency dynamic DESC//. |
| - | ^ Value ^ Description ^ Frontend response ^ | + | The values //ASC/DESC// are specifying whether to sort the results ascending (ASC) or descending (DESC). |
| - | | ''<empty>''((Alternately, the ''rank'' value can also be given or the ''order'' parameter completely omitted)) | Relevance calculated by FINDOLOGIC | Best hits | | + | |
| - | | ''price ASC'' | Most inexpensive products first | Most inexpensive first | | + | 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 is still influencing the sorting. |
| - | | ''label ASC'' | Alphabetic sorting | A-Z | | + | |
| - | | ''salesfrequency DESC'' | Sales rank / most-sold items | Top sellers first | | + | **We strongly advise our customers to use a dynamic calculation for the default order. ** |
| - | | ''dateadded DESC'' | Newest products | New products first | | + | |
| + | ^ Value ^ Description ^ | ||
| + | | ''salesfrequency'' | Sort by sales rank / most-sold items. | | ||
| + | | ''shopsort'' | Sort by the values, that are exported via the feed in the field [[xml_export_documentation:xml_format|//sort//]]. | | ||
| + | | ''price'' | Sort by price. | | ||
| + | | ''label'' | Alphabetic sorting. | | ||
| + | | ''dateadded'' | Sort by date. | | ||
| + | | ''<empty>'' or ''rank'' | Sort by default order, that was specified (If the default order is empty, the sort order will be textual relevance only). | | ||
| \\ | \\ | ||
| - | === Limiting / paging parameters === | + | ==== Limiting / paging parameters ==== |
| ^ Parameter ^ Brief description ^ Default value ^ | ^ Parameter ^ Brief description ^ Default value ^ | ||
| Line 107: | Line 114: | ||
| | ''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'' | | | ''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'' | | | ''identifier'' | ID of an item, only this item is returned (''query'' is ignored) | ''null'' | | ||
| - | | ''group[]((For XML export, the parameter must be "usergrouphash"; note the following: [[export_patterns:xml#usergroups|Calculating the usergroup hash]]))'' | Customer groups to be searched ((Can be given multiple times; Only those items are displayed that are assigned to at least one of these customer groups; Groups that do not exist in the export are ignored.)) | empty list | | + | | ''group[]((For XML export, the parameter must be "usergrouphash"; note the following: [[xml_export_documentation:xml_format#usergroups|Calculating the usergroup hash]]))'' | Customer groups to be searched ((Can be given multiple times; Only those items are displayed that are assigned to at least one of these customer groups; Groups that do not exist in the export are ignored.)) | empty list | |
| ---- | ---- | ||