ShopwareSearchOrders - Shopware

Version: 6.4.0.0 - 6.4.20.x

← 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

Anwendungsbeispiel:

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	Ihre Shopware 6 Verbindung	Ja
limit	STRING	Begrenzen Sie die Anzahl der abgerufen Bestellungen. Leer für unbegrenzt.	Nein
orderNumber	STRING	Dieser Filter schränkt das Ergebnis auf die Bestellung mit der angegebenen Nummer ein.	Nein
orderId	STRING	Dieser Filter schränkt das Ergebnis auf die Bestellung mit der angegebenen ID ein.	Nein
salesChannelId	STRINGLIST	Dieser Filter schränkt das Ergebnis auf Bestellungen des gewählten Verkaufskanals ein. Wenn kein Wert ausgewählt ist, werden alle Kanäle abgerufen.	Nein
orderStatusId	STRINGLIST	Dieser Filter schränkt das Ergebnis auf Bestellungen mit diesem Bestellstatus ein. Wenn kein Wert ausgewählt ist, werden alle Status abgerufen.	Nein
paymentId	STRINGLIST	Dieser Filter schränkt das Ergebnis auf Bestellungen mit diesem Zahlungsstatus ein. Wenn kein Wert ausgewählt ist, werden alle Status abgerufen.	Nein
deliveryId	STRINGLIST	Dieser Filter schränkt das Ergebnis auf Bestellungen mit diesem Lieferstatus ein. Wenn kein Wert ausgewählt ist, werden alle Status abgerufen.	Nein
autoIncrementFrom	NUMBER	Verwenden Sie diesen Filter, um alle Aufträge mit einer AutoIncrement-ID zu erhalten, die gleich oder größer als dieser Wert ist.	Nein
autoIncrementTo	NUMBER	Verwenden Sie diesen Filter, um alle Aufträge mit einer AutoIncrement-ID zu erhalten, die gleich oder kleiner als dieser Wert ist.	Nein
createdFrom	DATETIME	Verwenden Sie diesen Filter, um Aufträge zu abzurufen, die nach diesem Datum erstellt wurden, z.B. 2020-03-27 00:00.	Nein
createdTo	DATETIME	Verwenden Sie diesen Filter, um Aufträge zu abzurufen, die vor diesem Datum erstellt wurden, z.B. 2020-03-28 00:00.	Nein
updatedFrom	DATETIME	Verwenden Sie diesen Filter, um Aufträge zu abzurufen, die nach diesem Datum aktualisiert wurden, z.B. 2020-03-27 00:00.	Nein
updatedTo	DATETIME	Verwenden Sie diesen Filter, um Aufträge zu abzurufen, die vor diesem Datum aktualisiert wurden, z.B. 2020-03-28 00:00.	Nein

Outputs

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

