Die API-Integration für eigene Systeme nutzen - Integrationen

Die API-Integration für eigene Systeme nutzen - Integrationen | AutoLetter Help Center

Mit der API-Integration kannst du Bestellungen direkt aus deinem eigenen System an AutoLetter übertragen. Das ist ideal für Eigenentwicklungen, individuelle Shopsysteme oder automatisierte Workflows, die sich nicht über die Standard-Integrationen (Billbee, Shopify) abbilden lassen.

Integration anlegen

Navigiere zu Integrationen, klicke auf Hinzufügen und wähle API als Integrationstyp aus.

Integration benennen

Vergib einen aussagekräftigen Namen, z. B. „Eigener Shop API" oder „ERP-System".

Zugangsdaten erhalten

Nach dem Speichern erhältst du die API-Endpunkt-URL und kannst einen JWT-Token für die Authentifizierung generieren.

Den JWT-Token für die API-Authentifizierung generierst du in deinem Workspace in AutoLetter. Bewahre diesen Token sicher auf und teile ihn nicht mit Unbefugten.

Bestellungen werden als JSON-Array per POST-Request an den API-Endpunkt gesendet. Die Authentifizierung erfolgt über einen Bearer JWT-Token im Authorization-Header.

curl -X POST https://api.autoletter.eu/v2/orders \
  -H "Authorization: Bearer DEIN_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "OrderNumber": "ORD-2026-001",
      "OrderId": "12345",
      "Date": "2026-02-20T10:30:00Z",
      "Total": 89.99,
      "Address": {
        "FirstName": "Max",
        "LastName": "Mustermann",
        "Street": "Musterstraße",
        "HouseNumber": "42",
        "ZIP": "10115",
        "City": "Berlin",
        "Country": "DE"
      }
    }
  ]'

Jede Bestellung muss die folgenden Felder enthalten:

Feld	Typ	Beschreibung
`OrderNumber`	String	Die Bestellnummer
`OrderId`	String	Eine eindeutige Bestell-ID
`Date`	String (ISO 8601)	Das Bestelldatum
`Total`	Number	Der Gesamtbetrag der Bestellung
`Address`	Object

Das Address-Objekt enthält die Lieferadresse und muss mindestens Name, Straße, PLZ, Stadt und Land enthalten.

Zusätzlich zu den Pflichtfeldern kannst du folgende optionale Felder übermitteln:

Feld	Typ	Beschreibung
`ExternalId`	String	Externe Referenz-ID aus deinem System
`ShopId`	String	Shop-Kennung bei Mehrshop-Betrieb
`InvoiceAddress`	Object	Abweichende Rechnungsadresse
`LetterAddress`	Object	Abweichende Adresse für den Briefversand
`Products`	Array

Standardmäßig werden nur neue Bestellungen angelegt. Wenn du bestehende Bestellungen aktualisieren möchtest, füge den Parameter allowUpdates zu deinem Request hinzu:

{
  "allowUpdates": true,
  "orders": [...]
}

Mit aktiviertem allowUpdates werden Bestellungen mit übereinstimmender OrderId aktualisiert, anstatt abgelehnt zu werden.

Im Gegensatz zu Billbee und Shopify gibt es bei der API-Integration keine Synchronisationsverzögerung. Bestellungen, die du per API sendest, sind sofort in AutoLetter verfügbar und können direkt in Kampagnen verwendet werden.

Die API gibt standardisierte HTTP-Statuscodes zurück:

200 OK – Bestellungen erfolgreich verarbeitet
400 Bad Request – Fehlerhafte Daten (Details im Response-Body)
401 Unauthorized – Ungültiger oder fehlender JWT-Token
429 Too Many Requests – Rate Limit erreicht

Bei Fehlern enthält die Antwort detaillierte Informationen zu den betroffenen Datensätzen.