shopify

Zweck

Der Shopify Connector bietet eine umfassende Schnittstelle zur Integration mit der Shopify Admin API. Er ermöglicht die Automatisierung vielfältiger E-Commerce-Vorgänge und erlaubt die Verwaltung von Shop-Daten, Produkten, Bestellungen, Kunden und weiteren Bereichen direkt aus Workflows.

Mit diesem Connector können folgende Aufgaben erledigt werden:

• Produkte und Kollektionen verwalten: Erstellen, Abrufen, Aktualisieren und Löschen von Produkten, Varianten und Kollektionen (benutzerdefiniert und intelligent).

• Bestellungen und Fulfillments bearbeiten: Bestellungen abrufen, erstellen und aktualisieren sowie den Fulfillment-Prozess steuern, einschließlich Erstellen und Stornieren von Fulfillments.

• Kunden verwalten: Kundendaten erstellen, aktualisieren, löschen und abrufen.

• Lagerbestand steuern: Lagerbestände über verschiedene Standorte abrufen und Mengen anpassen.

• Finanzen handhaben: Transaktionen erstellen, Rückerstattungen berechnen und Rabattcodes verwalten.

• Daten anpassen: Metafelder auf den meisten wichtigen Ressourcen wie Produkten und Bestellungen lesen und schreiben, um benutzerdefinierte Daten zu speichern.

• Webhooks verwalten: Workflows automatisieren durch Erstellen und Verwalten von Webhooks, die Benachrichtigungen über Ereignisse im Shopify-Shop bereitstellen.

Praktische Anwendungshinweise

Ratenbegrenzung: Der Connector berücksichtigt die API-Ratenbegrenzung von Shopify automatisch. Bei Überschreitung eines Limits erfolgt eine Wartezeit gemäß dem Wert im Retry After-Header, bevor der nächste Versuch gestartet wird.

Paginierung: Bei Anfragen, die eine Liste zurückgeben, wird cursor-basierte Paginierung verwendet. Die Antwort enthält bei weiteren Ergebnissen im Link-Header eine URL zur nächsten Seite. Um diese zu sehen, muss die Option „Header ausgeben“ aktiviert sein. Für die nächste Seite wird die Aktion „Nächste Seite abrufen“ mit der URL aus dem vorherigen Link-Header genutzt.

Struktur des Anfragebodys: Für das Erstellen oder Aktualisieren von Ressourcen (z. B. Produkt, Bestellung) müssen die JSON-Daten meist innerhalb eines Wurzelobjekts verschachtelt sein, z. B.:

{
  "product": {
    "title": "Neues Produkt",
    ...
  }
}

Authentifizierung

Die Authentifizierung erfolgt über einen API-Zugriffstoken, der in einer Custom App im Shopify-Admin-Dashboard generiert wird.

• URL: Die individuelle .myshopify.com-Shop-URL (z. B. https://mein-shop.myshopify.com).

• Access Token: Der API-Zugriffstoken der Custom App, der bei jeder Anfrage im Header X-Shopify-Access-Token mitgesendet wird.

Beispiel (HTTP-Header):

X-Shopify-Access-Token: <your-access-token>

Erwartungen an Ein- und Ausgabe

Eingabe

• Pfadparameter: Für Aktionen an bestimmten Entitäten, wie „Bestellung nach ID abrufen“, ist die Angabe von order_id erforderlich.

• Query-Parameter: Bei Listenabfragen können verschiedene optionale Filter verwendet werden, z. B. status, financial_status oder since_id bei „Bestellungen abrufen“.

• JSON-Body: Beim Erstellen oder Aktualisieren ist ein data-Objekt im JSON-Format erforderlich, das die Eigenschaften der Ressource enthält, häufig verschachtelt unter einem Wurzel-Schlüssel (z. B. {"order": {...}}).

• Nächste-Seite-URL: Die spezielle Aktion „Nächste Seite abrufen“ erwartet die vollständige url, die im Link-Header einer vorherigen paginierten Antwort enthalten ist.

Ausgabe

• response: Enthält den JSON-Body der API-Antwort. Bei Listenendpunkten ist dies meist ein Objekt mit einem Wurzel-Schlüssel (z. B. products), das ein Array von Elementen enthält.

• header: Enthält die Antwort-Header. Diese Ausgabe muss über die Option „Header ausgeben“ aktiviert sein, wenn Paginierungsfunktionen genutzt werden sollen.

• createResponseDataStructure: Erlaubt die Erstellung einer Datenstruktur aus der response, um die Ausgabe für nachfolgende Workflow-Schritte leichter nutzbar zu machen.