integration_documentation:plugin:en:integration:shopware_5

integration_documentation:plugin:en:integration:shopware_5

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
Next revision Both sides next revision
integration_documentation:plugin:en:integration:shopware_5 [2021/01/25 14:13]
dominik created
integration_documentation:plugin:en:integration:shopware_5 [2021/12/02 17:26]
daniel
Line 5: Line 5:
 ==== Download from Shopware store ==== ==== Download from Shopware store ====
   * [[https://​store.shopware.com/​en/​fin1848466805161f/​findologic-search-navigation-platform.html|Findologic - Search & Navigation Platform]]   * [[https://​store.shopware.com/​en/​fin1848466805161f/​findologic-search-navigation-platform.html|Findologic - Search & Navigation Platform]]
- 
----- 
  
 ==== Installation ==== ==== Installation ====
Line 14: Line 12:
     * Activate the plugin.     * Activate the plugin.
  
----- +==== Configuration ​====
- +
-==== Plugin configuration ​====+
  
 In the plugin manager open the configuration by clicking on the pen icon. In the plugin manager open the configuration by clicking on the pen icon.
Line 31: Line 27:
   * **Findologic Test:** 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.   * **Findologic Test:** 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.
  
----- 
  
 ==== Findologic Staging mode ==== ==== Findologic Staging mode ====
Line 58: Line 53:
 ---- ----
  
-==== Run export ====+===== Product ​export ​=====
  
-The export ​can be triggered by URL in your browser:+==== Default ​export ​====
  
-<​code>​ +Please see [[integration_documentation:​plugin:​en:​integration:​shopware_5:​export_information|Shopware 5 - Export information]] to get an overview which values are exported by default and where they can be found in your Shopware 5 backend. 
-https://<​SHOP_URL>/​findologic?​shopkey=<​SHOP_KEY>&​start=<​NUMBER>&​count=<​NUMBER>​ + 
-</​code>​+==== Trigger product export ==== 
 + 
 +The export can be called with 
 + 
 +<​code>​https://<​SHOP_URL>/​findologic?​shopkey=<​SHOP_KEY>&​start=<​NUMBER>&​count=<​NUMBER></​code>​
  
-  * **shopkey:​** ​API key provided by Findologic +  * **shopkey:​** ​<​SHOPKEY> ​provided by Findologic 
-  * **start:​** ​number ​that should not be lower than zero +  * **start:​** ​<​NUMBER> ​that should not be lower than zero, default: 0. 
-  * **count:​** ​number ​that should ​not lower than zero and “start” number+  * **count:​** ​<​NUMBER> ​that should ​be higher ​than zero, default: 20.
  
-This export url has to be set in the Findologic Account ​[[https://​account.findologic.com/#/​app/​search-navigation/​import-export|Settings]], see [[customer_account:​import-export|documentation]].+This export url should ​be used automatically ​in the [[https://​account.findologic.com/#/​app/​search-navigation/​import-export|Findologic Account]] for the data sync, see [[customer_account:​import-export|documentation]].
  
 Products are going to be exported when: Products are going to be exported when:
Line 110: Line 109:
 ==== Integration of Smart Did-You-Mean ==== ==== Integration of Smart Did-You-Mean ====
  
-See [[integration_documentation:​plugins:​shopware_smart_did_you_mean|documentation]].+See [[integration_documentation:​plugins:​shopware_smart_did_you_mean|Customize Smart Did-You-Mean in Shopware 5]].
  
-==== Export customization ====+----
  
 +
 +==== Export customization ====
 The plugin can be extended by following the [[https://​developers.shopware.com/​developers-guide/​plugin-extension-by-plugin/​|Shopware plugin system standard]]. All important classes are registerd as services. Findologic provides a boilerplate plugin ​ [[https://​github.com/​findologic/​plugin-shopware-5-extension|plugin-shopware-5-extension]] which can be copied and used as a quickstart to customize the export. The plugin can be extended by following the [[https://​developers.shopware.com/​developers-guide/​plugin-extension-by-plugin/​|Shopware plugin system standard]]. All important classes are registerd as services. Findologic provides a boilerplate plugin ​ [[https://​github.com/​findologic/​plugin-shopware-5-extension|plugin-shopware-5-extension]] which can be copied and used as a quickstart to customize the export.
 +
 +=== Variant export for Direct Integration ===
 +The extension plugin already includes the code to export product variants in a JSON property, see
 +[[https://​github.com/​findologic/​plugin-shopware-5-extension/​blob/​main/​ExtendFinSearchUnified/​BusinessLogic/​Models/​FindologicArticleModel.php|FindologicArticleModel::​addVariantsJson()]]
 +
 +Please modify it to match your use case.
  
 ---- ----