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!!!
ShipStation hat kürzlich die V2-API eingeführt, eine neue Version unserer API, die Versand- und Inventar-Endpunkte umfasst. Die bisherige Open API wird jetzt V1 API genannt und ist weiterhin in Betrieb.
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.
Besuchen Sie die ShipStation Developer-Seite für die vollständige V2-Dokumentation und diese Seite für die V1 Open API-Dokumentation. Auf dem ShipStation Developer Portal finden Sie die vollständige Dokumentation der ShipStation REST API.
Die V2-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.
Am Ende dieses Artikels 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.
Verwenden Sie mehrere V1-API-Schlüssel für eine einzige Plattform
ShipStation ermöglicht zwei V1-API-Schlüssel, um den Prozess der Schlüsselrotation innerhalb derselben Integration zu erleichtern. Diese Rotation soll Ihnen einen konsistenten Arbeitsablauf und Sicherheit gewährleisten. Diese Schlüssel dürfen nicht für zwei verschiedene Integrationen verwendet werden.
Wenn Ihr API-Schlüssel bald abläuft, werden wir Sie per E-Mail daran erinnern, dass Sie Ihre Schlüssel erneuern müssen, bevor der aktuelle inaktiv wird.
Diese Endpunkte werden der V1-API ähnlich sein, aber sie werden über erweiterte Funktionen verfügen und weiterentwickelt werden. Die 2 Aspekte umfassen das Folgende:
-
Inventar: Diese Endpunkte legen SKU-Anzahlen fest und aktualisieren Inventarlager.
-
Versand: Diese Endpunkte umfassen alle weiteren Aspekte des Versands, wie Tarife, Zollformulare, Etiketten, Sendungsverfolgung usw.
Für beide Optionen können Sie auch einen zweiten API-Schlüssel generieren, bevor der andere abläuft. Sie werden keinen Zeitverlust in Ihrem Arbeitsablauf feststellen und profitieren von einer höheren Sicherheit.
Um die API von ShipStation zu verwenden, müssen Sie einen API-Schlüssel und für V1 außerdem einen API-Geheimschlüssel generieren. Diese Information wird in allen Anfragen der API enthalten sind. Der API-Schlüssel und der API-Geheimschlüssel werden verwendet, um die API-Anfragen zu authentifizieren, damit ShipStation die Informationen in Ihrem spezifischen Konto aktualisiert.
Neue Konten erhalten Zugang nach der E-Mail-Verifizierung
Aus Sicherheitsgründen ist nach der Anmeldung bei ShipStation eine Konto-Verifizierung per E-Mail erforderlich, bevor Sie API-Schlüssel generieren können.
Wenn Sie während der Wartezeit der E-Mail-Verifizierung schneller Zugriff benötigen oder dringende Anforderungen haben, können Sie sich gerne an den Verwalter Ihres Testkontos wenden oder den ShipStation-Support kontaktieren.
So erhalten Sie Ihren API-Schlüssel und Ihr Geheimnis in ShipStation:
-
Wählen Sie Ihre API-Version aus dem Dropdown-Menü aus und klicken Sie auf API-Schlüssel generieren.
Wir werden einen Bestätigungslink an Ihre Benutzer-E-Mail-Adresse senden.
WICHTIG: Generierte API-Schlüssel
API-Schlüssel und API-Geheimschlüssel werden nur in der Benutzeroberfläche von ShipStation angezeigt, wenn sie generiert werden, und nur dem Benutzer, der sie generiert hat. Sie werden in der ShipStation-Benutzeroberfläche ausgeblendet, nachdem Sie die Seite verlassen haben.
Wir empfehlen Ihnen dringend, die API-Schlüssel und API-Geheimschlüssel zu kopieren und sofort nach dem Generieren zu dokumentieren.
Die API-Schlüsselgenerierung ist ausschließlich auf den Kontoinhaber beschränkt
-
Nur der Kontoinhaber kann API-Schlüssel generieren. Dieser muss seine E-Mail-Adresse bestätigen, um auf den API-Schlüssel-Generator zuzugreifen.
-
API-Schlüssel können nur als Text angezeigt werden. Diese Ansicht wird nur einmal verfügbar sein, und zwar unmittelbar nach der Generierung der Schlüssel.
-
Wenn Sie sich nicht sicher sind, wer Inhaber Ihres Kontos ist, kontaktieren Sie support@shipstation.com.
-
-
Überprüfen Sie den Verifizierungslink, den wir an Ihre Benutzer-E-Mail-Adresse gesendet haben, und generieren Sie dann die Schlüssel erneut.
Die Schaltfläche „API-Schlüssel generieren“ wird zurückgesetzt, sobald Sie Ihre E-Mail-Adresse verifiziert haben.
-
Legen Sie das Ablaufdatum (3, 6 oder 12 Monate) für Ihren neuen API-Schlüssel fest und klicken Sie dann auf Generieren.
-
Klicken Sie auf das Symbol Kopieren
, um Ihren neu generierten API-Schlüssel zu kopieren. Bewahren Sie ihn unbedingt sicher auf.
Sie können dann Ihren Schlüssel und Ihr Geheimnis für das Konto angeben, mit dem Sie auf die ShipStation-API zugreifen möchten.
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.
Das Rotieren eines API-Schlüssels bedeutet, dass Sie den alten Schlüssel durch einen neuen ersetzen. In regelmäßigen Abständen müssen Sie einen neuen Schlüssel erstellen, Ihre Integrationen damit aktualisieren und dann den alten Schlüssel löschen.
So rotieren Sie einen API-Schlüssel:
-
Gehen Sie zu Einstellungen > Konto > API-Einstellungen.
-
Suchen Sie den API-Schlüssel, den Sie nicht mehr benötigen, und klicken Sie auf das Papierkorbsymbol
daneben.
-
Klicken Sie im Popup „API-Schlüssel löschen“ auf Schlüssel löschen.
Das Löschen eines API-Schlüssels kann nicht rückgängig gemacht werden. Wenn Sie einen neuen Schlüssel generieren, müssen Sie alle Plattformen aktualisieren, die diesen Schlüssel verwendet haben.
-
Wählen Sie Ihre API-Version aus dem Dropdown-Menü aus und klicken Sie auf API-Schlüssel generieren.
Wir werden einen Bestätigungslink an Ihre Benutzer-E-Mail-Adresse senden.
-
Überprüfen Sie den Verifizierungslink, den wir an Ihre Benutzer-E-Mail-Adresse gesendet haben, und generieren Sie dann die Schlüssel erneut.
Die Schaltfläche „API-Schlüssel generieren“ wird zurückgesetzt, sobald Sie Ihre E-Mail-Adresse verifiziert haben.
-
Legen Sie das Ablaufdatum (3, 6 oder 12 Monate) für Ihren neuen API-Schlüssel fest und klicken Sie dann auf Generieren.
-
Klicken Sie auf das Symbol Kopieren
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-Anfragen ausgeführt werden können. In dieser Dokumentation finden Sie auch Beispiele für Anfragen und Antworten für die API-Kommunikation sowie detaillierte Informationen zur Authentifizierung Ihres API-Schlüssels und -Geheimschlüssels für API-Anfragen.
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 bitte eine E-Mail direkt an unser API-Support-Team.
Für V1 API Support wenden Sie sich bitte an apisupport@shipstation.com und unser Team wird das Problem gemeinsam mit Ihnen untersuchen.
Für V2-API-Support kontaktieren Sie bitte shippingapisupport@shipstation.com, und unser Team wird Ihnen bei der Untersuchung des Problems helfen.
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.
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 E-Mail-Kommunikation an V1 apisupport@shipstation.com oder an V2 shippingapisupport@shipstation.comin CC zu setzen.
-
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 gebengetRate-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. -
Die ShipStation V1 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.