integration_documentation:plugin:en:api:plentymarkets:rest_export
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
integration_documentation:plugin:en:api:plentymarkets:rest_export [2021/02/10 16:37] dominik created |
integration_documentation:plugin:en:api:plentymarkets:rest_export [2024/02/26 13:40] (current) tobi |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ===== Setup data sync with Plentymarkets REST-API ===== | + | <markdown> |
| + |  | ||
| - | ==== Create API user ==== | + | # Setup data sync with Plentymarkets REST-API |
| - | - Login to your Plentymarkets backend. | + | ## Create API user |
| - | - Setup a user of the class **API** in your shop, see [[https://knowledge.plentymarkets.com/en/slp/daten/rest-api#end-users|Plentymarkets documentation]]. | + | |
| + | Setup a user with access **REST-API** in your shop, see also [Plentymarkets documentation](https://knowledge.plentymarkets.com/en/slp/daten/rest-api#end-users). | ||
| + | |||
| + | </markdown> | ||
| <note tip>The username and password must not contain special characters.</note> | <note tip>The username and password must not contain special characters.</note> | ||
| + | <markdown> | ||
| - | ==== Set permissions ==== | + | ## Required permissions |
| - | * The following permissions are necessary to setup in the tab ''Rights » REST-API'': | + | The following authorisations (✓) are necessary in the tab **Rights → REST-API**: |
| - | ____________________________________________ | + | |
| - | * Items | + | </markdown> |
| + | <note warning>Make sure to switch to the "Advanced" mode to see all the relevant permissions</note> | ||
| + | <markdown> | ||
| + | |||
| + | * Items | ||
| + | * Characteristic | ||
| + | * Characteristic group | ||
| + | * ✓ Show | ||
| + | * ✓ Show | ||
| + | * Item | ||
| + | * Item image | ||
| + | * Item image name | ||
| + | * ✓ Show | ||
| + | * ✓ Show | ||
| + | * Variation | ||
| * Attribute | * Attribute | ||
| - | * Attribute link | + | * Value |
| - | * Show attribute link | + | * ✓ Show |
| - | * Item characteristic | + | * Barcode |
| - | * Item characteristic group | + | * ✓ Show |
| - | * Show item characteristic group | + | * Category |
| - | * Show item characteristic | + | * ✓ Show |
| - | * Item editing | + | * Characteristic |
| - | * Item image | + | * ✓ Show |
| - | * Item image name | + | * Client |
| - | * Show item image name | + | * ✓ Show |
| - | * Show item | + | * Price |
| - | * Variation | + | * ✓ Show |
| - | * Barcode code | + | * ✓ Show |
| - | * Show code | + | * Sales price |
| - | * Category | + | * ✓ Show |
| - | * Show category link | + | * Unit |
| - | * Client | + | * ✓ Show |
| - | * Show client link | + | * Setup |
| - | * Edit attribute | + | * Property |
| - | * value_set | + | * Group |
| - | * Item characteristic | + | * ✓ Show |
| - | * Show item characteristic | + | * Selection |
| - | * Price | + | * ✓ Show |
| - | * Show price | + | * ✓ Show |
| - | * Show variation | + | * Plugins |
| - | * Sales price | + | * Configurations |
| - | * Show sales price | + | * ✓ Show |
| - | * Unit | + | |
| - | * Show unit | + | |
| - | * Setup | + | |
| - | * Property | + | |
| - | * Show property | + | |
| - | * Selection | + | |
| - | * Show selection | + | |
| - | ---- | + | ## Configuration of the API user |
| - | ==== Define default prices for the 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**. | |
| - | 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 [[support@findologic.com]] and tell us the correct IDs. We will setup the IDs in our backend in order to use the correct price for the visualisation, filter and sort functions. | + | * **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. | ||
| + | </markdown> | ||
| + | {{:integration_documentation:plugin:en:api:plentymarkets:data_sync_config.png?450|}} | ||
| + | <markdown> | ||
| - | ---- | + | ## Export configurations |
| - | ==== Configuration in the Findologic Account ==== | + | The export can be configured within the [Findologic Account](https://account.findologic.io/). |
| - | Please enter in your [[https://account.findologic.com/#/app/search-navigation/import-export|Findologic Account]]: | + |  |
| - | * **Export URL**: This URL is set automatically. You do not have to make changes here. | + | |
| - | * **CSV URL**: If you provide the shopdata via CSV for the download, please enter the URL here. If you do not provide a CSV, please leave this field empty.. | + | |
| - | * **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. | + | |
| - | {{:integration_documentation:plentymarkets_ceres_plugin:data_sync.png|800}} | + | ### Multi-shop ID |
| - | Afterwards click the ''Save''-button. | + | Please configure the corresponding Store ID from the Plentymarkets backend. |
| - | If you have troubles with the export please contact us at [[support@findologic.com|support@findologic.com]]. | + |  |
| - | ==== Export of variations ==== | + | ### 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 | ||
| Variations are merged to one product. They will only be exported if | Variations are merged to one product. They will only be exported if | ||
| + | * 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. | ||
| + | |||
| + | ## Exclusion tag | ||
| + | |||
| + | </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|}} | ||
| + | |||
| + | |||
| + | |||
| + | |||
| - | * 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. | ||