Skip to content

ShopwareSearchOrders - Shopware

Version: 5.2+

← Shopware Add-On Übersicht

Mit diesem Step können Sie Auftragsdaten aus einem Shopware System abrufen.

Step Konfiguration:

Input

Beschreibung

account

Wählen Sie hier Ihren Shopware-Account aus, um auf die Schnittstelle Ihres Shops zuzugreifen zu können (weitere Informationen)

limitOrders (optional)

Dieser Filter schränkt ein wie viele Aufträge abgerufen werden. Gerade während der Erstellung eines Flows ist es praktisch diesen Wert eher klein zu halten (z.B. 25), damit nur wenige Daten abgerufen werden und somit der Vorgang beschleunigt wird.

Default: 25

mode

Der ShopwareSearchOrders Step liefert im Standardmodus (All) eine große Menge von Informationen zu den Kunden zurück. Dies kann einen hohen Traffic und lange Laufzeiten verursachen. Um die Datenmenge möglichst gering zu halten, können Sie hier mit Hilfe von zwei Modi die abzurufenden Informationen auf ihre Bedürfnisse anpassen.

  • All - Es werden Auftragsköpfe inklusive der Auftragspositionen abgerufen
  • Minimum - Es werden lediglich die Kopfdaten der Aufträge abgeholt

Die weiteren Felder sind: InternalComment, Net, TaxFree, TemporaryId, Referer, ClearedDate, TrackingCode, LanguageIso, Currency, CurrencyFactor, RemoteAddress, PaymentStatusId, OrderStatusId

Default: All

orderStatusId (optional)

Dieser Filter kann genutzt werden, um nur Angebote in einem bestimmten Status abzuholen. Wird kein Wert eingetragen, werden die Aufträge unabhängig vom Status abgerufen.

referer (optional)

Sie haben die Möglichkeit nach Aufträgen mit bestimmten referern filtern.

paymentId (optional) Tragen Sie hier eine Payment ID ein, um nur nach Aufträgen mit einer bestimmten Zahlmethode zu suchen.
shopId (optional)

Tragen Sie hier eine Shop ID ein, um nur nach Aufträgen dieses Shops zu suchen.

Default: leer | Beispiel: 1

orderId (optional)

Erlaubt den Abruf eines einzelnen Auftrags anhand der Shopware Auftrags ID. Vor allem beim Testen sehr praktisch.

Default: leer | Beispiel: 15

orderNumber (optional)

Erlaubt den Abruf eines einzelnen Auftrags anhand der Auftragsnummer (kann in Shopware selbst gesetzt werden). Vor allem beim Testen sehr praktisch.

Default: leer | Beispiel: 2001

orderTimeFrom (optional) Mit diesem Filter kann gesteuert werden, ab welchem Datum an die Aufträge abgeholt werden sollen. (Startdatum)


orderTimeTo (optional) Dieser Filter steuert, bis zu welchem Datum Aufträge abgerufen werden. (Enddatum)

Beispiel für die Ausgabe des Steps im Modus “All” (gekürzt):

weitere übertragene Felder:

CustomerComment, InternalComment, Net, TaxFree, TemporaryId, Referer, ClearedDate, TrackingCode, LanguageIso, Currency, CurrencyFactor, RemoteAddress, PaymentStatusId,
OrderStatusId, 

BillingId, BillingCompany, BillingDepartment, BillingSalutation, BillingNumber, BillingFirstName, BillingLastName, BillingStreet, BillingStreetNumber, BillingZipCode, BillingCity, BillingPhone,
BillingFax, BillingVatId, BillingCountryId, BillingCountryIso, BillingCountryName, BillingCountryIso3, OrderBillingOrderId, BillingAttr1, BillingAttr2, BillingAttr3, BillingAttr4, BillingAttr5, BillingAttr6, 

