Wie rufe ich Lieferaufträge über die API ab?
Zuletzt aktualisiert:
Mit GET https://easydhl.247apps.de/api/orders rufst du in easyDHL gespeicherte Outbound-Lieferaufträge mit Trackingnummern und vorhandenen Dokumentlinks ab. Retouren-Lieferungen sind ausgeschlossen; ein Retourendokument am Versandvorgang kann trotzdem als retoureUrl erscheinen.
Sende den API-Key aus Einstellungen > DHL als Bearer-Token:
Authorization: Bearer <DEIN_API_KEY>
Accept: application/json
Mindestens from_order_id oder from_order_name ist erforderlich. Bei beiden Parametern hat die ID Vorrang. take begrenzt die Ergebnismenge und ist standardmäßig 1.
curl -G 'https://easydhl.247apps.de/api/orders' \
-H 'Authorization: Bearer <DEIN_API_KEY>' \
-H 'Accept: application/json' \
--data-urlencode 'from_order_name=#1001' \
--data-urlencode 'take=5'
Für Query-Werte verwende skip_first=1 zum Überspringen des Startpunkts oder skip_first=0 zum Einschließen. Die Zeichenketten true und false sind für diesen Parameter ungültig. Optional filtert automated=1 automatische und automated=0 nicht automatische Vorgänge.
Die Antwort enthält ein äußeres Array mit einer inneren Ergebnisliste, beispielsweise:
[
[
{
"order_id": "1234567890",
"order_name": "#1001",
"tracking_number": "00340434161094012345",
"labelUrl": "https://...",
"retoureUrl": null,
"slipUrl": null,
"invoiceUrl": null,
"exportUrl": null,
"exportStickerUrl": null
}
]
]
Ohne Ergebnisse lautet die Antwort [[]]. Die Ausgabe ist nach Bestellname gruppiert und sortiert, nicht als vollständige Liste aller einzelnen Teilsendungen gedacht.
Dokumentlinks können null sein. exportUrl ist das DHL-Exportdokument; exportStickerUrl ist der davon getrennte zusätzliche Exportaufkleber.
Ein fehlender oder ungültiger Schlüssel führt zu 403, fehlende Startparameter oder ungültige Eingaben zu 422. Teile den API-Key niemals in einer Supportanfrage.
Im Handbuch weiterlesen: Packstation-Finder, Trackingportal und Schnittstellen.