API Dokumentation und Quick Start Guide

Zweck: Alls was Du über die Integration Deines eigenen Webshops über unsere (RESTful) APIs wissen musst.

Zugehörige Links:

• Sendcloud API Referenz
• Sendcloud Entwickler Portal
• API Paketshopzustellung
• Sendcloud APIs FAQ's 
• Integrationsrichtlinien für Marktplätze

Sendcloud bietet Funktionen und Tools, die E-Commerce-Unternehmen helfen, den Versand von Bestellungen zu automatisieren. Unsere vollständig skalierbaren Funktionen machen das Leben von Online-Händlern einfach, egal ob es sich um Einzelunternehmen, Start-Ups oder Großunternehmen mit tausenden Bestellungen im Monat handelt.

Sendcloud integrieren

Es gibt zwei Wege, wie Du Deinen Webshop an Sendcloud anbinden kannst:

Plug-and-Play-Integrationen

Wenn Du eine E-Commerce Plattform wie Shopify, WooCommerce, Lightspeed oder Magento benutzt, musst Du keine eigene Anbindung entwickeln, um Deinen Webshop zu verbinden. Wir bieten hier einfache "Plug-and-Play" Apps und Plugins für mehr als 80 der beliebtesten E-Commerce Plattformen an, die Du einfach aus dem Marktplatz bzw. App-Store des jeweiligen Shopsystems herunterladen kannst.

Sendcloud API

Wenn Du einen selbstgebauten Webshop verwendest, der nicht über eine E-Commerce-Plattform gehostet wird oder erstellt worden ist, kommen unsere APIs in Spiel. Eine API erlaubt es Entwicklern eine Verbindung zu unseren internen Systemen herzustellen und diese direkt in Deinen Webshop zu integrieren. Die Sendcloud APIs sind zu gestaltet, dass sie jede Phase des Versandprozesses abdecken.

Unsere Funktionen können entweder in Kombination miteinander oder einzeln genutzt werden. So erhältst du die Flexibilität, deinen eigenen Workflow von Anfang bis Ende individuell zu gestalten und aufzubauen. Unsere APIs bieten dir Zugriff auf eine große Auswahl nationaler und internationaler Versandoptionen der beliebtesten europäischen Paket- und Postdienstleister.

Bereit loszulegen? Dann lies weiter, um zu lernen, wie unsere APIs funktionieren.

Dokumentation und API Referenz

Wenn Du erfahrener Entwickler bist, der sich einfach schnell in unsere APIs einarbeiten möchte, kommst Du hier direkt zu unserer API Referenz oder Du greifst hier auf unsere Postman Collections zu.

Wenn du neu im Umgang mit APIs bist und eine ausführliche Erklärung dazu erhalten möchtest, wie dein Auftragsverarbeitungs-Workflow aussehen könnte, wirf einen Blick in unsere API-Dokumentation. Dort findest du Schnellstartanleitungen und Tutorials, die dich Schritt für Schritt durch die Grundlagen führen – von der Erstellung deiner ersten Bestellung und deren Versand über die API bis hin zur Erstellung deiner ersten Sendung und dem Vergleich von Versandtarifen.

Was kannst Du alles mit unseren APIs tun?

• Orders API
  Die Orders API hilft dir dabei, deine Bestellungen auf einfache und flexible Weise für den Versand vorzubereiten.

• Ship an Order API
  Die Ship an Order API ist eine Komplettlösung zur Erstellung von Versandlabels für deine Bestellungen. Beim Versand spielen mehrere wichtige Details eine Rolle, wie z. B. Gewicht, bevorzugter Versanddienstleister, Zielland und Versicherung. Mit der Ship an Order API kannst du diesen gesamten Prozess ganz einfach automatisieren.

• Shipments API
  Mit der Shipments API kannst du Sendungen programmgesteuert erstellen und verwalten. Sie ermöglicht dir, den gesamten Sendungslebenszyklus zu automatisieren – ganz ohne manuelle Eingaben in der Plattform – und dabei weiterhin deine Versandregeln und Standardeinstellungen zu nutzen.  
  Alle Sendungen bleiben in deinem Sendcloud-Account sichtbar, sodass du sie jederzeit überprüfen, Fehler beheben oder anpassen kannst.

• Service Points API
  Integriere eine Servicepunkt-Auswahl in deinen Checkout, greife auf eine globale Datenbank mit Servicepunkt-Standorten von Versanddienstleistern zu und ermögliche deinen Kund:innen, einen bequemen Abholort für ihr Paket auszuwählen.

• Returns Portal API
  Lass deine Kund:innen ihre Rücksendungen selbst verwalten, indem du eine individuelle Version des Retourenportals erstellst. Du kannst dies mit der Funktion für kostenpflichtige Rücksendungen kombinieren, um bei Bedarf proaktiv eine Rücksendegebühr zu berechnen.

• Tracking API
  Rufe den vollständigen Sendungsverlauf eines Pakets ab – vom Zeitpunkt der Ankündigung beim Versanddienstleister bis zur Zustellung an der Haustür deiner Kund:innen.

• Pick-ups API
  Plane mit der Pick-ups API eine einmalige Abholung bei einem Versanddienstleister und lasse deine Pakete innerhalb eines ausgewählten Zeitfensters in deinem Lager oder Geschäft abholen.

