Wie kann ich Bestellungen über eine API abrufen und verwalten?

Anbieter:innen können Bestellungen am Marktplatz Lernapps über eine API-Schnittstelle automatisiert abrufen und Bestellungen auf den Status „Ausgeliefert“ setzen.

Die API eignet sich insbesondere für Anbieter:innen, die Bestellungen automatisiert in ihre eigenen Systeme übernehmen und verarbeiten möchten.

1. API-Key erstellen

Den API-Key erstellen Sie in Ihrem Anbieterprofil im Reiter „API-Keys“.

Klicken Sie auf „API-Key erstellen“. Sie können dem Key optional eine Bezeichnung geben, beispielsweise „Produktion“ oder „Staging“.

Nach der Erstellung wird der API-Key nur einmal angezeigt. Kopieren Sie ihn daher sofort und bewahren Sie ihn sicher auf. Der vollständige Schlüssel wird anschließend nicht erneut angezeigt.

2. Bestellungen automatisiert abrufen

Über die API können Bestellungen automatisiert abgerufen werden. Dafür stehen unter anderem die Endpunkte /orders und /orders/{order} zur Verfügung.

Die Bestelldaten enthalten zusätzlich Informationen zum Besteller bzw. zur Bestellerin im Feld „user“, darunter:

• Vorname
• Nachname
• E-Mail-Adresse
• Schule

Die Schule kann über das Feld „school“ ausgelesen werden.

3. Bestellungen als „ausgeliefert“ markieren

Über die API können Bestellungen außerdem automatisiert auf den Status „Ausgeliefert“ gesetzt werden.

4. API statt CSV-Export

Der CSV-Export einzelner Bestellungen bleibt weiterhin verfügbar. Wenn Sie die API nutzen, können die Bestelldaten automatisiert abgerufen und verarbeitet werden. Ein manueller CSV-Export ist für diese Zwecke daher nicht erforderlich.

Weitere Informationen zur technischen Nutzung finden Sie in der  API-Dokumentation des Marktplatz Lernapps .