Skip to main content

2.1 Orders List - Auftragsliste abrufen

2.1 Orders List — Auftragsliste abrufen

Zweck

Abrufen einer Liste aller eigenen Aufträge oder der Details eines spezifischen Auftrags.

Endpoint

GET /api.htm?action=orders&data={...}

Berechtigungen

  • Authentifizierung: JWT (Authorization Header). Die Rolle (Customer / Driver / Manager) wird serverseitig aus dem Token bestimmt.
  • Kunde: Zugriff nur auf Aufträge, die dem eigenen Kundenkonto zugeordnet sind.

Parameter

Parameter Typ Pflicht Standardwert Beschreibung
order_id int Nein - Optional: Wenn angegeben, wird nur dieser Auftrag geladen (Detailansicht).
access_token string Nein - Nur bei multipart/form-data Uploads, wenn Header nicht gesetzt werden kann. Alternativ immer im Authorization Header verwenden.

Wertebereiche

Auftragsstatus (status)
ID Konstante Deutscher Text Button-Farbe
1 STATUS_NEW Neuer Auftrag green-haze
2 STATUS_OPEN Status offen blue-madison
3 STATUS_REJECTED Rejected (nicht übersetzt) grey-cascade
4 STATUS_ASSIGNED Zugeordnet green
5 STATUS_IN_PROGRESS Im Einsatz purple-plum
6 STATUS_DELIVERED Einsatz beendet purple
7 STATUS_EXECUTED Auftrag fertigstellen blue
8 STATUS_CONFIRMED Belege und Zeiten korrekt yellow
9 STATUS_INVOICED Fertig für Rechnung green-jungle
12 STATUS_PROBLEM Storniert red
14 STATUS_DRIVER_CONFIRM Auftrag angenommen (für Fahrer: Bestätigt) blue-steel
15 STATUS_RENEW Erneuert green-haze
16 STATUS_PROBLEM_PENALTY Storniert penalty (nur teilweise übersetzt) red
17 STATUS_DISASTER Unfall red
Fahrzeugtyp (car_type)
Wert Bedeutung
1 Neufahrzeug
2 Gebrauchtfahrzeug
0 Nicht gesetzt

Response-Felder

Die Antwort enthält für jeden Auftrag ausschließlich die folgenden Felder:

Feld Typ Beschreibung
id int Eindeutige Auftrags-ID
number string Auftragsnummer
status string Aktueller Status des Auftrags (siehe Wertebereiche)
created string Erstellungsdatum und -zeit (YYYY-MM-DDTHH:MM:SSZ)
pickup_date string Abholdatum (YYYY-MM-DD)
pickup_time string Abholzeit
pickup_at string Firma / Ansprechpartner am Abholort
pickup_name string Name des Abholorts
pickup_phone string Telefonnummer am Abholort
pickup_street string Straße am Abholort
pickup_zip string Postleitzahl des Abholorts
pickup_city string Stadt des Abholorts
delivery_date string Lieferdatum (YYYY-MM-DD)
delivery_time string Lieferzeit
delivery_to string Name des Empfängers / Zielunternehmens
delivery_name string Ansprechpartner am Lieferort
delivery_phone string Telefonnummer am Lieferort
delivery_street string Straße am Lieferort
delivery_zip string Postleitzahl des Lieferorts
delivery_city string Stadt des Lieferorts
car_model string Fahrzeugmodell
car_no_plate string Kennzeichen des Fahrzeugs
car_vin string Fahrzeug-Identifizierungsnummer (FIN)
car_type string Fahrzeugtyp (siehe Wertebereiche)
return_car_model string Modell des Rückgabefahrzeugs
return_car_no_plate string Kennzeichen des Rückgabefahrzeugs
return_car_vin string FIN des Rückgabefahrzeugs
comment string Kommentar zum Auftrag
distance float Entfernung in km
allow_upload boolean Gibt an, ob der Dokument-Upload für diesen Auftrag erlaubt ist

Request-Beispiele

Abruf eines einzelnen Auftrags (JWT Header):

curl -G "https://dev.fahrservicemeybaum.de/api.htm" \
  --data-urlencode "action=orders" \
  --data-urlencode 'data={"order_id":12730}' \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/json"

Abruf aller Aufträge (JWT Header):

curl -G "https://dev.fahrservicemeybaum.de/api.htm" \
  --data-urlencode "action=orders" \
  --data-urlencode 'data={}' \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/json"

Multipart / Upload-Sonderfall (wenn Header nicht möglich):

POST /api.htm?action=order_upload_image
Content-Type: multipart/form-data

Form-Felder:
- data (JSON-String): {"order_id":9070, "title":"Beleg", "access_token":"<access_token>"}
- file: <datei>

Response-Beispiel: einzelner Auftrag (Erfolg)

