Shopify
Wichtige Informationen
Unsere Schnittstelle zwischen Shopify und Afterbuy tauscht bidirektional Produktdaten, Bestellungen und Versanddaten aus. Im folgenden gehen wir genauestens auf die Funktionen der Middleware ein, sodass Sie jederzeit alle Infos rund um die Lösung zur Hand haben. Zu Beginn der Integration gehen wir immer unverbindlich und persönlich mit Ihnen ins Detail, um die Integration zu besprechen und die passende Lösung für Ihren Use Case zu finden.
Onboarding Termin buchenGrundvoraussetzungen für die Schnittstelle
- Shopify Shop (mit dem "Shopify Grow" Plan oder höher)
- Afterbuy Account
- Eine bestellte Afterbuy Schnittstelle (Shop & XML)
Prozess der Integration
- Shopify Onlineshop aufsetzen und einrichten
- Onboarding Meeting buchen und Integration im Detail besprechen
- AV Vertrag im Sinne der DSGVO & SEPA Mandat mit uns schließen
- Zugangsdaten ins Dashboard eintragen
- Gemeinsames Testing der Schnittstelle
- Erfolgreich Shopify und Afterbuy verbinden!
Shopify Shop
Ein professionell eingerichteter Shopify Onlineshop ist die Basis für eine erfolgreiche Schnittstellenanbindung. Der Shop kann noch in der Entwicklung sein oder bereits aktiv verkaufen. Unsere Integration geht von Afterbuy als führendem System aus, sodass die Produktdaten von Afterbuy zu Shopify übertragen und aktualisiert werden. Bereits bestehende Produkte werden auf Basis der identischen SKU aktualisiert und die Angebote somit übernommen. Wenn Sie Unterstützung bei der Einrichtung und Entwicklung Ihres Shopify Shops benötigen, stehen wir Ihnen als zertifizierter Shopify Partner gern zur Verfügung.
Voraussetzungen
Damit die Schnittstelle sauber arbeiten kann, benötigt diese in der Shopify Private App die folgenden Admin API-Zugriffsbereiche:
write_products/read_productswrite_orders/read_ordersread_locationswrite_merchant_managed_fulfillment_orders/read_merchant_managed_fulfillment_orderswrite_third_party_fulfillment_orders/read_third_party_fulfillment_orderswrite_inventory/read_inventorywrite_publications/read_publications
Sollte es sich bei dem Funktionsumfang der Schnittstelle lediglich um den Bestellimport handeln, werden die Berechtigungen write_products, read_locations, write_inventory, read_inventory, write_publications und read_publications nicht benötigt.
Funktionen
Die Schnittstelle beinhaltet in der Vollversion 4 Datentransfers, die dafür sorgen, dass der Shopify Shop wie ein weiterer Marktplatz direkt aus Afterbuy gesteuert und bedient werden kann.
- Produktdaten aus Afterbuy zu Shopify übertragen (alle 15 Minuten, 1x täglich vollständiger Abgleich)
- Bestände & Preise aus Afterbuy zu Shopify übertragen (alle 5 Minuten, 1x täglich vollständiger Abgleich)
- Bestellungen aus Shopify zu Afterbuy importieren (in Echtzeit per Webhook)
- Versanddaten aus Afterbuy zu Shopify exportieren (alle 15 Minuten)
Afterbuy- Account & Schnittstelle
Auf der Afterbuy Seite wird ein Account benötigt, der bereits aktiv ist. Anschließend muss dann eine Schnittstelle bei Afterbuy bestellt werden, damit wir von außen mit dem System kommunizieren können. Wir benötigen in einer bestellten Schnittstelle die Endpunkt „Shop & XML“ zusammengefasst. Es wird eine bestellte Afterbuy Schnittstelle ausschließlich für die Shopify Anbindung benötigt. Der Name der bestellten Schnittstelle muss "Shopify" oder "Shop" sein. Selbstverständlich unterstützen wir Sie bei Bedarf bei der Einrichtung.
Ihr persönliches Dashboard
Nach erfolgreichem Onboarding und zu Beginn der Integration erhalten Sie Zugang zu Ihrem persönlichen Dashboard. Hier können Sie später einen ausführlichen Log zu Ihrer Schnittstelle einsehen, Zugangsdaten verwalten und die letzten Prozesse und erfolgten Datentransfers einsehen.
Das Dashboard ist Ihr erster Anlaufpunkt, um sämtliche Informationen zu Ihrer persönlichen Integration einzusehen und zu verwalten.
Über den Menüpunkt "Ausführen" in Ihrem persönlichen Dashboard können Sie die einmalige Übertragung bzw. Aktualisierung eines Produktes auf Basis der Afterbuy Produkt ID auslösen und den zugehörigen Request sowie die Response beider Systeme einsehen. Bestellungen können Sie ebenfalls erneut importieren, indem Sie die Shopify Order ID (diese steht in der URL, wenn Sie eine Bestellung aufrufen) eingeben, auch hier steht Ihnen der jeweilige Request sowie die Response beider Systeme zur Verfügung.
Sobald Sie alle Zugangsdaten in dem Dashboard hinterlegt haben, startet die Lösung und mit dem nächsten Intervall werden alle Datentransfers angestoßen und auch alle Produkte, die für uns freigegeben sind, übertragen bzw. im Shopify Shop aktualisiert.
FAQ
Wo ist mein Zugang?
Den Zugang erhalten Sie von uns nach erfolgreichem Onboarding und Anzahlung der Lösung sowie der Unterschrift des AV Vertrags & SEPA Mandats. Mit dieser Einladung können Sie dann Ihr Dashboard aufrufen, Ihr Passwort festlegen und mit den Vorbereitungen starten.
Wie kann ich das Passwort zurücksetzen?
Das Passwort könne Sie bequem zurücksetzen, wenn Sie auf der Login Seite sind. Hier einfach „Passwort vergessen?“ Klicken, die eigene Mailadresse angeben und über die gesendete Mail ein neues Passwort festlegen.
Wie kann ich die Konfiguration durchführen?
Die Konfiguration können Sie mit Klick auf den aktuellen Status nach erfolgreichem Login durchführen. Den Status Ihrer Schnittstelle finden Sie ganz oben, Sie werden hier bei Bedarf auch aufgefordert, die Konfiguration durchzuführen.
Wo sollen die Daten eingetragen werden?
Die Datenfelder sind nach Klick auf die Konfiguration vorgefertigt. Hier ist dann die Afterbuy Schnittstelle relevant, um die Integration auf Seiten von Afterbuy vorzubereiten. Um Shopify zu verbinden, muss eine Shopify Custom App direkt im Shop erstellt werden. Anschließend werden die erhaltenen Zugangsdaten dann im Dashboard hinterlegt.
Wie kann die Verbindung widerrufen werden?
Wenn Sie oben auf Ihre Konfiguration klicken, können Sie in einer Roten Box die Verbindung für bestimmte Endpunkte der Lösung widerrufen. Wenn Sie die Daten widerrufen, stoppt die Schnittstelle sofort und ist nicht mehr aktiv, bis die passende Konfiguration erneut durchgeführt wurde. Kommen Sie für den Fall der Kündigung persönlich auf uns zu. Ein widerrufen der Daten führt nicht zur Kündigung der Schnittstelle!
Produktdaten
In diesem Abschnitt gehen wir detailliert auf die Produktdaten und das standardisierte Wertemapping der Lösung ein. Wir aktualisieren alle 15 Minuten alle Produkte, sowohl Bestände als auch die allgemeinen Produktinformationen auf Basis des Aktualisierungsdatums. Einmal täglich um 02:00 aktualisieren wir alle Produkte.
Wir können die Schnittstelle für Sie individualisieren. Bitte kommen Sie bei Bedarf jederzeit auf uns zu, sodass wir Ihre individuellen Anforderungen berücksichtigen und die Integration für Sie anpassen können.
Filter & Level
Als Filter für die zu übertragenden Produkte und verbundene Aktionen nutzen wir das Afterbuy Level Feld.
Wir übertragen bei Variationssets das gesamte Set mit den Kindern, es kann eine Variante ausschließlich einem Variationsset zugewiesen werden. Außerdem übertragen wir Einzelprodukte und Produktsets sowie Produktsets in Variationssets.
Die Produktdaten müssen auch für die Childs der Variantenartikel gepflegt sein, da diese als Basis für Shopify dienen. Während ein Level 11 oder höher bei Childs das Löschen der Varianten in Shopify auslöst, muss das Level 9 samt zugehöriger Funktion auf Parent-Ebene gesetzt werden, da die Childs der Variantenartikel unabhängig vom gepflegten Level 9 pro Variante aktualisiert werden.
| Level | Funktion |
|---|---|
| 0 - 8 | Das Produkt wird übertragen und vollständig aktualisiert |
| 9 | Das Produkt wird übertragen und anschließend werden ausschließlich Preise & Bestände aktualisiert |
| 10 | Das Produkt wird als Entwurf übertragen und vollständig aktualisiert |
| 11 | Das Produkt wird aus Shopify gelöscht |
| >= 12 | Das Produkt wird ignoriert |
Wertemapping
Das Wertemapping beschreibt das Matching der Datenfelder von System zu System im Standard. Selbstverständlich können wir jederzeit Anpassungen im Mapping durchführen und Ihre Werte aus anderen Datenfeldern bei Afterbuy Matchen, die Felder bei Shopify sind im Standard fest vorgegeben und können um Metafelder erweitert werden. Die hier beschriebenen Shopify Datenfelder sind die Standard Felder, die von unserer Schnittstelle befüllt und aktualisiert werden.
Um erfolgreich in Ihrem Shop zu verkaufen, prüfen Sie bitte die jeweiligen Anforderungen an Produktdaten und ergänzen Sie alle relevanten Informationen in Ihren Stammdaten.
| Afterbuy | Afterbuy Benutzeroberfläche | Shopify |
|---|---|---|
| Name | Produktbeschreibung → Name | Titel |
| Description | Produktbeschreibung → Beschreibung in HTML | Beschreibung |
| ProductBrand | Produktdaten → Marke/Hersteller | Marke |
| Keywords | SEO / SEM Daten → Produkt Keywords (kommagetrennt) | Tags |
| Level | Afterbuy Onlineshop Daten → Level (steuert das Handling mit dem Produkt) | Status |
| ProductPictures.ProductPicture | Bilder → Bildergalerie → Bildlink Original | Medien (bei Varianten das erste zugewiesene Bild als zugewiesenes Variantenbild) |
| Features.Feature | Produktmerkmale → Angelegtes Merkmal mit Namen shopify_seo_title | Seitentitel |
| Features.Feature | Produktmerkmale → Angelegtes Merkmal mit Namen shopify_seo_description | Meta-Beschreibung |
| ProductID | Produktdaten → Produkt ID → Your ID | SKU (Artikelnummer) |
| ManufacturerStandardProductIDValue | Produktdaten → Hersteller Standard Produkt ID Wert | Barcode (ISBN, UPC, GTIN usw.) |
| SellingPrice | Preise und Bestände → Verkaufspreis (Brutto) | Preis |
| AdditionalPrices.AdditionalPrice | Preise und Bestände → angelegtes Preisfeld shopifyPrice oder shopify_price | Preis |
| AdditionalPrices.AdditionalPrice | Preise und Bestände → angelegtes Preisfeld shopifySalePrice oder shopify_sale_price | Vergleichspreis (shopifyPrice oder Verkaufspreis werden zum Streichpreis, der shopifySalePrice wird der neue Preis) |
| BuyingPrice | Preise und Bestände → Einkaufspreis | Kosten pro Artikel |
| Quantity | Preise und Bestände → Afterbuy-Shop-Bestand | Bestand (an einem Standard Lagerort) |
| Weight | Produktdaten → Gewicht (in kg) | Produktgewicht |
| CountryOfOrigin | Produktdaten → Ursprungsland | Ländercode des Ursprungs |
| CustomsTariffNumber | Produktdaten → Zolltarifnummer | Code des Harmonisierten Systems (HS-Code) |
| UnitOfQuantity & BasepriceFactor | Afterbuy Onlineshop Daten → Inhalt / Einheit | Stückpreis → Gesamtmaß und Basismaß |
| BaseProducts...EBayVariationName | Einstellungen für Sets → Spezifikation der Varianten → Optionsnamen (z.B. "Farbe", "Größe") | Varianten Name der Optionen |
| BaseProducts...EBayVariationValue | Einstellungen für Sets → Produkte zu jeder Variante → Optionswerte | Varianten Optionswerte |
| FreeValue1 - FreeValue10 | Allgemeine Daten → Freifelder 1-10 | Metafelder (namespace: free_value_1 - free_value_10, key: afterbuy) |
| CustomLabel0 - CustomLabel4 | SEO / SEM Daten → Benutzerdefinierte Label 1-5 | Metafelder (namespace: custom_label_0 - custom_label_4, key: afterbuy) |
| Features.Feature (außer SEO) | Produktmerkmale → Angelegte Merkmale | Metafelder (namespace: feature name (lowercase), key: afterbuy) |
| Catalogs.Catalog.CatalogID | Afterbuy Onlineshop Daten → Zugewiesene Kataloge | Hinzugefügt als Tags mit Format CAT{CatalogID} |
| TaxRate | Preise und Bestände → Umsatzsteuer | Hinzugefügt als Tag mit Format MWST{TaxRate} |
Preis- und Bestandsexport
Die Preise und Bestände werden parallel zum Produktexport alle 5 Minuten durchgeführt. Einmal täglich um 04:00 aktualisieren wir alle Preise und Bestände.
Die Updates erfolgen auf Basis des letzten Aktualisierungsdatums des Produkts oder des Datums des letzten Verkaufs, bei dem der Artikel erfolgreich identifiziert wurde.
| Afterbuy | Beschreibung | Shopify |
|---|---|---|
| Quantity | Afterbuy Shop-Bestand überschreibt die verfügbare Bestandsmenge | Bestand |
| SellingPrice | Regulärer Verkaufspreis | Preis |
| AdditionalPrices.AdditionalPrice | Überschreibt den Standard Verkaufspreis wenn verfügbar mit dem angelegten Preisfeld shopifyPrice oder shopify_price | Preis |
| AdditionalPrices.AdditionalPrice | Vergleichspreis (shopifyPrice oder Verkaufspreis werden zum Streichpreis, der shopifySalePrice oder shopify_sale_price wird der neue Preis) | Vergleichspreis |
| BuyingPrice | Produkteinkaufspreis | Kosten pro Artikel |
Bestellungen
Wir lesen in Echtzeit die Bestellungen per Webhook aus Shopify aus. Die Bestellungen werden anschließend mit allen relevanten Informationen übertragen.
Wertemapping des Bestellimports
Hier finden Sie eine Übersicht, wie die Felder von Shopify zu Afterbuy gemappt werden. Diese Informationen sind wichtig, um zu verstehen, wie die Bestelldaten zwischen den beiden Systemen synchronisiert werden.
| Shopify | Beschreibung | Afterbuy |
|---|---|---|
| Name + PaymentGatewayNames | Benutzername im Format "Shopify-#Order-Payment" | Kbenutzername |
| BillingAddress.Company | Firma des Kunden | KFirma |
| BillingAddress.FirstName | Vorname des Kunden | KVorname |
| BillingAddress.LastName | Nachname des Kunden | KNachname |
| BillingAddress.Address1 | Straße des Kunden | KStrasse |
| BillingAddress.Address2 | Adresszusatz des Kunden | KStrasse2 |
| BillingAddress.Zip | Postleitzahl des Kunden | KPLZ |
| BillingAddress.City | Ort des Kunden | KOrt |
| BillingAddress.Province | Bundesland des Kunden | KBundesland |
| E-Mail-Adresse des Kunden | Kemail | |
| BillingAddress.Phone | Telefonnummer des Kunden | Ktelefon |
| BillingAddress.CountryCode (konvertiert) | Land des Kunden | KLand |
| Note | Bestellnotiz | Kommentar |
| ID | Shopify Bestellnummer | VID |
| Currency | Währung der Bestellung | SoldCurrency |
| ProcessedAt | Kaufdatum (wenn bezahlt) | BuyDate |
| FinancialStatus | Zahlungsstatus (1 wenn "paid") | SetPay |
| ProcessedAt | Zahlungsdatum (wenn bezahlt) | SetPayDate |
| PaymentGatewayNames | Zahlungsmethode | Zahlart |
| LineItems[X].SKU | Artikelnummer | Artikelnr_X |
| LineItems[X].SKU | Alternative Artikelnummer 1 | AlternArtikelNr1_X |
| LineItems[X].Name | Alternative Artikelnummer 2 | AlternArtikelNr2_X |
| LineItems[X].Name | Artikelname | Artikelname_X |
| LineItems[X].Price - LineItems[X].DiscountAllocations | Artikelpreis abzüglich Rabatte | ArtikelEpreis_X |
| LineItems[X].TaxLines[0].Rate | Mehrwertsteuersatz des Artikels | ArtikelMwSt_X |
| LineItems[X].Quantity | Artikelmenge | ArtikelMenge_X |
| LineItems[X].Grams (konvertiert zu kg) | Artikelgewicht in Kilogramm | ArtikelGewicht_X |
| OrderStatusUrl | Link zur Bestellung | ArtikelLink_X |
| LineItems[X].SKU | Stamm-ID des Artikels | ArtikelStammID_X |
| ShippingLines[].Price - ShippingLines[].DiscountAllocations | Versandkosten abzüglich Rabatte | Versandkosten |
| Transactions[].Gateway | Zahlungsstatus (wenn PayPal) | PaymentStatus |
| Transactions[].AuthorizationCode | Transaktions-ID (wenn PayPal) | PaymentTransactionId |
Bei unterschiedlichen Liefer- und Rechnungsadressen werden zusätzlich folgende Felder gesetzt:
| Shopify | Beschreibung | Afterbuy |
|---|---|---|
| 1 (wenn Adressen unterschiedlich) | Aktiviert separate Lieferadresse | Lieferanschrift |
| ShippingAddress.Company | Firma für Lieferadresse | KLFirma |
| ShippingAddress.FirstName | Vorname für Lieferadresse | KLVorname |
| ShippingAddress.LastName | Nachname für Lieferadresse | KLNachname |
| ShippingAddress.Address1 | Straße für Lieferadresse | KLStrasse |
| ShippingAddress.Address2 | Adresszusatz für Lieferadresse | KLStrasse2 |
| ShippingAddress.Zip | Postleitzahl für Lieferadresse | KLPLZ |
| ShippingAddress.City | Ort für Lieferadresse | KLOrt |
| ShippingAddress.Province | Bundesland für Lieferadresse | KLBundesland |
| ShippingAddress.CountryCode (konvertiert) | Land für Lieferadresse | KLLand |
| ShippingAddress.Phone | Telefonnummer für Lieferadresse | KLTelefon |
Wertemapping des Bestellimports per API
Hier sind nur die Felder aufgeführt, die sich vom Webhook unterscheiden. Alle anderen Felder werden auf die gleiche Weise gemappt wie beim Webhook.
| Shopify | Beschreibung | Afterbuy |
|---|---|---|
| Name + PaymentGatewayNames | Benutzername im Format "Shopify-Order-Payment" (ohne "#") | Kbenutzername |
| BillingAddress.CountryCodeV2 (konvertiert) | Land des Kunden (verwendet CountryCodeV2) | KLand |
| LegacyResourceID | Shopify Bestellnummer (verwendet LegacyResourceID) | VID |
| CurrencyCode | Währung der Bestellung (verwendet CurrencyCode) | SoldCurrency |
| FullyPaid | Zahlungsstatus (1 wenn "true" statt "paid") | SetPay |
| LineItems.Edges[X].Node.SKU | Artikelnummer (verwendet GraphQL-Struktur) | Artikelnr_X |
| LineItems.Edges[X].Node.SKU | Alternative Artikelnummer 1 (verwendet GraphQL-Struktur) | AlternArtikelNr1_X |
| Name | Alternative Artikelnummer 2 (verwendet Order.Name) | AlternArtikelNr2_X |
| LineItems.Edges[X].Node.Name | Artikelname (verwendet GraphQL-Struktur) | Artikelname_X |
| LineItems.Edges[X].Node.DiscountedTotalSet.PresentmentMoney.Amount | Artikelpreis inkl. Rabatte (verwendet vorberechneten Wert) | ArtikelEpreis_X |
| LineItems.Edges[X].Node.TaxLines[0].Rate | Mehrwertsteuersatz des Artikels (verwendet GraphQL-Struktur) | ArtikelMwSt_X |
| LineItems.Edges[X].Node.Quantity | Artikelmenge (verwendet GraphQL-Struktur) | ArtikelMenge_X |
| LineItems.Edges[X].Node.Variant.InventoryItem.Measurement.Weight.Value (konvertiert zu kg) | Artikelgewicht in Kilogramm (verwendet GraphQL-Struktur) | ArtikelGewicht_X |
| StatusPageURL | Link zur Bestellung | ArtikelLink_X |
| LineItems.Edges[X].Node.SKU | Stamm-ID des Artikels (verwendet GraphQL-Struktur) | ArtikelStammID_X |
| ShippingLine.DiscountedPriceSet.PresentmentMoney.Amount | Versandkosten inkl. Rabatte (verwendet vorberechneten Wert) | Versandkosten |
Bei unterschiedlichen Liefer- und Rechnungsadressen wird zusätzlich folgendes Feld anders gemappt:
| Shopify | Beschreibung | Afterbuy |
|---|---|---|
| ShippingAddress.CountryCodeV2 (konvertiert) | Land für Lieferadresse (verwendet CountryCodeV2) | KLLand |
Versandexport
Wir importieren alle 15 Minuten die Bestellungen aus Afterbuy, die innerhalb der letzten 20 Minuten versendet wurden, also ein Versanddatum erhalten haben. Für diese Bestellungen lesen wir die Versandart und Trackingnummer aus Afterbuy aus und übertragen diese zu Shopify. Der Status der Bestellung wird dann zu „Shipped“ aktualisiert.
| Afterbuy | Beschreibung | Shopify |
|---|---|---|
| ShippingInfo.ShippingMethod | Versanddienstleister/Methode | TrackingInfo.Company |
| ShippingInfo.ParcelLabels.ParcelLabel.ParcelLabelNumber | Sendungsverfolgungsnummer(n) | TrackingInfo.Numbers |
Die Namen der Versandarten in Afterbuy und die Anforderungen an den Namen der Versandart bei Shopify können sich unterscheiden. Bei Versandupdate ist darauf zu achten, dass die passende Versandart gesetzt wird, damit Shopify die passenden Versandlinks generieren kann. Die Versandlinks übergeben wir nicht.