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/04/19 10:55] florian [The request parameters in detail] |
integration_documentation:request [2019/06/19 10:45] florian [Values of the ''order'' parameter] |
||
|---|---|---|---|
| Line 82: | Line 82: | ||
| | ''attrib[<name>][max]'' | Maximum value of a constant attribute. | | | ''attrib[<name>][max]'' | Maximum value of a constant attribute. | | ||
| | ''order'' | Sorting of the results [[#Values of the ''order'' parameter|see below]]. | | | ''order'' | Sorting of the results [[#Values of the ''order'' parameter|see below]]. | | ||
| - | | ''properties[]'' | Name of the [[export_patterns:csv#optional_additional_columns|additional optional export columns]], whose contents are to be output (only relevant for XML output). | | + | | ''properties[]'' | Name of the [[csv_export_documentation:csv_format#optional_additional_columns|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). | | | ''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.| | | ''pushAttrib[<key>][<value>]'' | Name and value of the filter which should be pushed.| | ||
| Line 94: | Line 94: | ||
| The values //ASC/DESC// are specifying whether to sort the results ascending (ASC) or descending (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 is still influencing the sorting. | + | 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. |
| **We strongly advise our customers to use a dynamic calculation for the default order. ** | **We strongly advise our customers to use a dynamic calculation for the default order. ** | ||
| Line 100: | Line 100: | ||
| ^ Value ^ Description ^ | ^ Value ^ Description ^ | ||
| | ''salesfrequency'' | Sort by sales rank / most-sold items. | | | ''salesfrequency'' | Sort by sales rank / most-sold items. | | ||
| - | | ''shopsort'' | Sort by the values, that are exported via the feed in the field [[export_patterns:xml|//sort//]]. | | + | | ''shopsort'' | Sort by the values, that are exported via the feed in the field [[xml_export_documentation:xml_format|//sort//]]. | |
| | ''price'' | Sort by price. | | | ''price'' | Sort by price. | | ||
| | ''label'' | Alphabetic sorting. | | | ''label'' | Alphabetic sorting. | | ||
| Line 114: | 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 | |
| ---- | ---- | ||