Name	Datentyp	Beschreibung	Pflichtfeld	Werte
result	SPREADSHEET	Das Ergebnis SPREADSHEET mit den abgerufenen Bestellungen	Ja
	Folgende Felder sind im Output enthalten : Feld Datentyp Beschreibung Pflichtfeld Standardwert identifier SINGLE The identifier column to import Spreadsheet into a Datastore. Nein Id SINGLE Nein OrderNumber SINGLE Nein VersionId SINGLE Nein AutoIncrement SINGLE Nein CreatedAt SINGLE Nein UpdatedAt SINGLE Nein UpdatedById SINGLE Nein OrderDateTime SINGLE Nein BillingAddressId SINGLE Nein BillingAddressCountryId SINGLE Nein BillingAddressCountryStateId SINGLE Nein BillingAddressSalutationId SINGLE Nein BillingAddressFirstName SINGLE Nein BillingAddressLastName SINGLE Nein BillingAddressStreet SINGLE Nein BillingAddressZipcode SINGLE Nein BillingAddressCity SINGLE Nein BillingAddressCompany SINGLE Nein BillingAddressDepartment SINGLE Nein BillingAddressTitle SINGLE Nein BillingAddressVatId SINGLE Nein BillingAddressPhoneNumber SINGLE Nein BillingAddressAdditionalAddressLine1 SINGLE Nein BillingAddressAdditionalAddressLine2 SINGLE Nein BillingAddressCreatedAt SINGLE Nein BillingAddressUpdatedAt SINGLE Nein ShippingAddressId SINGLE Nein ShippingAddressCountryId SINGLE Nein ShippingAddressCountryStateId SINGLE Nein ShippingAddressSalutationId SINGLE Nein ShippingAddressFirstName SINGLE Nein ShippingAddressLastName SINGLE Nein ShippingAddressStreet SINGLE Nein ShippingAddressZipcode SINGLE Nein ShippingAddressCity SINGLE Nein ShippingAddressCompany SINGLE Nein ShippingAddressDepartment SINGLE Nein ShippingAddressTitle SINGLE Nein ShippingAddressVatId SINGLE Nein ShippingAddressPhoneNumber SINGLE Nein ShippingAddressAdditionalAddressLine1 SINGLE Nein ShippingAddressAdditionalAddressLine2 SINGLE Nein ShippingAddressCreatedAt SINGLE Nein ShippingAddressUpdatedAt SINGLE Nein CurrencyId SINGLE Nein CurrencyFactor SINGLE Nein LanguageId SINGLE Nein SalesChannelId SINGLE Nein PriceNetPrice SINGLE Nein PricePositionPrice SINGLE Nein PriceTotalPrice SINGLE Nein PriceRawTotal SINGLE Nein PriceTaxStatus SINGLE Nein PriceTaxRulesTaxRate SINGLE Nein PriceTaxRulesPercentage SINGLE Nein PriceCalculatedTaxTax SINGLE Nein PriceCalculatedTaxTaxRate SINGLE Nein PriceCalculatedTaxPrice SINGLE Nein AffiliateCode SINGLE Nein AmountTotal SINGLE Nein AmountNet SINGLE Nein PositionPrice SINGLE Nein TaxStatus SINGLE Nein DeepLinkCode SINGLE Nein CampaignCode SINGLE Nein Source SINGLE Nein ShippingCostUnitPrice SINGLE Nein ShippingCostTotalPrice SINGLE Nein ShippingCostQuantity SINGLE Nein ShippingCostCalculatedTaxesTax SINGLE Nein ShippingCostCalculatedTaxesTaxRate SINGLE Nein ShippingCostCalculatedTaxesPrice SINGLE Nein ShippingCostTaxRulesTaxRate SINGLE Nein ShippingCostTaxRulesPercentage SINGLE Nein CustomFields MAP Nein StateId SINGLE Nein StateName SINGLE Nein StateTechnicalName SINGLE Nein StateStateMachineId SINGLE Nein StateCreatedAt SINGLE Nein StateUpdatedAt SINGLE Nein CustomerId SINGLE Unique identity of order customer. Nein CustomerEmail SINGLE Email address of the customer. Nein CustomerSalutationId SINGLE Unique identity of salutation. Nein CustomerFirstName SINGLE First name of the customer. Nein CustomerLastName SINGLE Last name of the customer. Nein CustomerTitle SINGLE Title name given to the customer like Dr, prof. etc. Nein CustomerCompany SINGLE Name of the company. Nein CustomerCustomerNumber SINGLE Unique number assigned to the customer. Nein CustomerCustomerId SINGLE Unique identity of customer. Nein CustomerVatIds MULTIPLEVALUE Unique identity of VAT. Nein CustomerCreatedAt SINGLE Nein CustomerUpdatedAt SINGLE Nein CustomerComment SINGLE Nein TransactionsId SINGLE Nein TransactionsPaymentMethodId SINGLE Nein TransactionsCreatedAt SINGLE Nein TransactionsUpdatedAt SINGLE Nein TransactionsStateId SINGLE Nein TransactionsStateName SINGLE Nein TransactionsStateTechnicalName SINGLE Nein TransactionsStateStateMachineId SINGLE Nein TransactionsStateCreatedAt SINGLE Nein TransactionsStateUpdatedAt SINGLE Nein DeliveriesId SINGLE Unique identity of Order's delivery. Ja DeliveriesShippingOrderAddressId SINGLE Unique identity of order's shipping address. Nein DeliveriesShippingMethodId SINGLE Unique identity of shipping method. Nein DeliveriesTrackingCodes MULTIPLEVALUE The delivery tracking codes as semicolon separated list. Nein DeliveriesCreatedAt SINGLE Nein DeliveriesUpdatedAt SINGLE Nein DeliveriesStateId SINGLE Nein DeliveriesStateName SINGLE Nein DeliveriesStateTechnicalName SINGLE Nein DeliveriesStateStateMachineId SINGLE Nein DeliveriesStateCreatedAt SINGLE Nein DeliveriesStateUpdatedAt SINGLE Nein DeliveriesShippingDateEarliest SINGLE Nein DeliveriesShippingDateLatest SINGLE Nein ItemDatastoreIdentifier SINGLE Nein ItemId SINGLE Unique identity of OrderLineItem. Nein ItemType SINGLE Type refers to the entity type of an item whether it is product or promotion for instance. Nein parent_identifier SINGLE The parent_identifier column to import Spreadsheet into a Datastore. Nein ItemOrderId SINGLE Unique identity of order. Nein ItemPosition SINGLE Position of line items placed in an order. Nein ItemIdentifier SINGLE It is a unique identity of an item in cart before its converted to an order. Nein ItemProductId SINGLE Unique identity of product. Nein ItemReferencedId SINGLE Unique identity of type of entity. Nein ItemQuantity SINGLE Number of items of product. Nein ItemLabel SINGLE It is a typical product name given to the line item. Nein ItemDescription SINGLE Description of line items in an order. Nein ItemGood SINGLE When set to true, it indicates the line item is physical else it is virtual. Nein ItemRemovable SINGLE Allows the line item to be removable from the cart when set to true. Nein ItemCoverId SINGLE Unique identity of cover image. Nein ItemStackable SINGLE Allows to change the quantity of the line item when set to true. Nein ItemPriceUnitPrice SINGLE Price of product per item (where, quantity=1). Nein ItemPriceQuantity SINGLE Number of items of each product. Nein ItemPriceTotalPrice SINGLE Cost of product based on quantity. Nein ItemPriceTaxRulesTaxRate SINGLE Nein ItemPriceTaxRulesPercentage SINGLE Nein ItemPriceCalculatedTaxesTax SINGLE Nein ItemPriceCalculatedTaxesTaxRate SINGLE Nein ItemPriceCalculatedTaxesPrice SINGLE Nein ItemPriceListPricePrice SINGLE List Price of each line item. Nein ItemPriceListPriceDiscount SINGLE Absolute discount on each line item. Nein ItemPriceListPricePercentage SINGLE Discount in percentage. Nein ItemPriceIsCalculated SINGLE Nein ItemPriceDefinitionPrice SINGLE Nein ItemPriceDefinitionQuantity SINGLE Nein ItemPriceDefinitionIsCalculated SINGLE Nein ItemPriceDefinitionPrecision SINGLE Nein ItemPriceDefinitionType SINGLE Nein ItemPayloadProductNumber SINGLE Nein ItemPayloadProductId SINGLE Nein ItemPayloadAddBackToStock SINGLE Nein ItemPayloadCredited SINGLE Nein ItemCustomFields MAP Nein ItemCreatedAt SINGLE Nein ItemUpdatedAt SINGLE Nein