integration_documentation:shopware_6_app
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
integration_documentation:shopware_6_app [2022/12/15 14:16] rihad created |
integration_documentation:shopware_6_app [2022/12/20 11:46] (current) rihad [Default export] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | <markdown> | + | {{:sw6-logo.jpg?400|}} |
| - |  | + | |
| - | # Shopware 6 App integration - EN | + | ====== Shopware 6 App integration - EN ====== |
| - | ## Download from Shopware store | + | ===== Download from Shopware Store ===== |
| - | * [Findologic - Search and Navigation Platform](https://store.shopware.com/en/fin6494960032131f/findologic-search-navigation-platform.html) | + | |
| - | ## Installation | + | [[https://store.shopware.com/en/fin5457614063939f/findologic-search-product-discovery-platform.html|Findologic - Search & Product Discovery Platform ]] |
| - | 1. Go to *Extensions → FINDOLOGIC App - configuration*. | + | ===== Installation ===== |
| - | {{:app_open_configuration.png?400|}} | + | 1. Go to Extensions → FINDOLOGIC App - Configuration |
| - | 2. Click on *Open extension* | + | {{:app_open_configuration.png?1200|}} |
| + | 2. Open the Extension | ||
| + | 3. Select your sales channel and language | ||
| - | 4. Select your sales channel and language | + | {{:app_select_channel.png?1200|}} |
| - |  | + | 4. Insert required configuration |
| - | 5. Insert required configuration | + | {{:app_configuration.png?1200|}} |
| - |  | + | 5. Accept the relevant App permissions |
| + | {{:app_permissions_big.png?1200|}} | ||
| - | ## Configuration | + | <note important>System config: View, Edit, Create and Delete permissions are required</note> |
| - | #### Basic | + | ===== Configuration ===== |
| - | * **Shopkey:** Enter the shopkey provided by Findologic - **required** | + | |
| - | * **Active:** Activate to enable Findologic search for your shop - **required** | + | |
| - | * **Test mode:** This button is shown when the Findologic integration is still in staging mode. Clicking the button will redirect you to the shop frontend, where Findologic can be tested. Please be aware that a successful product export must happen before the test mode can be used. | + | |
| - | #### Export | + | === Basic === |
| - | * **Export products without price:** Products with a price of 0 are not exported by default. | + | |
| - | * **Considered advanced pricing:** Define what type of advanced price should be exported, or non at all. | + | |
| - | * **Exported main variant:** Define what type of product should be considered as main product. | + | |
| - | * **Cross-Selling categories:** Products in these categories are excluded from the export. If you have multiple subcategories in your Cross-Selling category, make sure to add all subcategories. | + | |
| - | #### Direct Integration / Instant Frontend | + | * Shopkey: Enter the shopkey provided by Findologic - **required** |
| - | * **CSS Selector for search results:** Configure the selector for the flicker-free effect on search pages. For Instant Frontend, configure the same selector as in the [Findologic Account](https://account.findologic.io). | + | * Active: Activate to enable Findologic search for your shop - **required** |
| - | * **CSS Selector for search results:** Configure the selector for the flicker-free effect on navigation pages. For Instant Frontend, configure the same selector as in the [Findologic Account](https://account.findologic.io). | + | |
| - | + | ||
| - | #### API only | + | |
| - | * **Active on category pages:** Activate Findologic on navigation pages. | + | |
| - | * **Filter position for search result pages:** The Findologic filters can be placed either on the top or on the left side of the search result. | + | |
| - | After setting the configuration press the **Save** button on the top right corner. | + | === Instand Frontend === |
| - | ## Product export | + | * **CSS Selector for search results**: Configure the same selector as in the [[https://account.findologic.io/#/instant-frontend/product-list-page|Findologic Account]] |
| + | * **CSS Selector for navigation**: Configure the same selector as in the [[https://account.findologic.io/#/instant-frontend/product-list-page|Findologic Account]] | ||
| - | ### Default export | + | === Export === |
| - | Please see [Shopware 6 - Export information](https://docs.findologic.com/doku.php?id=integration_documentation:plugin:en:integration:shopware_6:export_information) to get an overview which values are exported by default and where they can be found in your Shopware 6 backend. | + | * **Exported main variant**: Define what type of product should be considered as main product. |
| + | * **Cross-Selling categories**: Products in these categories are excluded from the export. If you have multiple subcategories in your Cross-Selling category, make sure to add all subcategories. | ||
| - | ### Trigger product export | ||
| - | The export can be called with: | + | ===== Product export ===== |
| - | `<SHOP-URL>/findologic?shopkey=<SHOPKEY>&start=<NUMBER>&count=<NUMBER>` | + | |
| + | ==== Default export ==== | ||
| + | |||
| + | Please see [[integration_documentation:plugin:en:integration:shopware_6:export_information|Shopware 6 - Export information]] to get an overview which values are exported by default and where they can be found in your Shopware 6 backend. | ||
| + | |||
| + | === Trigger product export === | ||
| + | |||
| + | The export can be called with: | ||
| + | |||
| + | <code>https://shopware-app.findologic.com/export?shopkey=<SHOPKEY>&start=<NUMBER>&count=<NUMBER></code> | ||
| * **shopkey:** <SHOPKEY> provided by Findologic | * **shopkey:** <SHOPKEY> provided by Findologic | ||
| Line 64: | Line 63: | ||
| * **count:** <NUMBER> that should be higher than zero, default: 20. | * **count:** <NUMBER> that should be higher than zero, default: 20. | ||
| - | This export url is used automatically in the [Findologic Account](https://account.findologic.com/#/app/search-navigation/import-export) for the data sync, see [documentation](https://docs.findologic.com/doku.php?id=customer_account:import-export). | + | === Export specific product === |
| - | ### Export specific product | + | For testing purposes the export can be called for a specific product: |
| - | For testing purposes the export can be called for a specific product: | + | <code>https://shopware-app.findologic.com/findologic?shopkey=<SHOPKEY>&productId=<PRODUCT_ID></code> |
| - | `<SHOP-URL>/findologic?shopkey=<SHOPKEY>&productId=<PRODUCT_ID>` | + | |
| * **shopkey:** <SHOPKEY> provided by Findologic. | * **shopkey:** <SHOPKEY> provided by Findologic. | ||
| * **productId:** <PRODUCT_ID> is a 32 digit hex value created by Shopware. | * **productId:** <PRODUCT_ID> is a 32 digit hex value created by Shopware. | ||
| - | ### Debug specific product | + | === Debug specific product === |
| - | For testing and debugging purposes, the export information of a product can be called directly: | + | For testing and debugging purposes, the export information of a product can be called directly: |
| - | `<SHOP-URL>/findologic/debug?shopkey=<SHOPKEY>&productId=<PRODUCT_ID>` | + | |
| + | <code>https://shopware-app.findologic.com/findologic/debug?shopkey=<SHOPKEY>&productId=<PRODUCT_ID></code> | ||
| * **shopkey:** <SHOPKEY> provided by Findologic. | * **shopkey:** <SHOPKEY> provided by Findologic. | ||
| Line 97: | Line 96: | ||
| * **associations:** All associations used for requesting the product from the database. | * **associations:** All associations used for requesting the product from the database. | ||
| - |  | + | {{:integration_documentation:plugin:en:integration:export_debug_example.png?1200|}} |
| - | </markdown> | ||
| If you have troubles with the export please contact us at [[support@findologic.com|support@findologic.com]]. | If you have troubles with the export please contact us at [[support@findologic.com|support@findologic.com]]. | ||
| - | <markdown> | ||
| - | The generated XML is validated against our predefined [XSD scheme](https://raw.githubusercontent.com/Findologic/xml-export/master/src/main/resources/Findologic.xsd) and built with our export library [libflexport](https://github.com/Findologic/libflexport). | ||
| - | |||
| - | ## Plugin extension | ||
| - | |||
| - | To extend the default behavior of the Findologic main plugin and still be able to get the latest plugin updates, we've created the [Findologic extension plugin](https://github.com/findologic/plugin-shopware-6-extension). It already contains some code for extending the export logic, but you can also extend the plugin to override search logic, or even the templates of filters. | ||
| - | |||
| - | For detailed information on how to use the extension and code examples, please see [Shopware 6 plugin extension](https://docs.findologic.com/doku.php?id=integration_documentation:plugin:en:integration:shopware_6:extension) | ||
| - | |||
| - | --- | ||
| - | |||
| - | ## Upgrade information | ||
| - | |||
| - | Breaking changes to the main plugin will only be released in major releases (e.g. 3.x.x => 4.x.x) and a respective `UPGRADE-x.x` guide can be found at [GitHub](https://github.com/findologic/plugin-shopware-6). | ||
| - | |||
| - | </markdown> | ||
| - | |||