Wenn Sie die REST-API von ShipStation verwenden, um Auftragsinformationen zu übermitteln, oder wenn Sie ein Drittanbietersystem verwenden, das Daten von ShipStation abrufen möchte, kann es für Sie von Vorteil sein, Webhooks einzurichten. Nachdem Sie Webhooks eingerichtet haben, kann ShipStation Alerts senden, wenn bestimmte Ereignisse in Ihrem Konto auftreten. Diese Alerts helfen dabei, das System zu einem Endpunkt zu führen, der verwendet werden kann, um Daten vom ShipStation-Konto abzurufen.
Webhooks sind ein API-Prozess, der es ShipStation ermöglicht, Live-Updates an einen Ziel-URL-Endpunkt zu senden, wenn bestimmte Aktionen in Ihrem ShipStation-Konto stattfinden. Wenn sie ausgelöst werden, startet ShipStation eine POST-Anfrage, um eine Payload von Daten an die Ziel-URL zu senden. Darin enthalten ist eine resource_url, die verwendet werden kann, um spezifische Informationen zu den Aufträgen oder Sendungen abzurufen. Ein Webhook wird die Payload innerhalb weniger Minuten nach der Aktion, die ihn ausgelöst hat, an die Ziel-URL senden.
Sie können die folgenden Webhooks in ShipStation erstellen:
-
Für neue Aufträge (ORDER_NOTIFY)
-
Für neue Artikel (ITEM_ORDER_NOTIFY)
-
Für versendete Aufträge (SHIP_NOTIFY)
-
Für versendete Artikel (ITEM_SHIP_NOTIFY)
-
Für Artikel, die vom Fulfillment-Anbieter versendet wurden (FULFILLMENT_SHIPPED)
-
Für Artikel, die vom Fulfillment-Anbieter abgelehnt wurden (FULFILLMENT_REJECTED)
Die Webhook-Typen Für neue Aufträge und Für neue Artikel beziehen sich auf Auftragsdaten. Diese Webhooks werden immer dann ausgelöst, wenn ein neuer Auftrag in ShipStation mit einem anderen Status als Ausstehende Zahlung erstellt wird oder wenn ein Auftrag mit dem Status Ausstehende Zahlung auf einen anderen Status als Storniert aktualisiert wird.
-
Für jede Importaktion, die mindestens einen neuen bezahlten Auftrag erstellt, wird eine Webhook-Payload erstellt.
-
Alle gleichzeitig erstellten Aufträge werden in einer einzigen Webhook-Payload enthalten sein.
Die Webhook-Typen Für versendete Bestellungen und Für versendete Artikel beziehen sich auf Sendungsdaten. Diese Webhooks werden ausgelöst, wenn ein neues ausgehendes Versandetikett für eine Bestellung generiert wird. Die Webhooks werden nicht für Rücksendungen oder für Fulfillments ausgelöst, die entweder über einen Fulfillment-Partner wie FBA oder über die Aktion Als versendet kennzeichnen erstellt wurden.
-
Wenn Sendungen einzeln erstellt werden, löst jede Sendung einen eigenen Webhook aus.
-
Wenn Sie Sendungen in einer Charge erstellen, löst jede Charge einen einzelnen Webhook aus.
Die Webhook-Typen Für Artikel, die vom Fulfillment-Anbieter versendet wurden und Für Artikel, die vom Fulfillment-Anbieter abgelehnt wurden, beziehen sich auf Fulfillment-Daten. Diese Webhooks werden ausgelöst, wenn eine delegierte Bestellung vom Status Fulfillment ausstehend in den Status Versendet verschoben wird und wenn ein Fulfillment-Anbieter eine Bestellung ablehnt, die von einem Lieferanten an ihn delegiert wurde.
Außerdem wird Für Artikel, die vom Fulfillment-Anbieter versendet wurden ausgelöst, wenn die Aktion Als versendet kennzeichnen verwendet wird.
Sie können neue Webhooks in Ihrem ShipStation-Konto auf zwei verschiedene Arten erstellen:
-
API-Anfragen
-
ShipStation-Kontoeinstellungen
In diesem Abschnitt wird erläutert, wie Sie Webhooks über die Seite mit den ShipStation-Einstellungen erstellen. Informationen zur Verwendung von API-Anfragen finden Sie in unserer ausführlichen API-Dokumentation darüber, wie Sie Webhooks auflisten, einen Webhook abonnieren und Webhooks abbestellen können.
So erstellen Sie einen Webhook in ShipStation:
-
Wählen Sie Webhooks aus den Optionen aus.
Webhook-Option ausgegraut
Wenn Sie noch keine Webhooks erstellt haben, ist die Option grau.
-
Klicken Sie auf Webhook hinzufügen.
-
Legen Sie Folgendes fest: den Namen (maximal 100 Zeichen), Typ, ob der Webhook für alle Shops oder einen bestimmten Shop gilt, und die Ziel-URL (maximal 200 Zeichen).
-
Klicken Sie auf Speichern, um den Webhook zu erstellen, nachdem Sie die Details eingegeben haben.
Sie können vorhandene Webhooks in Ihrem ShipStation-Konto auf zwei Arten entfernen:
-
API-Anfragen
-
ShipStation-Kontoeinstellungen
In diesem Abschnitt wird erläutert, wie Sie Webhooks über die Seite mit den ShipStation-Einstellungen entfernen. Weitere Informationen zur Verwendung von API-Anfragen finden Sie in unserer ausführlichen API-Dokumentation zum Entfernen von Webhooks.
So entfernen Sie einen Webhook in ShipStation:
Unabhängig davon, wie der Webhook erstellt wurde, können Sie einen vorhandenen Webhook nur über Ihre ShipStation-Kontoeinstellungen bearbeiten.
So bearbeiten Sie einen vorhandenen Webhook:
-
Wählen Sie Webhooks aus den Optionen aus.
-
Klicken Sie neben dem Webhook, den Sie verändern möchten, auf Bearbeiten.
-
Ändern Sie je nach Bedarf die folgenden Informationen: den Namen (maximal 100 Zeichen), Typ, ob der Webhook für alle Shops oder einen bestimmten Shop gilt, und die Ziel-URL (maximal 200 Zeichen).
-
Klicken Sie auf Speichern, um den Webhook zu aktualisieren.
Wenn ein Webhook ausgelöst wird, sendet ShipStation eine POST-Anfrage an die Ziel-URL.
Diese Anfrage beinhaltet eine Payload im Zusammenhang mit der Aktion und neu erstellten Daten:
-
resource_url: Der Endpunkt, der kontaktiert werden muss, um Daten in Bezug auf die Aktion zu erfassen, die den Webhook ausgelöst hat. Die resource_url enthält mehrere URL-Parameter:
-
storeId: Die interne Kennung von ShipStation für den Shop.
storeId
wird nicht verwendet, wenn der Webhook für alle Shops gilt. -
importBatch oder batchId: Die internen Kennungen von ShipStation für die „Importieren“-Aktion (für
ORDER
-Webhooks) oder die „Etikett erstellen“-Aktion (fürSHIP
-Webhooks). -
includeOrderItems oder includeShipmentItems: Steuert, ob Artikel beim Kontaktieren der resource_url in die Antwort aufgenommen werden. Bei Verwendung eines
ITEM
-Webhooks, wird dies auf True gesetzt.
-
-
resource_type: Der Webhook-Typ, der die Payload ausgelöst hat.
Um die Webhook-Payload zu verwenden, müssen Sie eine GET-Anfrage an die REST-API von ShipStation senden, die die resource_url als Endpunkt verwendet. Diese Anfrage muss einen Authentication Header enthalten, genau wie andere API-Anfragen an ShipStation. Weitere Informationen zur API-Authentifizierung finden Sie in unserer ausführlichen API-Dokumentation.
Beim Kontaktieren der resource_url folgt die Antwort derselben Struktur wie die Anfrage Aufträge auflisten (für ORDER
-Webhooks) oder Sendungen auflisten (für SHIP
-Webhooks).
Hier sind einige Beispiele für Webhook-Payloads:
Für neue Aufträge (ORDER_NOTIFY) {"resource_url":"https://ssapi.shipstation.com/orders?storeID=123456&importBatch=1ab23c4d-12ab-1abc-a1bc-a12b12cdabcd","resource_type":"ORDER_NOTIFY"} |
Für neue Artikel (ITEM_ORDER_NOTIFY) {"resource_url":"https://ssapi.shipstation.com/orders?storeID=123456&importBatch=1ab23c4d-12ab-1abc-a1bc-a12b12cdabcd&includeOrderItems=True","resource_type":"ITEM_ORDER_NOTIFY"} |
Für versendete Aufträge (SHIP_NOTIFY) {"resource_url":"https://ssapi.shipstation.com/shipments?storeID=123456&batchId=12345678","resource_type":"SHIP_NOTIFY"} |
Für versendete Artikel (ITEM_SHIP_NOTIFY) {"resource_url":"https://ssapi.shipstation.com/shipments?storeID=123456&batchId=12345678&includeShipmentItems=True","resource_type":"ITEM_SHIP_NOTIFY"} |