integration_documentation:plugin:en:api:plentymarkets:export_information
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
integration_documentation:plugin:en:api:plentymarkets:export_information [2021/04/15 12:40] dominik created |
integration_documentation:plugin:en:api:plentymarkets:export_information [2023/10/25 10:58] (current) tobi |
||
---|---|---|---|
Line 3: | Line 3: | ||
# Plentymarkets Export Information | # Plentymarkets Export Information | ||
- | Overview of Plentymarkets product data which is considered for the Findologic CSV export via REST API. | + | Overview of Plentymarkets product data which is considered for the Findologic XML export via REST API. |
- | ## Summary | + | ## XML Summary |
| Item | Short Description | In export | Reason | | | Item | Short Description | In export | Reason | | ||
|------------------|-------------------------------------------------------------------------------------|-----------|---------------| | |------------------|-------------------------------------------------------------------------------------|-----------|---------------| | ||
| **[id](#Id)** | Id of the product | Yes | | | | **[id](#Id)** | Id of the product | Yes | | | ||
- | | **[ordernumber](#Ordernumber)** | Contains number, model, id, etc. of all variants | Yes | | | + | | **[ordernumber](#Ordernumber)** | Number, model, id, item-id and barcodes of all variants | Yes | | |
| **[name](#Name)** | Product title | Yes | | | | **[name](#Name)** | Product title | Yes | | | ||
| **[summary](#Summary)** | Short description | Yes | | | | **[summary](#Summary)** | Short description | Yes | | | ||
| **[description](#Description)** | Long description | Yes | | | | **[description](#Description)** | Long description | Yes | | | ||
| **[price](#Price)** | Lowest price of the product and all its variants | Yes | | | | **[price](#Price)** | Lowest price of the product and all its variants | Yes | | | ||
- | | **[instead](#Instead)** | Lowest RRP price of the product and all its variants | Yes | | | + | | **[overriddenPrice](#overriddenPrice)** | Lowest RRP price of the product and all its variants | Yes | | |
- | | **maxprice** | Currently valid retail price incl. taxes with the highest available option. | No | Not available | | + | |
- | | **[taxrate](#Tax_rate)** | Tax/Vat rate of the last variant | Yes | | | + | |
| **[url](#Url)** | URL to the product detail page | Yes | | | | **[url](#Url)** | URL to the product detail page | Yes | | | ||
| **[image](#Image)** | Product image | Yes | | | | **[image](#Image)** | Product image | Yes | | | ||
Line 28: | Line 26: | ||
| **[sort](#Sort)** | Contains the position of the main variation. | Yes | | | | **[sort](#Sort)** | Contains the position of the main variation. | Yes | | | ||
| Additional properties: | | | | | | Additional properties: | | | | | ||
- | | **[price_id](#Price_id)** | Configured id, which is used to determine the price | Yes | | | + | | **[price_id](#Price_id)** | Configured id used to determine the price | Yes | | |
| **[variation_id](#Variation_id)** | Variation id of the main variation | Yes | | | | **[variation_id](#Variation_id)** | Variation id of the main variation | Yes | | | ||
| **[base_unit](#Base_unit)** | Configured base unit | Yes | | | | **[base_unit](#Base_unit)** | Configured base unit | Yes | | | ||
Line 47: | Line 45: | ||
### Ordernumber | ### Ordernumber | ||
- | The ordernumber column contains the **number, model, id, item id, and Barcodes** of all exportable variations. | + | The ordernumber column contains the **number, model, id, item id, and barcodes** of all exportable variations. |
![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_ordernumber.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_ordernumber.png) | ![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_ordernumber.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_ordernumber.png) | ||
Line 75: | Line 73: | ||
![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_price.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_price.png) | ![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_price.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_price.png) | ||
- | ### Instead | + | ### OverriddenPrice |
Contains the **lowest instead price** of **all exportable variants**. The price is based on the configured **RRP price id**. | Contains the **lowest instead price** of **all exportable variants**. The price is based on the configured **RRP price id**. | ||
![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_instead_price.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_instead_price.png) | ![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_instead_price.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_instead_price.png) | ||
- | |||
- | ### Tax rate | ||
- | |||
- | Contains the configured **VAT rate** of the product as a **floating point number** (e.g. `19.00` or `16.50`). | ||
- | |||
- | ![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_taxrate.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_taxrate.png) | ||
### URL | ### URL | ||
Line 95: | Line 87: | ||
* **Language** (e.g. "en") | * **Language** (e.g. "en") | ||
* **Configured URL Path** (e.g. "wohnzimmer/sessel-sofas/sessel-new-york-echtlederbezug-in-braun") | * **Configured URL Path** (e.g. "wohnzimmer/sessel-sofas/sessel-new-york-echtlederbezug-in-braun") | ||
- | * **Product ID** (e.g. "1001") | + | * **Product id** (e.g. "1001") |
- | A complete URL may look something like this: https://www.shop.com/en/wohnzimmer/sessel-sofas/sessel-new-york-echtlederbezug-in-braun/a-1001. | + | Complete URL example: https://www.shop.com/en/wohnzimmer/sessel-sofas/sessel-new-york-echtlederbezug-in-braun/a-1001. |
![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_url.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_url.png) | ![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_url.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_url.png) | ||
Line 111: | Line 103: | ||
Attributes/Filters are being fetched from multiple places. | Attributes/Filters are being fetched from multiple places. | ||
- | **Manufacturer** - Filter name is `vendor` | + | 1. **Manufacturer** - Filter name is `vendor` |
![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_vendor.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_vendor.png) | ![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_vendor.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_vendor.png) | ||
- | **Category** - Filter name is `cat` | + | 1. **Category** - Filter name is `cat` |
![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_cat.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_cat.png) | ![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_cat.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_cat.png) | ||
- | **Free-Text Fields** - Filter names are `free1` - `free20` | + | 1. **Free-Text Fields** - Filter names are `free1` - `free20` |
![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_free.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_free.png) | ![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_free.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_free.png) | ||
- | **Characteristics (de: Merkmale)** - Must be marked as searchable! - Filter names are depending on the name of the characteristic | + | 1. **Characteristics (de: Merkmale)** - Filter names are depending on the name of the characteristic |
![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_characteristic_1.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_characteristic_1.png) | ![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_characteristic_1.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_characteristic_1.png) | ||
+ | 1. **Characteristics (de: Merkmale)** - Must be marked as searchable! | ||
![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_characteristic_2.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_characteristic_2.png) | ![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_characteristic_2.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_characteristic_2.png) | ||
- | **Properties (de: Eigenschaften)** - Filter names are depending on the name of the property | + | 1. **Properties (de: Eigenschaften)** - Filter names are depending on the name of the property |
![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_properties.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_properties.png) | ![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_properties.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_properties.png) | ||
- | **Attributes** - Filter names are depending on the name of the attributes | + | 1. **Attributes** - Filter names are depending on the name of the attributes |
![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_attributes.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_attributes.png) | ![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_attributes.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_attributes.png) | ||
+ | |||
+ | 1. **Dimensions** - Unit can be configured within the Account | ||
+ | ![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_attributes.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_attr_dimensions.png) | ||
### Keywords | ### Keywords | ||
Line 143: | Line 139: | ||
### Groups | ### Groups | ||
- | Groups contain all **store identifiers** of this product with an underscore. E.g. multishop id is `0`, than the group will be `0_`. | + | Groups contain all **store identifiers** of this product with an underscore e.g. multishop id with `0`, the group is `0_`. |
![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_groups.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_groups.png) | ![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_groups.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_groups.png) | ||
Line 149: | Line 145: | ||
### Sales frequency | ### Sales frequency | ||
- | When the option **Setup > Client > (your shop) > Item layouts > Settings > Automatically sort by monthly sales** is active, the sales_frequency is exported based on the position of the variation. The highest position is used for this value. | + | When the option **Calculate the variation position based on monthly sales** is active, the sales_frequency is exported based on the position of the variation. The highest position is used for this value. |
![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_sales_frequency_1.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_sales_frequency_1.png) | ![https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_sales_frequency_1.png](https://docs.findologic.com/lib/exe/fetch.php?media=integration_documentation:plugin:en:api:plentymarkets:plenty_sales_frequency_1.png) | ||
Line 157: | Line 153: | ||
### Date added | ### Date added | ||
- | Contains the **date** of the products' **creation** as a UNIX timestamp. E.g. `1205708400` | + | Product **create date** as a timestamp. E.g. `1205708400` |
### Sort | ### Sort | ||
Line 169: | Line 165: | ||
#### Price id | #### Price id | ||
- | Contains the configured **price ID**. Please contact our support@findologic.com in case this value needs to be changed. | + | Contains the configured **price id** for the Findologic service. |
#### Variation id | #### Variation id |