Dokumentation

Allgemein

Mit diesem Shopware 6 Plugin ist es möglich verschiedene Formen von Produktfeeds zu erstellen.

Unterstützte Dateiformate:

  • XML
  • CSV
  • TXT

Konfiguration

Template

Das Template ist ein twig Template(https://twig.symfony.com) mit dem es möglich ist, alle Anwendungsfälle abzudecken.
Es ist möglich Schleifen oder Bedingungen zu verwenden, um den Feed komplett auf die eigenen Anforderungen anzupassen.
Beim Erstellen eines Feeds werden verschiedene Standardtemplates zu dessen Erstellung angeboten.
 
Zur Erstellung eigener Vorlagen kann die twig Dokumentation, unter https://twig.symfony.com/doc/2.x/templates.html zu Rate gezogen werden.

Schleife:

				
					{% for product in products %}
  // do something
{% endfor %}
				
			

Bedingung:

				
					{% if product.availableStock > 0 %}
  // do something
{% else %}
  // do something else
{% endif %}
				
			

Variable ausgeben:

				
					{{ product.name }}
				
			

customField ausgeben:

				
					{{ product.customFields['custom_fields_active'] }}

{{ product.customFields['custom_fields_interesting'] }}

{{ product.customFields['custom_fields_gtin_text'] }}

{{ product.customFields['custom_fields_color'] }}
				
			

Variablen

Es sind verschiedenste Variablen möglich, die im Template verwendet werden können.

products

Liste aller Produkte. Kann mittels Filter angepasst werden.  
Diese Liste kann dann mit einer twig Schleife durchlaufen werden.  

Innerhalb eines Produktes können folgende Attribute verwendet werden:  
  • id
  • productNumber
  • stock
  • restockTime
  • autoIncrement
  • active
  • availableStock
  • available
  • isCloseout
  • variation
  • displayGroup
  • configurationGroupConfig
  • mainVariantId
  • variantRestrictions
  • manufacturerNumber
  • ean
  • purchaseSteps
  • maxPurchase
  • minPurchase
  • purchaseUnit
  • referenceUnit
  • shippingFree
  • purchasePrice
  • markAsTopseller
  • weight
  • width
  • height
  • length
  • releaseDate
  • ratingAverage
  • categoryTree
  • properties
  • options
  • tags
  • customFieldSetSelectionActive
  • sales
  • cheapestPrice
  • metaDescription
  • name
  • keywords
  • description
  • metaTitle
  • packUnit
  • packUnitPlural
  • customFields
  • deliveryTime
  • tax
  • manufacturer
  • unit
  • cover
  • featureSet
  • prices
  • media
  • crossSellings
  • crossSellingAssignedProducts
  • Liste
  • configuratiorSettings
  • visibilities
  • searchKeywords
  • productReviews
  • mainCategories
  • seoUrls
  • orderLineItems
  • options
  • properties
  • categories
  • streams
  • categoriesRo
  • tags
  • customFieldSets
  • customSearchKeywords
  • wishlists
  • canonicalProduct
  • cmsPage
  • slotConfig

Zusätzlich können alle Custom Properties des gewählten Shops verwendet werden.

categories

Liste aller Kategorien.

Innerhalb einer Kategorie können folgende Attribute verwendet werden: 

  • id
  • displayNestedProducts
  • autoIncrement
  • breadcrumb
  • level
  • path
  • type
  • productAssignmentType
  • visible
  • active
  • name
  • customFields
  • slotConfig
  • linkType
  • internalLink
  • externalLink
  • linkNewTab
  • description
  • metaTitle
  • metaDescription
  • keywords
  • media
  • products
  • nestedProducts
  • tags
  • cmsPage
  • productStream
  • navigationSalesChannels
  • footerSalesChannels
  • serviceSalesChannels
  • serviceSalesChannels
  • mainCategories
  • seoUrls

paymentMethods

Liste verfügbarer Bezahlmethoden.

salesChannel

Liste verfügbarer Verkaufskanäle.

shippingMethodPrice

Angabe des Versandpreises.

FTP / SFTP Zustellung

Es ist möglich die erstellen Feeds über FTP bzw. SFTP zu versenden.
Dazu muss ein Host, Username, Passwort und ein Verzeichnis angegeben werden.

Benachrichtigungen

Es ist möglich E-Mail Benachrichtigungen zu bestimmten Ereignissen zu erhalten.

E-Mail Adresse(n)

Wenn Benachrichtigungen angeschaltet sind, erhalten diese Mailadressen eine E-Mail für die konfigurierten Ereignisse.

Benachrichtungsevents

Es gibt vier Events zu denen man benachrichtigt werden kann:

  • Generieren erfolgreich
    • Wenn ein Feed erfolgreich erstellt wurde
  • Generieren fehlgeschlagen
    • Wenn ein Fehler aufgetreten ist, während ein Feed erstellt wurde
  • Versenden erfolgreich
    • Wenn das Versenden eines Feeds, über FTP oder SFTP, erfolgreich war
  • Versenden fehlgeschlagen
    • Wenn das Versenden eines Feeds, über FTP oder SFTP, fehlgeschlagen ist

Ausführmodus

Entscheidet wie und wann ein Feed erstellt wird.

Manuell

Wenn diese Option ausgewählt ist, werden Feeds nur manuell erstellt.

Cron

Cron steht für den Unix Dienst Cron(https://en.wikipedia.org/wiki/Cron)
Dieser Dienst ermögicht es, Programme in gegeben Zeitintervallen ausführen zu lassen.

Hiermit ist es möglich Feeds automatisch in gegebenen Zeitintervallen zu erstellen.
Das Zeitintervall lässt sich in Minuten, Stunden, Tagen oder Wochen angeben.

Filter

Filtert Produktliste nach den angegebenen Kriterien zur Aufnahme in den Feed.

Aktuell ist es möglich nach folgendem Attributen zu filtern:

  • Produkt Name
  • Produkt Id
  • Produkt Preis
  • Produkte innerhalb einer Kategorie
  • Kategorie Namen
  • Hersteller Name

Die oben angegebenen Bedingungen können in verschiedene „UND“ oder „ODER“ Container verschachtelt werden.