ShippingId, ShippingCompany, ShippingDepartment, ShippingSalutation, ShippingNumber, ShippingFirstName, ShippingLastName, ShippingStreet, ShippingStreetNumber, ShippingZipCode, ShippingCity, ShippingPhone, ShippingFax, ShippingVatId, ShippingCountryId, ShippingCountryIso, ShippingCountryName, ShippingCountryIso3, OrderShippingOrderId, ShippingAttr1, ShippingAttr2, ShippingAttr3, ShippingAttr4, ShippingAttr5, ShippingAttr6,

OrderCustomerConfirmationKey, OrderCustomerEmail, OrderCustomerReferer, OrderCustomerGroupKey, OrderCustomerActive, OrderCustomerLanguageId, OrderCustomerPriceGroupId, OrderCustomerShopId, OrderStatusDescription, OrderStatusGroup, OrderStatusPosition, OrderStatusSendMail, OrderPaymentAction, OrderPaymentDescription, OrderPaymentName,
OrderPaymentActive, OrderPaymentDebitPercent, OrderPaymentId, OrderPaymentPosition, OrderPaymentSurcharge, OrderItemId, OrderItemArticleNumber, OrderItemTaxId, OrderItemTaxRate,

OrderItemStatusId, OrderItemPrice, OrderItemQuantity, OrderItemArticleName, OrderItemShipped, OrderItemShippedGroup, OrderItemReleaseDate, OrderItemMode, OrderItemESDArticle,
OrderItemConfig, OrderItemAttributes1, OrderItemAttributes2, OrderItemAttributes3, OrderItemAttributes4, OrderItemAttributes5, OrderItemAttributes6

Ein Flow zum abrufen von Shopware Bestellungen könnte so aufgebaut sein:

“ShopwareSearchOrders” ruft Bestellungen aus einem Shopware System ab und gibt als Resultat ein Spreadsheet mit allen Daten zurück. Dieses Spreadsheet kann mit dem “SpreadsheetCSVWriter” in eine Datei (z.B. CSV) umgewandelt werden. Anschließend wird diese Datei mit dem “FTPUpload” Step auf einen FTP-Server abgelegt und kann so z.B. in einer externen Warenwirtschaft weiterverarbeitet werden.


Inputs

Das sind die Optionen, mit denen man den Step konfigurieren kann.

Name Datentyp Beschreibung Pflichtfeld Werte
account ACCOUNT Die Shopware-Verbindung Ja
limitOrders STRING Begrenzt die Anzahl der Bestellungen die abgerufen werden sollen. Leer für unbegrenzt. Nein
mode STRING Angabe wie viele Informationen abgerufen werden. Ja
  • Alle
  • Minimum
orderStatusId STRING Filter für Bestellstatus (ID) Nein
referer STRING Filter Herkunft. Nein
partnerId STRING Filter Partner (ID). Nein
paymentId STRING Filter Zahlungsart (ID) Nein
paymentStatusId STRING Filter Zahlungsstatus(ID) Nein
shopId STRING Filter Shop-ID Nein
orderId STRING Filter für eine Bestell-ID Nein
orderNumber STRING Filter für eine Bestellnummer Nein
orderTimeFrom DATETIME Verwenden Sie dieses Datum, um Aufträge zu filtern die später erstellt wurden, 2014-02-27 00:00:00 Nein
orderTimeTo DATETIME Verwenden Sie dieses Datum, um Aufträge zu filtern, die zuvor angelegt wurden, z.B. 2014-02-28 00:00:00 Nein
showCanceledOrders STRING Wählen sie aus ob abgebrochene Bestellungen im Ergebnis ausgegeben werden sollen. Nein
  • Nein
  • Ja

Outputs

Das sind die Ergebnisse des Steps, die von nachfolgenden Steps, nach der Ausführung verwendet werden können.

Name Datentyp Beschreibung Pflichtfeld Werte
orders SPREADSHEET Ein SPREADSHEET dass die abgerufenen Bestellungen enthält Ja