Dokumentation

API-Referenz

POST/api/v1/applications/{id}/orders/{order_id}/documents

Feinstaub-Nachweis hochladen

Der multipart-Upload ist nur verfügbar, wenn next_action.type den Wert upload_vehicle_document trägt. Erforderlich ist orders:write.

Beschreibung

Überträgt den Fahrzeugschein oder zulässigen Emissionsnachweis einer Feinstaubplaketten-Bestellung.

Parameter

idpathPflicht

Öffentliche Antrags-ID.

Beispiel: app_test_1a2b3c4d5e6f708192a3b4c5
order_idpathPflicht

Öffentliche Feinstaubplaketten-Bestellung.

Beispiel: ord_test_5e6f708192a3b4c5d6e7f809
Idempotency-KeyheaderPflicht

Eindeutig für diesen Nachweisupload.

Beispiel: emissions-document-order-5e6f-v1

Request-Body

Der Body wird als multipart/form-data übertragen. Setzen Sie den Content-Type nicht selbst; Ihr HTTP-Client ergänzt die notwendige Boundary.

Request-Felder

fileDateiPflicht

Fahrzeugschein als PDF, JPEG oder PNG; maximal 10 MB.

Erlaubte MIME-Typen: application/pdf,image/jpeg,image/png

Responses

200

Nachweis übernommen; aktualisierte Bestellung wird zurückgegeben.

409

Bestellung erwartet keinen Upload mehr.

413

Nachweis ist zu groß.

415

Dateityp wird nicht unterstützt.

422

Dokument enthält keinen nutzbaren Emissionsnachweis.

Response-Body

Content-Type: application/json. Die erfolgreiche Antwort enthält die nachfolgend beschriebenen Felder.

Response-Felder

FeldTypAngabeBeschreibung
idstringImmerÖffentliche Bestell-ID.
objectstringImmerKonstanter Wert order.
environmentenumImmertest oder live.
livemodebooleanImmertrue für Live-Ressourcen.
application_idstringImmerZugehörige Antrags-ID.
typeenumImmerlicense_plates oder emissions_sticker.
statusenumImmerAktueller Fulfillment-Status der Bestellung.
itemsarrayImmerGebundene Artikel- und Fulfillmentdaten.
amount_totalintegerOptionalBruttobetrag in Euro-Cent.
currencystringImmerDreistelliger ISO-Währungscode.
next_actionobjectOptionalNoch erforderliche Clientaktion und Ziel-URL.
tracking_codestringOptionalVersandverfolgungsnummer.
delivered_atdate-timeOptionalZustellzeitpunkt.
created_at, updated_atdate-timeImmerErstellungs- und Änderungszeitpunkt.
200 Response-Beispieljson
{
  "id": "ord_test_5e6f708192a3b4c5d6e7f809",
  "object": "order",
  "environment": "test",
  "livemode": false,
  "application_id": "app_test_1a2b3c4d5e6f708192a3b4c5",
  "type": "emissions_sticker",
  "status": "completed",
  "items": [
    {
      "simulation": true,
      "vehicle_document_received": true
    }
  ],
  "currency": "EUR",
  "created_at": "2026-08-26T10:24:00+02:00",
  "updated_at": "2026-08-26T10:24:00+02:00"
}

Testsimulation

Mit Testschlüssel wird der Upload nicht an die Dokumentanalyse übergeben. Die Testbestellung wechselt deterministisch zu completed; es entsteht weder eine produktive Bestellung noch ein Versandauftrag.

Zum Öffnen eines Treffers Enter drücken.