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 | ||
|
xml_export_documentation:xml_format [2020/08/18 12:00] florian [Example XML] |
xml_export_documentation:xml_format [2023/02/22 13:03] (current) rihad old revision restored (2022/05/11 14:19) |
||
|---|---|---|---|
| Line 26: | Line 26: | ||
| [...] | [...] | ||
| <html></pre></html></note> | <html></pre></html></note> | ||
| + | |||
| + | <note important>Control characters (**[#x01-#x08]** | **[#x0B-#x0C]** | **[#x0E-#x1F]**) are not allowed in any value of the feed.</note> | ||
| ---- | ---- | ||
| Line 33: | Line 35: | ||
| ^**''<?xml version=“...” encoding=“...”?>''**| Specifies the encoding | Yes | Yes | No | | ^**''<?xml version=“...” encoding=“...”?>''**| Specifies the encoding | Yes | Yes | No | | ||
| ^**''<[[#item]] id="">''**| Unique identifier | Yes | Yes | No | | ^**''<[[#item]] id="">''**| Unique identifier | Yes | Yes | No | | ||
| - | ^**''<[[#ordernumbers]]>''**| Article number or order number | Yes | No | Yes | | + | ^**''<[[#ordernumbers]]>''**| Article number, EAN or SKU | Yes | No | Yes | |
| ^**''<[[#names]]>''**| Article name, as usually shown on the result page | Yes | Yes | Yes | | ^**''<[[#names]]>''**| Article name, as usually shown on the result page | Yes | Yes | Yes | | ||
| ^**''<[[#summaries]]>''**| Summarized article description | Yes | No | Yes | | ^**''<[[#summaries]]>''**| Summarized article description | Yes | No | Yes | | ||
| Line 46: | Line 48: | ||
| ^**''<[[#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]]>''**| 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 76: | Line 79: | ||
| <note important>Due to runtime limitations the XML-export has to be [[https://docs.findologic.com/doku.php?id=xml_export_documentation:xml_request_and_response|paginated]].</note> | <note important>Due to runtime limitations the XML-export has to be [[https://docs.findologic.com/doku.php?id=xml_export_documentation:xml_request_and_response|paginated]].</note> | ||
| + | |||
| + | <note important>You have to use double quotes to seperate XML attributes like "count" or "total". Single quotes are not supported at the moment.</note> | ||
| <note tip>**Using our export toolkit?** | <note tip>**Using our export toolkit?** | ||
| Line 120: | Line 125: | ||
| * ''<ordernumbers>'' contains 1+ ''<ordernumber>''-tags. | * ''<ordernumbers>'' contains 1+ ''<ordernumber>''-tags. | ||
| * ''<ordernumber>'' contains an article-number like internal arcticle number, EAN, ISBN, ... | * ''<ordernumber>'' contains an article-number like internal arcticle number, EAN, ISBN, ... | ||
| + | |||
| + | <note>This field should be used only for article numbers/EANs/SKUs and NOT for the number that a user gets when an order is being submitted in your shop.</note> | ||
| <note tip>**Using our export toolkit?** | <note tip>**Using our export toolkit?** | ||
| Line 353: | Line 360: | ||
| * ''<bonuses>'' contains 1+ ''<bonus>''-tags, distinguished via the usergroup-attribute. | * ''<bonuses>'' contains 1+ ''<bonus>''-tags, distinguished via the usergroup-attribute. | ||
| - | * ''<bonus>'' contains a bonus value (between -0.9 and 3) to lower or raise the ranking of a product in general. | + | * ''<bonus>'' contains a bonus value (between -0.9 and 3) to lower or raise the ranking of a product in general. |
| - | * If you have product pushing enabled in your customer login, be aware that these values will override the current values at the concerned products in the bonus field. | + | |
| <note>Please note, that the value -1 will be overridden with the value -0.9 in the import.</note> | <note>Please note, that the value -1 will be overridden with the value -0.9 in the import.</note> | ||
| Line 379: | Line 385: | ||
| * ''<salesFrequency>'' contains a non-negative integer value for the salesfrequency which can be used for sorting. | * ''<salesFrequency>'' contains a non-negative integer value for the salesfrequency which can be used for sorting. | ||
| * If you want your default order to be dynamically calculated including the exported ''<salesFrequency>''-values, please contact our support team. | * If you want your default order to be dynamically calculated including the exported ''<salesFrequency>''-values, please contact our support team. | ||
| - | |||
| - | <note>Please note, that negative values will be overridden with the value 0 in the import.</note> | ||
| <note tip>**Using our export toolkit?** | <note tip>**Using our export toolkit?** | ||
| Line 426: | Line 430: | ||
| * ''<sorts>'' contains 1+ ''<sort>''-tags, distinguished via the usergroup-attribute. | * ''<sorts>'' contains 1+ ''<sort>''-tags, distinguished via the usergroup-attribute. | ||
| * ''<sort>'' contains a custom integer value which can be used for sorting. | * ''<sort>'' contains a custom integer value which can be used for sorting. | ||
| - | * If you want your default order to be dynamically calculated including the exported ''<salesFrequency>''-values, please contact our support team. | + | * If you want your default order to be dynamically calculated including the exported ''<sort>''-values, please contact our support team. |
| * You should not use negative values as ''<sort>''-values. | * You should not use negative values as ''<sort>''-values. | ||
| + | |||
| + | <note tip>**Using our export toolkit?** | ||
| + | |||
| + | Creating a sort element with [[https://github.com/findologic/libflexport/wiki#sort|libflexport]].</note> | ||
| + | |||
| + | ---- | ||
| + | |||
| + | ==== visibilities ==== | ||
| + | |||
| + | <code xml> | ||
| + | [...] | ||
| + | <visibilities> | ||
| + | <visibile><![CDATA[]]></visibile> | ||
| + | <visibile usergroup=""><![CDATA[]]></visibile> | ||
| + | [...] | ||
| + | </visibilities> | ||
| + | [...] | ||
| + | </code> | ||
| + | |||
| + | * ''<visibilities>'' contains 1+ <visible>-tags, distinguished via the usergroup-attribute. | ||
| + | * ''<visible>'' must contain lowercase **true** (or **1** as a replacement) for visible initial state or lowercase **false** (or **0** as a replacement) for invisible initial state. | ||
| + | * The default value of the default visible element (non-usergroup) is true if it did not exist. | ||
| + | * The default value of a visible element with the usergroup tag is the same value of the default visible element if it did not exist. | ||
| + | * If the visible element value is blank or one of the values (True, faLse, yes, no, -1 ….) , this will cause validation errors. | ||
| <note tip>**Using our export toolkit?** | <note tip>**Using our export toolkit?** | ||
| Line 767: | Line 795: | ||
| <usergroup>LNrLF7BRVJ0toQ==</usergroup> | <usergroup>LNrLF7BRVJ0toQ==</usergroup> | ||
| <usergroup>PN3enVBRVH0To(/</usergroup> | <usergroup>PN3enVBRVH0To(/</usergroup> | ||
| - | <usergroup>cHBw</usergroup> | ||
| </usergroups> | </usergroups> | ||
| <bonuses> | <bonuses> | ||