csv_export_documentation:csv_format
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 | ||
|
csv_export_documentation:csv_format [2021/07/21 10:35] florian |
csv_export_documentation:csv_format [2023/02/22 10:55] rihad [Exporting variants with parent id] |
||
|---|---|---|---|
| Line 11: | Line 11: | ||
| <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 27: | Line 30: | ||
| ^**''[[#summary]]''**|Short description of the article, which can be displayed optionally. | No | Yes | | ^**''[[#summary]]''**|Short description of the article, which can be displayed optionally. | No | Yes | | ||
| ^**''[[#description]]''**|Detailed article description.| No | Yes | | ^**''[[#description]]''**|Detailed article description.| No | Yes | | ||
| - | ^**''[[#price]]''**|Currently valid retail price incl. taxes (f.e. currents sales price).| Yes | No | | + | ^**''[[#price]]''**|Currently valid retail price incl. taxes (f.e. currents sales price). Must have a dot (.) as decimal delimiter only. | Yes | No | |
| - | ^**''[[#instead]]''**|Regular price of the article incl. taxes. | No | No | | + | ^**''[[#overriddenPrice]]''**|Regular price of the article incl. taxes. | No | No | |
| ^**''[[#maxprice]]''**|Currently valid retail price incl. taxes with the highest available option. | No | No | | ^**''[[#maxprice]]''**|Currently valid retail price incl. taxes with the highest available option. | No | No | | ||
| ^**''[[#taxrate]]''**|Taxrate of the article. | Yes | No | | ^**''[[#taxrate]]''**|Taxrate of the article. | Yes | No | | ||
| - | ^**''[[#url]]''**|Absolute or relative link to the article-detail-page. | No | No | | + | ^**''[[#url]]''**|Absolute or relative link to the article-detail-page. | Yes | No | |
| - | ^**''[[#image]]''**|Absolute or relative link to article image. We recommend to deliver the image in thumbnail-size. | No | No | | + | ^**''[[#image]]''**|Absolute or relative link to article image. We recommend to deliver the image in thumbnail-size. Export supports more than 1 product image. Just add another column image0, image1 and so on. Syntax is “imageX” where X is any number. | No | No | |
| ^**''[[#attributes]]''**|Categories and attributes (used for filters) of the article. | Yes | Yes | | ^**''[[#attributes]]''**|Categories and attributes (used for filters) of the article. | Yes | Yes | | ||
| ^**''[[#keywords]]''**|Keywords, which are related to the article. | No | Yes | | ^**''[[#keywords]]''**|Keywords, which are related to the article. | No | Yes | | ||
| ^**''[[#groups]]''**|Groups, which the article is related to. (f.e. subshops). | No | No | | ^**''[[#groups]]''**|Groups, which the article is related to. (f.e. subshops). | No | No | | ||
| - | ^**''[[#bonus]]''**|Bonusvalue related to the specific article. This is useful to push products on top of the search results. | No | No | | + | ^**''[[#bonus]]''**|Bonusvalue related to the specific article. This is useful to push products on top of the search results. Must be a numeric value. | No | No | |
| - | ^**''[[#sales_frequency]]''**|Salesfrequency of the article. "How often was the specific article sold?" | No | No | | + | ^**''[[#sales_frequency]]''**|Salesfrequency of the article. "How often was the specific article sold?" Must not be negative. | Yes | No | |
| - | ^**''[[#date_added]]''**|The date, on which the article was added to the shop. | No | No | | + | ^**''[[#date_added]]''**|The date, on which the article was added to the shop. Use ISO-8601 as format. | No | No | |
| ^**''[[#sort]]''**|This value can be used to sort the articles and to have influence on the position of specific articles on the search result pages. Has to be an integer. | No | No | | ^**''[[#sort]]''**|This value can be used to sort the articles and to have influence on the position of specific articles on the search result pages. Has to be an integer. | No | No | | ||
| - | ^**''[[#optional_additional_columns|...]]''**| You can define additional columns freely.| No | No | | + | ^**''[[#visibilities]]''**| Indicates the visibility of all/some products | No | No | |
| + | ^**''[[#properties]]''**| You can define additional information using the properties column.| No | No | | ||
| ---- | ---- | ||
| Line 106: | Line 110: | ||
| ---- | ---- | ||
| - | === instead === | + | === overriddenPrice === |
| The gross price shown instead of the base price, for example ''Now only 39.95$ instead of 59.95$'' --> ''base price=59.95, instead=39.95''. | The gross price shown instead of the base price, for example ''Now only 39.95$ instead of 59.95$'' --> ''base price=59.95, instead=39.95''. | ||
| * The same rules as in the column ''price'' (described above) apply. | * The same rules as in the column ''price'' (described above) apply. | ||
| Line 140: | Line 144: | ||
| === attributes === | === attributes === | ||
| - | This column is used to set all values, that will be used as filters. Examples for these filters are: categories, vendor, color, size, etc. [[:customer_account:filter_configuration|Here]] you can find our documentation about filter configuration. | + | * Each attribute gets its own column, that will be used as filters. [[:customer_account:filter_configuration|Here]] you can find our documentation about filter configuration. |
| - | * Attribute name length **must not** exceed **247 characters** and attribute value length **must not** exceed **16383 characters**. | + | |
| - | * **All attributes have to be encoded in URL-style**. Example: product with vendor "Dolce & Gabbana" from category "Schnürschuhe" should have attributes like ''vendor=Dolce%20%26%20Gabbana&cat=Schn%C3%BCrschuhe''. | + | * The column name will be “attrib_” + “FILTERNAME”. Examples: “attrib_color”, “attrib_size”, “attrib_cat”, “attrib_vendor” |
| - | * It is **very important** that you also encode characters like ''='' or ''&'' that are contained in the values. | + | |
| - | * For example, a bike made by a manufacturer called ''Sons&Partners'' would look like this: ''vendor=Sons%26Partners&cat=bikes''. | + | * For an attribute with multiple values, use a comma “,” as separator. If a comma is used within the value, it must be escaped like \. A comma in column name must not be escaped. |
| - | * It is also important that all attributes are UTF-8 encoded **before** you URL encode them. | + | |
| - | * If you use a slider, do not export the values like this: //100 cm//. Correct: //100//. You can set the unit in the filter | + | ^ attrib_color ^ attrib_vendor ^ attrib_cat ^ attrib_Sport ^ |
| - | configuration in the Findologic customer account. | + | | blue,black | Nike | Running | Basic\,Sports | |
| - | * More than one value of the same attribute may be used: Use it like this: ''color=red&color=green''. | + | |
| - | * All attribute names and values are case-insensitive. | + | |
| ---- | ---- | ||
| **categories** | **categories** | ||
| - | * Categories **must** be given with the key ''cat''. This is important! | + | * Categories **must** be given with the key ''attrib_cat''. This is important! |
| - | * Sub-categories have to be separated with an underline character ''_'', which **must not** be URL-encoded. | + | * Sub-categories have to be separated with an underline character ''_''. |
| - | * For example, an article from the category ''Bikes > Mountain Bikes'' has to look like this: ''cat=Bikes_Mountain+Bikes'' | + | * For example, an article from the category ''Bikes > Mountain Bikes'' has to look like this: ''Bikes_Mountain Bikes'' |
| ---- | ---- | ||
| Line 163: | Line 165: | ||
| - | In order to use Findologic Navigation with Direct Integration, the parameter ''cat_url'' has to be added with the category path to the "attributes" column. If a product is shown in several categories, all paths have to be exported. | + | In order to use Findologic Navigation with Direct Integration, the parameter ''attrib_cat_url'' has to be added with the category path to the "attributes" column. If a product is shown in several categories, all paths have to be exported. |
| <note>You have to export both main-''cat_url's'' and sub-''cat_url's'' for the main- and sub-categories, that an article is assigned to.</note> | <note>You have to export both main-''cat_url's'' and sub-''cat_url's'' for the main- and sub-categories, that an article is assigned to.</note> | ||
| For example for a product, which is assigned to the following categories ... | For example for a product, which is assigned to the following categories ... | ||
| Line 239: | Line 241: | ||
| ---- | ---- | ||
| - | === optional_additional_columns === | + | === visibilities=== |
| - | These columns can have freely choosable names, which can be used as properties: | + | * The visibility must be set in the column visible. |
| - | * The values in these columns won't be used by for the calculation of the search results. | + | * The column **visible** is an optional column, if it did not exist all products will be visible. |
| + | * The column **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. | ||
| + | * If the column value is blank or one of the values (True, faLse, yes, no, -1 ….) , this will cause validation warnings, and will use **true** as fallback value. | ||
| + | |||
| + | ---- | ||
| + | |||
| + | === properties === | ||
| + | |||
| + | * The values in this column won't be used by for the calculation of the search results. | ||
| * All informations given here can be used for your specific needs. | * All informations given here can be used for your specific needs. | ||
| * F.e.: stock information, shipping details, etc. | * F.e.: stock information, shipping details, etc. | ||
| + | * The column name must be prefixed with “prop_”. Example “prop_shipping”, “prop_stock” | ||
| ---- | ---- | ||
| Line 306: | Line 316: | ||
| === Format === | === Format === | ||
| - | * A parent product must contain all ordernumbers of its variants and the variants must not contain any ordernumber at all. | + | * A parent product must contain all ordernumbers of its variants and each variant needs a dedicated ordernumber as well. |
| * A variant export must contain a column called parent_id | * A variant export must contain a column called parent_id | ||
| + | * Variant products must follow the parent product immediately, without any other parent products in between. | ||
| * Header column names (id, parent_id, price etc.) shouldn't be wrapped in quotes/parentheses. | * Header column names (id, parent_id, price etc.) shouldn't be wrapped in quotes/parentheses. | ||
| * Only the attributes of the parent have a effect on the outputAttributes. | * Only the attributes of the parent have a effect on the outputAttributes. | ||
| * Attributes which should be applied to all variants must be defined in the attributes field of the parent. | * Attributes which should be applied to all variants must be defined in the attributes field of the parent. | ||
| - | * ItemVariants/children without attributes will not be imported. | + | * ItemVariants/children without attributes will break the export. |
| * A child must not contain keywords. This will break the export. | * A child must not contain keywords. This will break the export. | ||
| * Prices of variant items won't be used for sorting. | * Prices of variant items won't be used for sorting. | ||