xml_export_documentation:xml_format

xml_export_documentation:xml_format

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
xml_export_documentation:xml_format [2023/01/17 15:40]
rihad
xml_export_documentation:xml_format [2023/01/25 14:14]
rihad [Using properties for product variants in search results]
Line 43: Line 43:
 ^**''<​[[#​descriptions]]>''​**| Detailed article description | Yes | No | Yes | ^**''<​[[#​descriptions]]>''​**| Detailed article description | Yes | No | Yes |
 ^**''<​[[#​prices]]>''​**| Current article price including taxes | Yes | Yes | **filterable only** | ^**''<​[[#​prices]]>''​**| Current article price including taxes | Yes | Yes | **filterable only** |
 +^**''<​[[#​overriddenPrices]]>''​**| Current article price including taxes | No | No | No |
 ^**''<​[[#​urls]]>''​**| URL to the article page, must be absolute | Yes | Yes | No | ^**''<​[[#​urls]]>''​**| URL to the article page, must be absolute | Yes | Yes | No |
 ^**''<​[[#​images]]>''​**| URL to the article image, must be absolute. | Yes | No | No | ^**''<​[[#​images]]>''​**| URL to the article image, must be absolute. | Yes | No | No |
 ^**''<​[[#​keywords]]>''​**| Keywords linked to current article | Yes | No | Yes | ^**''<​[[#​keywords]]>''​**| Keywords linked to current article | Yes | No | Yes |
-^**''<​[[#​usergroups]]>''​**| Visibility of article, i.e. only visible to the exported ​usergroups ​| Yes | No | No |+^**''<​[[#​groups]]>''​**| Visibility of article, i.e. only visible to the exported ​groups ​| Yes | No | No |
 ^**''<​[[#​bonuses]]>''​**| Bonus value to rank certain articles higher than others | No | No | No | ^**''<​[[#​bonuses]]>''​**| Bonus value to rank certain articles higher than others | No | No | No |
 ^**''<​[[#​salesfrequencies]]>''​**| Amount of sold items of this article | Yes | No | No | ^**''<​[[#​salesfrequencies]]>''​**| Amount of sold items of this article | Yes | No | No |
Line 690: Line 691:
 ---- ----
  
 +==== Using variants in search results ====
  
 +<code xml>
 +[...]
 +<​variants>​
 + <​variant id="​variant_3">​
 +...
 + </​variant>​
 + <​variant id="​variant_4">​
 +...
 + </​variant>​
 +</​variants>​
 +[...]
 +</​code>​
 +
 +A **<​variant>​** can contain the following data. This data is structured the same as for its parent.
 +
 +  * ordernumber,​ required
 +  * attributes, required
 +  * name, optional
 +  * price, optional. In case it is not set, the parent price will be used as default.
 +  * groups, optional.
 +  * overriddenPrice,​ optional
 +  * properties, optional
 +
 +<note important>​No other fields are allowed.</​note>​
 +
 +<note tip>​Currently it is not possible to use variants and usergroups together.
 +Variants only work without usergroups. But using groups is still possible. So filtering by group is working fine.</​note>​
 ==== Example XML ==== ==== Example XML ====