{
  "status": "success",
  "data": {
    "id": 12730,
    "number": "2608-00421",
    "status": "4",
    "created": "2026-07-15T14:58:13Z",
    "pickup_date": "2026-07-21",
    "pickup_time": "09:30",
    "pickup_at": "Autohaus Beispiel Nord GmbH",
    "pickup_name": "Frau Jana Beispiel",
    "pickup_phone": "+49 40 55501234",
    "pickup_street": "Musterallee 12",
    "pickup_zip": "22761",
    "pickup_city": "Hamburg",
    "delivery_date": "2026-07-22",
    "delivery_time": "14:00",
    "delivery_to": "Mobilitätszentrum Beispiel GmbH",
    "delivery_name": "Herr Max Mustermann",
    "delivery_phone": "+49 4821 555678",
    "delivery_street": "Beispielstraße 45",
    "delivery_zip": "25524",
    "delivery_city": "Itzehoe",
    "car_model": "Audi Q5 Sportback 45 TFSI",
    "car_no_plate": "HH-AB 4721",
    "car_vin": "WAUZZZFY0N1234567",
    "car_type": "1",
    "return_car_model": "Volkswagen Golf VIII",
    "return_car_no_plate": "IZ-CD 9087",
    "return_car_vin": "WVWZZZCDZPW123456",
    "comment": "Bitte Fahrzeug und Unterlagen am Empfang übergeben.",
    "distance": 57.5,
    "allow_upload": false
  }
}

Response-Beispiel: Auftragsliste (Erfolg)

{
  "status": "success",
  "data": [
    {
      "id": 12730,
      "number": "2608-00421",
      "status": "4",
      "created": "2026-07-15T14:58:13Z",
      "pickup_date": "2026-07-21",
      "pickup_time": "09:30",
      "pickup_at": "Autohaus Beispiel Nord GmbH",
      "pickup_name": "Frau Jana Beispiel",
      "pickup_phone": "+49 40 55501234",
      "pickup_street": "Musterallee 12",
      "pickup_zip": "22761",
      "pickup_city": "Hamburg",
      "delivery_date": "2026-07-22",
      "delivery_time": "14:00",
      "delivery_to": "Mobilitätszentrum Beispiel GmbH",
      "delivery_name": "Herr Max Mustermann",
      "delivery_phone": "+49 4821 555678",
      "delivery_street": "Beispielstraße 45",
      "delivery_zip": "25524",
      "delivery_city": "Itzehoe",
      "car_model": "Audi Q5 Sportback 45 TFSI",
      "car_no_plate": "HH-AB 4721",
      "car_vin": "WAUZZZFY0N1234567",
      "car_type": "1",
      "return_car_model": "Volkswagen Golf VIII",
      "return_car_no_plate": "IZ-CD 9087",
      "return_car_vin": "WVWZZZCDZPW123456",
      "comment": "Bitte Fahrzeug und Unterlagen am Empfang übergeben.",
      "distance": 57.5,
      "allow_upload": false
    },
    {
      "id": 12731,
      "number": "2608-00422",
      "status": "2",
      "created": "2026-07-16T08:16:42Z",
      "pickup_date": "2026-07-24",
      "pickup_time": "11:15",
      "pickup_at": "Fahrzeugzentrum Süd GmbH",
      "pickup_name": "Herr Leon Beispiel",
      "pickup_phone": "+49 89 55501290",
      "pickup_street": "Industrieweg 8",
      "pickup_zip": "80331",
      "pickup_city": "München",
      "delivery_date": "2026-07-25",
      "delivery_time": "10:45",
      "delivery_to": "AutoService Beispiel West KG",
      "delivery_name": "Frau Mia Muster",
      "delivery_phone": "+49 221 5550456",
      "delivery_street": "Rheinweg 19",
      "delivery_zip": "50667",
      "delivery_city": "Köln",
      "car_model": "BMW 320d Touring",
      "car_no_plate": "M-XY 3388",
      "car_vin": "WBA6K31070F123456",
      "car_type": "2",
      "return_car_model": "Škoda Octavia Combi",
      "return_car_no_plate": "K-UV 2046",
      "return_car_vin": "TMBJG7NE0P0123456",
      "comment": "Abholung bitte mit dem Ansprechpartner vor Ort abstimmen.",
      "distance": 456.8,
      "allow_upload": false
    }
  ]
}

Fehler-Beispiele

Authentifizierung fehlgeschlagen (ungültiger Token):

{
  "status":"error",
  "error_code":"5",
  "error_reason":"Access/refresh token missing, invalid, revoked, or expired"
}

Auftrag nicht gefunden oder nicht berechtigt:

{
  "data":[],
  "status":"error",
  "error_code":"2",
  "error_reason":"Unknown order"
}

{
  "data":[],
  "status":"error",
  "error_code":"2",
  "error_reason":"Access denied"
}

Sicherheits-Anforderungen

  • Nur authentifizierte Benutzer mit gültigem JWT dürfen den Endpoint verwenden.
  • Kunden können ausschließlich Aufträge abrufen, die ihrem Kundenkonto zugeordnet sind.
  • Die Zuordnung eines Auftrags zum Kunden wird aus dem JWT-Token abgeleitet.
  • Die Response enthält ausschließlich die in dieser Dokumentation aufgeführten Felder.

Hinweise für Integratoren

  • Zugangsdaten nicht in Client-Anwendungen oder öffentlich zugänglichem Quellcode speichern.
  • API-Aufrufe ausschließlich über HTTPS ausführen.
  • Die Auftragsliste kann clientseitig zwischengespeichert und periodisch aktualisiert werden, beispielsweise stündlich.

No comments to display

Back to top