Beschreibung der REST-API-Funktionen von ShipStation, zur Generierung von Zugriffstoken und zur Unterstützung für REST-API-Probleme.
Unsere REST-API ist für jeden Tarif verfügbar und ermöglicht Lese- und Schreibzugriff: Lesezugriff auf fast alle Daten in Ihrem Konto sowie Schreibzugriff auf die Erstellung bestimmter Objekte wie Aufträge, Kunden und Produkte. Die API ist eine großartige Möglichkeit, Daten direkt von und zu ShipStation zu übermitteln, insbesondere wenn Sie Aufträge erstellen, Kunden hinzufügen oder Ihre Auftrags- und Versanddaten abfragen.
ShipStation ist bestrebt, den Versand für Online-Verkäufer zu optimieren, unabhängig davon, wo sie ihre Produkte online verkaufen. Wir fügen ständig neue Marktplätze, Warenkörbe und Integrationstools hinzu, weil wir wissen, dass der Bereich für E-Commerce wächst. Aus diesem Grund haben wir hart daran gearbeitet, Entwicklerressourcen bereitzustellen, um benutzerdefinierte Integrationen mit ShipStation zu erstellen. Auf dem ShipStation Developer Portal finden Sie die vollständige Dokumentation der ShipStation REST API.
Unsere API ermöglicht es Entwicklern, Anwendungen zu erstellen, die mit der ShipStation-Plattform verbunden sind. Mit der API können Sie viele Aufgaben erledigen, darunter die Folgenden:
-
Aufträge verwalten
-
Sendungen verwalten
-
Erstellen von Versandetiketten
-
Abrufen von Versandtarifen
-
und mehr!!!
Im Anhang zu diesem Artikel finden Sie zu Ihrer Information Tabellen mit API-Codes für viele unserer verfügbaren Versanddienste. Sie enthält nur Servicecodes für öffentlich zugängliche Versanddienste.
Für einige Versanddienstleister und Dienste ist das Abrufen von Versandtarifen möglicherweise nicht verfügbar.
Einige Versanddienstleister sowie einige Dienste von Versanddienstleistern sind möglicherweise nicht verfügbar, um Versandtarife per getRate-Anfrage abzurufen. Beispielsweise geben getRate-Anfragen keine nutzbaren Tarife für UPS Surepost® zurück. Erkundigen Sie sich zunächst bei Ihrem Versanddienstleister, welche ihrer verfügbaren Versanddienste das Durchsuchen von Tarifen unterstützen.
Um die API von ShipStation zu verwenden, müssen Sie einen API-Schlüssel und ein API-Geheimnis generieren, die in allen Aufrufen der API enthalten sind. Der Schlüssel und der geheime Code werden verwendet, um die API-Aufrufe zu authentifizieren, damit ShipStation die Informationen in Ihrem spezifischen Konto aktualisiert.
Neue Konten erhalten nach 48 Stunden Zugang
Aus Sicherheitsgründen gibt es nach der Anmeldung für ein Konto bei ShipStation eine Wartezeit von 48 Stunden, bevor Sie API-Schlüssel generieren können.
Für einen schnelleren Zugriff oder dringende Anforderungen während der 48-Stunden-Wartezeit können Sie sich gerne an Ihren Kontomanager wenden.
-
Klicken Sie auf Neue API-Schlüssel erstellen, wenn noch kein Schlüssel und kein Geheimschlüssel aufgeführt sind.
Generierte API-Schlüssel
Wenn Sie Ihre API-Schlüssel bereits generiert haben, werden die vorhandenen API-Schlüssel hier aufgeführt und auf der Schaltfläche wird API-Schlüssel neu generieren angezeigt.
Wenn Sie bereits über API-Schlüssel verfügen, generieren Sie KEINE neuen. Kopieren Sie stattdessen Ihren bestehenden Schlüssel und Ihren Geheimschlüssel.
-
Kopieren Sie Ihren Schlüssel und Ihren Geheimschlüssel.
Diese können Sie dann auf das Konto anwenden, das Sie für den Zugriff auf die ShipStation-API benötigen.
Nachdem die API-Schlüssel generiert wurden, können Sie sie von dieser Seite kopieren und bei Bedarf allen API-Entwicklern zur Verfügung stellen.
Ihr ShipStation-Konto kann jeweils nur einen einzigen Satz API-Schlüssel vergeben. Derselbe Satz von API-Schlüsseln kann für mehrere API-Anwendungen verwendet werden. Wenn Sie zu irgendeinem Zeitpunkt neue Schlüssel generieren, stellen Sie sicher, dass Sie die neuen Schlüssel an jede Anwendung weitergeben, die sie verwendet, sonst funktioniert die Verbindung mit ShipStation nicht mehr.
Es gibt derzeit keine Möglichkeit, den Umfang des API-Zugriffs zu begrenzen. Wenn ein API-Entwickler Zugriff auf Ihren Schlüssel und Ihren geheimen Code hat, kann er alle verfügbaren ShipStation API-Aktionen ausführen.
Bevor Sie mit der API von ShipStation beginnen, empfehlen wir Ihnen dringend, das ShipStation Developer Portal zu überprüfen, um einen vollständigen Überblick über alle Aktionen zu erhalten, die über API-Aufrufe ausgeführt werden können. In dieser Dokumentation finden Sie auch Beispiele für Aufrufe und Antworten für die API-Kommunikation sowie detaillierte Informationen zur Authentifizierung Ihres API-Schlüssels und Geheimnisses für API-Aufrufe.
Das Support-Team von ShipStation kann Ihnen nicht beim Entwerfen oder Entwickeln einer API-Integration helfen, aber wir können Sie sicherlich dabei unterstützen, API-Aufrufe zu testen und sicherzustellen, dass alles wie vorgesehen funktioniert, oder Ihnen helfen, Informationen im Aufruftext zu identifizieren, die Fehler verursachen würden. Wenn Sie Probleme mit einem oder mehreren Ihrer API-Aufrufe haben und Hilfe benötigen, senden Sie eine E-Mail an unser API-Support-Team direkt unter apisupport@shipstation.com und unser Team wird Ihnen helfen, das Problem mit Ihnen zu beheben.
Einschränkungen der ShipStation Open API
-
Die ShipStation Open API unterstützt nicht die Funktion Auftrag erneut versenden.
-
Die ShipStation Open API unterstützt keine nicht-lateinischen Zeichensätze wie Japanisch, Chinesisch und Kyrillisch. Diese Sätze werden oft nicht von der Etiketten-API des Anbieters unterstützt, was dazu führt, dass ??? Symbole oder Leerstellen auf dem Etikett an der Stelle erscheinen, an der die Zeichen stehen sollten.
Um Ihnen besser helfen zu können, stellen Sie bitte sicher, dass Sie die folgenden Informationen angeben:
-
Die API-Aktion, die Sie ausführen wollten (z. B. Sendungen auflisten, Auftragserstellung usw.)
-
Den vollständigen API-Endpunkt, den Sie aufgerufen haben (z. B.: https://ssapi.shipstation.com/shipments?orderNumber=zen-285858-1)
-
Bei einem POST-API-Aufruf den vollständigen JSON-Text der Anfrage.
-
Die Statuscodenummer für die API-Antwort.
-
Die vollständige JSON-Antwort auf den API-Aufruf.
Unterstützung bei API-Problemen
Ohne die oben genannten Informationen kann es für ShipStation schwierig sein, API-Probleme zu beheben. Wenn Sie sich nicht sicher sind, wie Sie diese Informationen erhalten, empfehlen wir Ihnen, sich direkt an Ihren API-Entwickler zu wenden, um Unterstützung beim Abrufen aller verfügbaren Protokolle zu erhalten. Wir empfehlen Ihnen außerdem, Ihren API-Entwickler bei jeder Kommunikation mit apisupport@shipstation.com zu informieren.