xml_export_documentation:xml_2_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_2_format [2023/03/28 16:45] rihad [usergroups] |
xml_export_documentation:xml_2_format [2023/07/13 09:16] (current) rihad [Using 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 | | + | ^**''<[[#overriddenPrices]]>''**| Strike-through 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 | | ||
| Line 55: | Line 55: | ||
| ^**''<[[#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 | | ||
| + | ^**''<[[#using_variants_in_search_results|variants]]>''**| Product variants | Yes | Yes | No | | ||
| ^ | [[#attributes_and_properties_in_xml-feed|Attributes and properties in XML-feed]] | | ^ | [[#attributes_and_properties_in_xml-feed|Attributes and properties in XML-feed]] | | ||
| - | ^ | [[#using_properties_for_product_variants_in_search_results|Using properties for product variants in search results]] | | ||
| - | |||
| ---- | ---- | ||
| Line 223: | Line 222: | ||
| Creating a price element with [[https://github.com/findologic/libflexport/wiki#price|libflexport]].</note> | Creating a price element with [[https://github.com/findologic/libflexport/wiki#price|libflexport]].</note> | ||
| + | |||
| + | ---- | ||
| + | |||
| + | ==== overriddenPrices ==== | ||
| + | |||
| + | <code xml> | ||
| + | [...] | ||
| + | <overriddenPrices> | ||
| + | <overriddenPrice><![CDATA[]]></overriddenPrice> | ||
| + | <overriddenPrice usergroup=""><![CDATA[]]></overriddenPrice> | ||
| + | [...] | ||
| + | </overriddenPrices> | ||
| + | [...] | ||
| + | </code> | ||
| + | |||
| + | * ''<overriddenPrices>'' contains 1+ ''<overriddenPrice>''-tags, distinguished via the usergroup-attribute. | ||
| + | * ''<overriddenPrice>'' contains the price of the product in the format ''99.99''. | ||
| + | |||
| + | <note>It is important that you use ''"."'' as decimal seperator.</note> | ||
| + | |||
| + | |||
| + | <note tip>**Using our export toolkit?** | ||
| + | |||
| + | Creating an overriddenPrice element with [[https://github.com/findologic/libflexport/wiki#overriddenPrice|libflexport]].</note> | ||
| ---- | ---- | ||
| Line 328: | Line 351: | ||
| | | ||
| - | === Using <usergroups> to set the visibility of single information relevant for a returned item === | + | === Using usergroups to set the visibility of single information relevant for a returned item === |
| - | * By using the ''<usergroups>''-tag you can set specific images, keywords, price etc. | + | * By using the ''usergroups'' attribute you can set specific images, keywords, price etc. |
| - | * By using the ''<usergroup>'' attribute within XML tags, you can set specific item information for given ''<usergroups>''. | + | * By using the ''usergroup'' attribute within XML tags, you can set specific item information for given ''usergroups''. |
| - | * If no ''<usergroup>'' is requested the default (non-usergroup) value is used for all tags. Therefore default (non-usergroup) tags are required for all elements in the data feed. | + | * If no ''usergroup'' is requested the default (non-usergroup) value is used for all tags. Therefore default (non-usergroup) tags are required for all elements in the data feed. |
| - | * If a ''<usergroup>'' is requested the usergroup-specific value is used for all tags. | + | * If a ''usergroup'' is requested the usergroup-specific value is used for all tags. |
| * **Example:** If the usergrouphash=" employee " is used -> ''<name usergroup="employee "><![CDATA[Internal product title]]></name>'' the name set for this usergroup is used. | * **Example:** If the usergrouphash=" employee " is used -> ''<name usergroup="employee "><![CDATA[Internal product title]]></name>'' the name set for this usergroup is used. | ||
| * If an item has no usergroup-specific value for a tag then the default (non-usergroup) value is used. | * If an item has no usergroup-specific value for a tag then the default (non-usergroup) value is used. | ||
| Line 344: | Line 367: | ||
| === Recommendation === | === Recommendation === | ||
| - | * In case of more than 128 ''<usergroups>'', please contact [[mailto:support@findologic.com|support@findologic.com]], in order to adjust default settings. | + | * In case of more than 128 ''<groups>'', please contact [[mailto:support@findologic.com|support@findologic.com]], in order to adjust default settings. |
| * To avoid potential misunderstandings, preferably use alphanumeric values for usergroups (e.g. ''18plus'', ''B2B''). | * To avoid potential misunderstandings, preferably use alphanumeric values for usergroups (e.g. ''18plus'', ''B2B''). | ||
| Line 350: | Line 373: | ||
| <note tip>**Using our export toolkit?** | <note tip>**Using our export toolkit?** | ||
| - | Creating an ''<usergroup>'' element with [[https://github.com/findologic/libflexport/wiki#usergroup|libflexport]].</note> | + | Creating an ''<group>'' element with [[https://github.com/findologic/libflexport/wiki#group|libflexport]].</note> |
| ==== bonuses ==== | ==== bonuses ==== | ||
| Line 463: | Line 486: | ||
| <note tip>**Using our export toolkit?** | <note tip>**Using our export toolkit?** | ||
| - | Creating a sort element with [[https://github.com/findologic/libflexport/wiki#sort|libflexport]].</note> | + | Creating a visibility element with [[https://github.com/findologic/libflexport/wiki#visibility|libflexport]].</note> |
| ---- | ---- | ||
| Line 631: | Line 654: | ||
| {{:integration_documentation:xml_schema:attr_prop.png?1140|}} | {{:integration_documentation:xml_schema:attr_prop.png?1140|}} | ||
| - | |||
| - | |||
| - | ---- | ||
| - | |||
| - | ==== Using properties for product variants in search results ==== | ||
| - | |||
| - | If you want to show different variations (colors, sizes etc.) of a certain product in your shop and you want to display those variants in specific product-cards on the search result page, it can be realized by following the steps described below (example for colors): | ||
| - | |||
| - | **Functionality:** | ||
| - | - All color-variants displayed for parent (master)-product. | ||
| - | - While hovering over the variant picture - appropriate image should be displayed. | ||
| - | - By click on a color-variant or on an image the page of the product with the right color should be opened. | ||
| - | |||
| - | **1.**{{:integration_documentation:xml_schema:1.1.png?200|}} | ||
| - | **2.**{{:integration_documentation:xml_schema:3.1.1.png?200|}} | ||
| - | **3.**{{:integration_documentation:xml_schema:4.1.1.png?515|}} | ||
| - | |||
| - | **How the XML should look like:** | ||
| - | |||
| - | You have to provide an appropriate property (for example "variants") for every parent-product by using a JSON-string. Here is an example of this property: | ||
| - | |||
| - | <code xml> | ||
| - | [...] | ||
| - | <allProperties> | ||
| - | <properties> | ||
| - | <property> | ||
| - | <key>variants</key> | ||
| - | <value><![CDATA[ | ||
| - | { | ||
| - | "Mud" : { | ||
| - | "VariantIconPic" : "https://www.shop.com/media/jacket_mud_variant_icon.jpg", | ||
| - | "productPic" : "https://www.shop.com/media/jacket_mud_variant_pic.jpg", | ||
| - | "productUrl" : "https://www.shop.com/jacket_mud" | ||
| - | }, | ||
| - | "Black" : { | ||
| - | "VariantIconPic" : "https://www.shop.com/media/jacket_black_variant_icon.jpg", | ||
| - | "productPic" : "https://www.shop.com/media/jacket_black_variant_pic.jpg", | ||
| - | "productUrl" : "https://www.shop.com/jacket_black" | ||
| - | }, | ||
| - | "Red" : { | ||
| - | "VariantIconPic" : "https://www.shop.com/media/jacket_red_variant_icon.jpg", | ||
| - | "productPic" : "https://www.shop.com/media/jacket_red_variant_pic.jpg", | ||
| - | "productUrl" : "https://www.shop.com/jacket_red" | ||
| - | }, | ||
| - | "Navy" : { | ||
| - | "VariantIconPic" : "https://www.shop.com/media/jacket_navy_variant_icon.jpg", | ||
| - | "productPic" : "https://www.shop.com/media/jacket_navy_variant_pic.jpg", | ||
| - | "productUrl" : "https://www.shop.com/jacket_navy" | ||
| - | } | ||
| - | } | ||
| - | ]]></value> | ||
| - | </property> | ||
| - | </properties> | ||
| - | </allProperties> | ||
| - | [...] | ||
| - | </code> | ||
| - | |||
| ---- | ---- | ||
| Line 711: | Line 677: | ||
| * attributes, required | * attributes, required | ||
| * name, optional | * name, optional | ||
| - | * price, optional. In case it is not set, the parent price will be used as default. | + | * price, optional. (In case it is not set, the parent price will be used as default.) |
| * groups, optional. | * groups, optional. | ||
| * overriddenPrice, optional | * overriddenPrice, optional | ||
| * properties, optional | * properties, optional | ||
| + | * urls, optional | ||
| + | * images, optional | ||
| + | |||
| <note important>No other fields are allowed.</note> | <note important>No other fields are allowed.</note> | ||
| Line 720: | Line 689: | ||
| <note tip>Currently it is not possible to use variants and usergroups together. | <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> | Variants only work without usergroups. But using groups is still possible. So filtering by group is working fine.</note> | ||
| + | |||
| + | <note tip>**Using our export toolkit?** | ||
| + | |||
| + | Creating a variant element with [[https://github.com/findologic/libflexport/wiki#variants|libflexport]].</note> | ||
| + | |||
| ==== Example XML ==== | ==== Example XML ==== | ||
| - | <code xml findologic.xml> | + | * [[https://github.com/findologic/libflexport/blob/develop/resources/baseline_examples/example.xml|Without variants]]. |
| - | <?xml version="1.0" encoding="UTF-8"?> | + | * [[https://github.com/findologic/libflexport/blob/develop/resources/baseline_examples/example-variants.xml|With variants]]. |
| - | <findologic version="1.0"> | + | |
| - | <items start="10" count="1" total="30"> | + | |
| - | <item id="01120c948ad41a2284ad9f0402fbc7d"> | + | |
| - | <allOrdernumbers> | + | |
| - | <ordernumbers> | + | |
| - | <ordernumber>277KTL</ordernumber> | + | |
| - | <ordernumber>4987123846879</ordernumber> | + | |
| - | </ordernumbers> | + | |
| - | <ordernumbers usergroup="LNrLF7BRVJ0toQ=="> | + | |
| - | <ordernumber>377KTL</ordernumber> | + | |
| - | </ordernumbers> | + | |
| - | <ordernumbers usergroup="PN3enVBRVH0To(/"> | + | |
| - | <ordernumber>577LTK</ordernumber> | + | |
| - | </ordernumbers> | + | |
| - | </allOrdernumbers> | + | |
| - | <names> | + | |
| - | <name>Adidas Sneaker</name> | + | |
| - | <name usergroup="LNrLF7BRVJ0toQ==">Adidas Men's Sneaker</name> | + | |
| - | <name usergroup="PN3enVBRVH0To(/">Adidas Women's Sneaker</name> | + | |
| - | </names> | + | |
| - | <summaries> | + | |
| - | <summary>A cool and fashionable sneaker</summary> | + | |
| - | <summary usergroup="LNrLF7BRVJ0toQ==">A cool and fashionable sneaker for men</summary> | + | |
| - | <summary usergroup="PN3enVBRVH0To(/">A cool and fashionable sneaker for women</summary> | + | |
| - | </summaries> | + | |
| - | <descriptions> | + | |
| - | <description>With this sneaker you will walk in style. It's available in green and blue.</description> | + | |
| - | <description usergroup="LNrLF7BRVJ0toQ==">With this men's sneaker you will walk in style. It comes in various sizes and colors.</description> | + | |
| - | <description usergroup="PN3enVBRVH0To(/">With this women's sneaker you will walk in style. It comes in various sizes and colors.</description> | + | |
| - | </descriptions> | + | |
| - | <prices> | + | |
| - | <price>44.8</price> | + | |
| - | <price usergroup="LNrLF7BRVJ0toQ==">42.9</price> | + | |
| - | <price usergroup="PN3enVBRVH0To(/">39.9</price> | + | |
| - | </prices> | + | |
| - | <urls> | + | |
| - | <url>https://www.store.com/sneakers/adidas.html</url> | + | |
| - | <url usergroup="LNrLF7BRVJ0toQ==">https://www.store.com/sneakers/mens/adidas.html</url> | + | |
| - | <url usergroup="PN3enVBRVH0To(/">https://www.store.com/sneakers/women/adidas.html</url> | + | |
| - | </urls> | + | |
| - | <allImages> | + | |
| - | <images> | + | |
| - | <image>https://www.store.com/images/277KTL.png</image> | + | |
| - | </images> | + | |
| - | <images usergroup="LNrLF7BRVJ0toQ=="> | + | |
| - | <image>https://www.store.com/images/277KTL.png</image> | + | |
| - | </images> | + | |
| - | <images usergroup="PN3enVBRVH0To(/"> | + | |
| - | <image>https://www.store.com/images/577LTK.png</image> | + | |
| - | </images> | + | |
| - | </allImages> | + | |
| - | <allAttributes> | + | |
| - | <attributes> | + | |
| - | <attribute> | + | |
| - | <key>cat</key> | + | |
| - | <values> | + | |
| - | <value>Sneakers_Men</value> | + | |
| - | <value>Sneakers_Women</value> | + | |
| - | <value>Specials_Sale</value> | + | |
| - | </values> | + | |
| - | </attribute> | + | |
| - | <attribute> | + | |
| - | <key>cat_url</key> | + | |
| - | <values> | + | |
| - | <value>/sneakers/men</value> | + | |
| - | <value>/sneakers/women</value> | + | |
| - | <value>/specials/sale</value> | + | |
| - | </values> | + | |
| - | </attribute> | + | |
| - | <attribute> | + | |
| - | <key>vendor</key> | + | |
| - | <values> | + | |
| - | <value>Adidas</value> | + | |
| - | </values> | + | |
| - | </attribute> | + | |
| - | <attribute> | + | |
| - | <key>color</key> | + | |
| - | <values> | + | |
| - | <value>green</value> | + | |
| - | <value>blue</value> | + | |
| - | </values> | + | |
| - | </attribute> | + | |
| - | </attributes> | + | |
| - | </allAttributes> | + | |
| - | <allKeywords> | + | |
| - | <keywords> | + | |
| - | <keyword>fashion</keyword> | + | |
| - | <keyword>cool product</keyword> | + | |
| - | </keywords> | + | |
| - | <keywords usergroup="LNrLF7BRVJ0toQ=="> | + | |
| - | <keyword>fashion</keyword> | + | |
| - | <keyword>cool product</keyword> | + | |
| - | <keyword>mens</keyword> | + | |
| - | </keywords> | + | |
| - | <keywords usergroup="PN3enVBRVH0To(/"> | + | |
| - | <keyword>fashion</keyword> | + | |
| - | <keyword>cool product</keyword> | + | |
| - | <keyword>women</keyword> | + | |
| - | </keywords> | + | |
| - | </allKeywords> | + | |
| - | <usergroups> | + | |
| - | <usergroup>LNrLF7BRVJ0toQ==</usergroup> | + | |
| - | <usergroup>PN3enVBRVH0To(/</usergroup> | + | |
| - | </usergroups> | + | |
| - | <bonuses> | + | |
| - | <bonus>3</bonus> | + | |
| - | <bonus usergroup="LNrLF7BRVJ0toQ==">5</bonus> | + | |
| - | <bonus usergroup="PN3enVBRVH0To(/">5</bonus> | + | |
| - | </bonuses> | + | |
| - | <salesFrequencies> | + | |
| - | <salesFrequency>15</salesFrequency> | + | |
| - | <salesFrequency usergroup="LNrLF7BRVJ0toQ==">5</salesFrequency> | + | |
| - | <salesFrequency usergroup="PN3enVBRVH0To(/">8</salesFrequency> | + | |
| - | </salesFrequencies> | + | |
| - | <dateAddeds> | + | |
| - | <dateAdded>2020-05-30T09:30:10</dateAdded> | + | |
| - | <dateAdded usergroup="LNrLF7BRVJ0toQ==">2020-07-30T00:00:00</dateAdded> | + | |
| - | <dateAdded usergroup="PN3enVBRVH0To(/">2020-06-30T00:00:00</dateAdded> | + | |
| - | </dateAddeds> | + | |
| - | <sorts> | + | |
| - | <sort>5</sort> | + | |
| - | <sort usergroup="LNrLF7BRVJ0toQ==">7</sort> | + | |
| - | <sort usergroup="PN3enVBRVH0To(/">6</sort> | + | |
| - | </sorts> | + | |
| - | <allProperties> | + | |
| - | <properties> | + | |
| - | <property> | + | |
| - | <key>sale</key> | + | |
| - | <value>1</value> | + | |
| - | </property> | + | |
| - | <property> | + | |
| - | <key>novelty</key> | + | |
| - | <value>0</value> | + | |
| - | </property> | + | |
| - | <property> | + | |
| - | <key>logo</key> | + | |
| - | <value>http://www.shop.de/vendor.png</value> | + | |
| - | </property> | + | |
| - | <property> | + | |
| - | <key>availability</key> | + | |
| - | <value><![CDATA[<span style="color: green;">3 days</span>]]></value> | + | |
| - | </property> | + | |
| - | <property> | + | |
| - | <key>old_price</key> | + | |
| - | <value>99.9</value> | + | |
| - | </property> | + | |
| - | <property> | + | |
| - | <key>Basic_rate_price</key> | + | |
| - | <value>44.8</value> | + | |
| - | </property> | + | |
| - | </properties> | + | |
| - | <properties usergroup="LNrLF7BRVJ0toQ=="> | + | |
| - | <property> | + | |
| - | <key>sale</key> | + | |
| - | <value>0</value> | + | |
| - | </property> | + | |
| - | <property> | + | |
| - | <key>novelty</key> | + | |
| - | <value>0</value> | + | |
| - | </property> | + | |
| - | <property> | + | |
| - | <key>logo</key> | + | |
| - | <value>http://www.shop.de/vendor.png</value> | + | |
| - | </property> | + | |
| - | <property> | + | |
| - | <key>availability</key> | + | |
| - | <value><![CDATA[<span style="color: green;">3 days</span>]]></value> | + | |
| - | </property> | + | |
| - | <property> | + | |
| - | <key>old_price</key> | + | |
| - | <value>99.9</value> | + | |
| - | </property> | + | |
| - | <property> | + | |
| - | <key>Basic_rate_price</key> | + | |
| - | <value>44.8</value> | + | |
| - | </property> | + | |
| - | </properties> | + | |
| - | <properties usergroup="PN3enVBRVH0To(/"> | + | |
| - | <property> | + | |
| - | <key>sale</key> | + | |
| - | <value>1</value> | + | |
| - | </property> | + | |
| - | <property> | + | |
| - | <key>novelty</key> | + | |
| - | <value>0</value> | + | |
| - | </property> | + | |
| - | <property> | + | |
| - | <key>logo</key> | + | |
| - | <value>http://www.shop.de/vendor.png</value> | + | |
| - | </property> | + | |
| - | <property> | + | |
| - | <key>availability</key> | + | |
| - | <value><![CDATA[<span style="color: green;">3 days</span>]]></value> | + | |
| - | </property> | + | |
| - | <property> | + | |
| - | <key>old_price</key> | + | |
| - | <value>99.9</value> | + | |
| - | </property> | + | |
| - | <property> | + | |
| - | <key>Basic_rate_price</key> | + | |
| - | <value>44.8</value> | + | |
| - | </property> | + | |
| - | </properties> | + | |
| - | </allProperties> | + | |
| - | </item> | + | |
| - | </items> | + | |
| - | </findologic> | + | |
| - | </code> | + | |
| - | + | ||
| - | ---- | + | |
| {{tag>XML_export XML}} | {{tag>XML_export XML}} | ||