• Dynamic Checkout API
  Steigere deine Conversion-Rate, indem du im Checkout Optionen wie Next-Day-, Same-Day- oder Wunschtag-Zustellung anbietest. Konfiguriere Versandmethoden pro Lieferzone im Panel und nutze anschließend die API, um die verfügbaren Methoden abzurufen und sie deinen Kund:innen im Checkout anzuzeigen.

• Returns API
  Erstelle eigenständige Rücksendungen mit der Returns API – auch wenn das Paket ursprünglich nicht über deinen Account versendet wurde. Greife auf eine Datenbank verfügbarer Rücksendemethoden zu und validiere deine Rücksendeanfrage vor der Erstellung des Labels. So vermeidest du unnötige Kosten, falls die ausgewählte Rücksendemethode nicht anwendbar ist.

Was ist eine API?

API steht für "Application Programming Interface" (Anwendungsprogrammierschnittstelle). Eine API sorgt dafür, dass Anwendungen über das Internet miteinander kommunizieren können. Um Daten von einer API abzurufen, erstellt man eine "Anfrage" in einer Formatierungssprache wie JSON oder XML oder einer Programmiersprache wie Python an einen Server und der Server gibt die angefragten Dateien in einer "Antwort" zurück. APIs sind dabei nicht nur eine Datenbank - neben der Abfrage von Daten kannst Du auch Daten aktualisieren, erstellen und löschen, indem Du API-Anfragen an bestimmte Endpunkte sendest. 

Zum Beispiel bietet dir die Sendcloud API Zugriff auf den Endpunkt „Create a Shipment“. Du kannst eine Anfrage an diesen Endpunkt senden, um im Sendcloud-System eine Sendung zu erstellen, indem du alle erforderlichen Informationen übermittelst (Adressdaten, Versandoptionen und mehr).  

Um eine Anfrage zu stellen, musst du wissen, welche Informationen unser Server benötigt, um die Sendung zu erstellen. In unserer API-Referenz stellen wir dir Beispielanfragen und -antworten sowie eine Liste der erforderlichen und optionalen Felder zur Verfügung, die du übermitteln kannst.

Erste Schritte

Bist Du bereits für die Integration von Sendcloud-APIs? Bevor Du loslegst, stelle sicher, dass Du ein Sendcloud Konto erstellt und die Schritte aus dem Artikel "Starte mit Sendcloud" durchgeführt hast.

Du musst diesen drei Schritten folgen, damit unsere API Deine Anfragen akzeptiert:

1. Richte Deine Absender- und Retouren- (optional) Adressen ein.
2. Aktiviere mindestens einen Versanddienstleister
3. Richte eine Zahlungsmethode ein (wird benötigt, damit Du Labels erstellen kannst). Erfahre hier mehr darüber, wie Sendcloud Dir erstellte Labels in Rechnung stellt.

Optional: Vergiss nicht, eine Brand zu erstellen, Tracking Benachrichtigungen zu aktivieren und ein Retourenportal einzurichten.

Authentifizierung

Sendcloud verwendet "Basic Authentication", um Anfragen an unsere APIs zu authentifizieren. Du musst einen "öffentlichen" (Public) und "privaten" (Private) API-Schlüssel (Key) in den Header aller Aufrufe an einen Sendcloud-Endpunkt einfügen.

Beispiel: 

curl “https://panel.sendcloud.sc/api/v2/parcels” --user “DEIN_PUBLIC_API_KEY:DEIN_SECRET_API_KEY”

Weitere Beispiele für die Authentifizierung mit unseren APIs findest Du im Abschnitt "Authentication" in unserem Entwicklerportal.

Wie Du Deine API Keys erhältst

1. Melde Dich in Deinem Sendcloud Konto an und gehe zu Einstellungen > Integrationen
2. Finde den Eintrag "Sendcloud API" in der Liste der Integrationen und klicke auf Verbinden
    
3. Gib der API Integration einen Namens (z.B. "Mein Webshop" und klicke auf Speichern
4. Deine Public und Secret API-Keys werden automatisch generiert. Kopiere diese und füge sie dem Header Deiner API-Anfragen hinzu. Dein Public Key ist Dein "Username" bei der Authentifizierung und Dein Secret Key funktioniert wie ein Passwort.

Paketshops einrichten

Auf der Seite mit den Integrationseinstellungen, wie oben im Abschnitt "Authentifizierung" beschrieben, kannst Du auswählen, ob Du Paketshops aktivieren oder deaktivieren möchtest. Um Anfragen an die Service Point API zu erstellen, damit Du Pakete an einen Paketshop versenden oder verfügbare Paketshops in Deinem Checkout anzeigen kannst, musst Du Paketshops dort aktivieren.

Nachdem Du den Haken gesetzt hast, kannst Du Versanddienstleister auswählen, die Du für die Service Point Methoden zur Verfügung stellen möchtest. Klicke danach auf Speichern.

Testlabel erstellen

Du kannst unsere APIs testen, ohne dir Sorgen über unerwartete Kosten machen zu müssen, indem du die Sendcloud-Versandoption „Unstamped Letter“ ("shipping_option_code": "sendcloud:letter")) verwendest. Weitere Informationen zum Erstellen von Testlabels über die API findest du in unserer Dokumentation.

Häufig gestellte Fragen

Wenn du Fragen zur Nutzung unserer APIs hast, wirf einen Blick in unseren Leitfaden „Sendcloud APIs – FAQ“.

IP-Adressen auf der Whitelist