integration_documentation:plugin:en:api:plentymarkets:rest_export
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
integration_documentation:plugin:en:api:plentymarkets:rest_export [2021/04/15 14:03] daniel |
integration_documentation:plugin:en:api:plentymarkets:rest_export [2024/02/26 13:40] (current) tobi |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | {{:integration_documentation:plugins:plenty-logo.jpg?nolink&400|}} | ||
| <markdown> | <markdown> | ||
| + |  | ||
| + | |||
| # Setup data sync with Plentymarkets REST-API | # Setup data sync with Plentymarkets REST-API | ||
| Line 14: | Line 15: | ||
| The following authorisations (✓) are necessary in the tab **Rights → REST-API**: | The following authorisations (✓) are necessary in the tab **Rights → REST-API**: | ||
| + | |||
| + | </markdown> | ||
| + | <note warning>Make sure to switch to the "Advanced" mode to see all the relevant permissions</note> | ||
| + | <markdown> | ||
| * Items | * Items | ||
| Line 46: | Line 51: | ||
| * Setup | * Setup | ||
| * Property | * Property | ||
| + | * Group | ||
| + | * ✓ Show | ||
| * Selection | * Selection | ||
| * ✓ Show | * ✓ Show | ||
| + | * ✓ Show | ||
| + | * Plugins | ||
| + | * Configurations | ||
| * ✓ Show | * ✓ Show | ||
| ## Configuration of the API user | ## Configuration of the API user | ||
| - | Please enter in the [Findologic Account](https://account.findologic.com/#/app/search-navigation/import-export): | + | API username and password must be entered at the [Findologic Account](https://account.findologic.io/). |
| + | The credentials can be entered, by pressing the **Settings** button in the top right corner, in the menu under **Data > Synchronisation**. | ||
| * **Export Username**: Please enter the user name of the API user from your plentymarkets backend here. | * **Export Username**: Please enter the user name of the API user from your plentymarkets backend here. | ||
| * **Export Password**: Please enter the password of the API user from your plentymarkets backend here. | * **Export Password**: Please enter the password of the API user from your plentymarkets backend here. | ||
| - | |||
| </markdown> | </markdown> | ||
| - | {{:integration_documentation:plentymarkets_ceres_plugin:data_sync.png|800}} | + | {{:integration_documentation:plugin:en:api:plentymarkets:data_sync_config.png?450|}} |
| <markdown> | <markdown> | ||
| - | ## Define default prices for the export | + | ## Export configurations |
| - | + | ||
| - | It is necessary to define the price-ID of the price which should be shown in the webshop and the recommended retail price. Please write a mail to <mailto:support@findologic.com> and tell us the correct IDs. With this ID is guaranteed that the correct price are used and the filter and sort functions are working. | + | The export can be configured within the [Findologic Account](https://account.findologic.io/). |
| + | |||
| + |  | ||
| + | |||
| + | ### Multi-shop ID | ||
| + | |||
| + | Please configure the corresponding Store ID from the Plentymarkets backend. | ||
| + | |||
| + |  | ||
| + | |||
| + | ### Availability ID | ||
| + | |||
| + | Products with the configured availability ID will be excluded from the export | ||
| + | |||
| + |  | ||
| + | |||
| + | ### Price and RRP ID | ||
| + | |||
| + | Configure the price ID and RRP ID, that should be considered for the export. | ||
| + | |||
| + |  | ||
| + | |||
| + | ### Referrer ID | ||
| + | |||
| + | Limit the amount of exported properties to one referrer. Only properties including the configured referrer will be exported. | ||
| + | |||
| + |  | ||
| + | |||
| + |  | ||
| + | |||
| + | ## Default export | ||
| + | |||
| + | Please see [Plentymarkets Export information](integration_documentation:plugin:en:api:plentymarkets:export_information) to get an overview which values are exported by default and where they can be found in your Plentymarkets backend. | ||
| ## Export of variations | ## Export of variations | ||
| Line 69: | Line 111: | ||
| * at least one category is assigned. | * at least one category is assigned. | ||
| * there is no stock restriction or it has a stock and the stock is higher than the minimum order quantity. | * there is no stock restriction or it has a stock and the stock is higher than the minimum order quantity. | ||
| + | |||
| + | ## Exclusion tag | ||
| + | |||
| </markdown> | </markdown> | ||
| + | <note tip>It may take a while until the tag is available in the Plentymarkets API.</note> | ||
| + | <markdown> | ||
| + | |||
| + | In **Setup > Settings > Tags** create a tag named `findologic-exclude`. Please make sure to set variations and the relevant client(s). | ||
| + | </markdown> | ||
| + | {{:integration_documentation:plugin:en:api:plentymarkets:setup_tag.png?1200|}} | ||
| + | <markdown> | ||
| + | |||
| + | ### Exclude products and variations | ||
| + | |||
| + | Afterwards assign the tag to any variation which should get excluded from the Findologic export. | ||
| + | |||
| + | * If it is set to the **main variation**, the **whole product** won't get exported. | ||
| + | * If it is set to any **other variation**, only the **specific variation** won't get exported. | ||
| + | |||
| + | </markdown> | ||
| + | |||
| + | {{:integration_documentation:plugin:en:api:plentymarkets:set_tag_to_variation.png?1200|}} | ||
| + | |||
| + | <markdown> | ||
| + | |||
| + | ### Exclude categories | ||
| + | |||
| + | Assign the tag to any category, that should be excluded from the export. The category will not appear in the category filter and the category page will be handled by the Plenty Navigation. | ||
| + | |||
| + | </markdown> | ||
| + | {{:integration_documentation:plugin:en:api:plentymarkets:set_tag_to_category.png?1200|}} | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||