xml_export_documentation:xml_format
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
|
xml_export_documentation:xml_format [2022/05/10 16:18] rihad |
xml_export_documentation:xml_format [2023/01/25 14:14] rihad [Using properties for product variants in search results] |
||
|---|---|---|---|
| Line 13: | Line 13: | ||
| * You can find a detailed description of all available tags in our XML-patterns below. | * You can find a detailed description of all available tags in our XML-patterns below. | ||
| - | * The latest XML scheme for validation can be found on Github: [[https://github.com/FINDOLOGIC/xml-export/blob/master/src/main/resources/findologic.xsd|Findologic XML-Schema]]. Check your XML against the scheme and see if your export XML is valid: [[https://www.corefiling.com/opensource/schemaValidate.html]] | + | * The latest XML scheme for validation can be found on Github: [[https://github.com/findologic/xml-export/blob/main/src/main/resources/findologic_20.xsd|Findologic XML-Schema]]. Check your XML against the scheme and see if your export XML is valid: [[https://www.corefiling.com/opensource/schemaValidate.html]] |
| <note>Link to the script-file that triggers XML-export has to be provided in the customer login - if needed with login and password (HTML basic access authentication).</note> | <note>Link to the script-file that triggers XML-export has to be provided in the customer login - if needed with login and password (HTML basic access authentication).</note> | ||
| Line 28: | Line 28: | ||
| <note important>Control characters (**[#x01-#x08]** | **[#x0B-#x0C]** | **[#x0E-#x1F]**) are not allowed in any value of the feed.</note> | <note important>Control characters (**[#x01-#x08]** | **[#x0B-#x0C]** | **[#x0E-#x1F]**) are not allowed in any value of the feed.</note> | ||
| + | |||
| + | <note important>The summary, description and the attribute values should not contain any HTML-Tags. | ||
| + | A warning will be shown during import and the tags get stripped automatically.</note> | ||
| ---- | ---- | ||
| Line 40: | 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 | | ||
| ^**''<[[#dateAddeds]]>''**| Date current article was added | Yes | No | No | | ^**''<[[#dateAddeds]]>''**| Date current article was added | Yes | No | No | | ||
| ^**''<[[#sorts]]>''**| Value for custom sorting of search results | No | No | No | | ^**''<[[#sorts]]>''**| Value for custom sorting of search results | No | No | No | | ||
| - | ^**''<[[#visibilities]]>''**| Value for custom sorting of search results | No | No | No | | + | ^**''<[[#visibilities]]>''**| Indicates the visibility of all/some products | No | No | No | |
| ^**''<[[#attributes]]>''**| Article categories and attributes. Will be filters | Yes | Yes| Yes, **also filterable** | | ^**''<[[#attributes]]>''**| Article categories and attributes. Will be filters | Yes | Yes| Yes, **also filterable** | | ||
| ^**''<[[#properties]]>''**| Additional information of article to be shown on search result listing | Yes | Yes | No | | ^**''<[[#properties]]>''**| Additional information of article to be shown on search result listing | Yes | Yes | No | | ||
| Line 687: | 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 ==== | ||