Zum Inhalt springen
LOGICAR Entwickler Suchen

#Aufträge abfragen und ändern

Auf dieser Seite

#Lesen und suchen

GET /orders/{id} (Recht orders:read) liefert den Auftrag in derselben Form wie die Antwort beim Anlegen (Auftrag anlegen). {id} ist unsere Kennung, die Auftragsnummer oder die Anfragenummer.

GET /orders listet Ihre Aufträge, die neuesten zuerst:

ParameterBedeutung
externalOrderIdNur der Vorgang mit Ihrer eigenen Nummer — höchstens einer: der Auftrag, oder die Anfrage, solange sie auf ein Angebot wartet.
updatedSinceNur, was sich seit diesem Zeitpunkt geändert hat. Damit holt Ihr System nach, was während einer Störung seines Webhook-Endpunkts nicht ankam.
limitEinträge je Seite, 1 bis 100, ohne Angabe 20.
cursorFür die nächste Seite: nextCursor der letzten Antwort, unverändert. nextCursor: null heißt, es gibt keine weitere.

#Ändern

PATCH /orders/{id} (Recht orders:write) ändert einen Auftrag bis zur Abholung. Schicken Sie nur, was sich ändert; null löscht Referenz, Wunschtermine oder Hinweis.

FeldBedeutung
customerReferenceIhre Referenz.
requestedPickup, requestedDeliveryWunschtermine. Ein verschobener Termin kommt als order.rescheduled.
pickup.contact, delivery.contactAnsprechpartner vor Ort (name, phone).
instructionsHinweis für Disposition und Fahrer.
vehicle.vin, vehicle.registration.licensePlateFahrgestellnummer und Kennzeichen, etwa wenn sie beim Anlegen noch fehlten.
metadataIhre freien Daten; ersetzt die bisherigen.

Adressen und Transportart lassen sich nicht ändern — an ihnen hängen Preis und Planung. Dafür stornieren Sie und legen neu an. Ab der Abholung antwortet PATCH mit 409 ORDER_NOT_CHANGEABLE; dann ist ein Fahrer mit dem Fahrzeug unterwegs, und die Änderung klärt ein Mensch mit uns. Eine Anfrage, die auf ein Angebot wartet, ist nicht änderbar: ziehen Sie sie zurück und stellen Sie sie neu.

#Stornieren

POST /orders/{id}/cancel (Recht orders:write) storniert einen Auftrag bis zur Abholung — oder zieht eine Anfrage zurück. Den Grund dürfen Sie mitschicken:

json
{ "reason": "Fahrzeug verkauft" }

Die Antwort ist der Auftrag mit Status CANCELLED (eine Anfrage: REJECTED); Ihr Webhook-Endpunkt bekommt order.cancelled bzw. order.rejected. Zweimal stornieren schadet nicht: der zweite Aufruf antwortet mit dem stornierten Auftrag. Ab der Abholung antwortet die Schnittstelle 409 ORDER_NOT_CANCELLABLE. Liegt zu einer Anfrage schon ein Angebot vor, lehnen Sie das Angebot ab: POST /quotes/{id}/decline (Angebote); /cancel antwortet dann 409 REQUEST_HAS_QUOTE.

Hinweis

Ob und welche Kosten eine Stornierung auslöst, regeln Ihre Vereinbarung und unsere AGB — die Antwort nennt keine Gebühr.

#Stand

GET /orders/{id}/status (Recht orders:read) ist die kurze Antwort auf „wo steht der Auftrag?“: status, readiness, Wunsch- und tatsächliche Termine und während der Fahrt die errechnete Ankunft (estimatedDelivery). Die Werte von status stehen unter Auftragsstatus.

#Sendungsverfolgung

GET /orders/{id}/tracking (Recht tracking:read) liefert während der Fahrt den Standort des Fahrzeugs und die errechnete Ankunft:

  • location gibt es nur zwischen Abholung und Zustellung und nur, wenn der Fahrer der Standortfreigabe zugestimmt hat — im Takt, der für Ihr Konto eingestellt ist. stale: true heißt: die letzte Position ist älter als erwartet.
  • Ohne Position sagt locationUnavailableReason warum: NOT_IN_TRANSIT (noch nicht abgeholt oder schon zugestellt), NO_POSITION (unterwegs, aber keine Position) oder SANDBOX.
  • estimatedPickup, estimatedDelivery und distanceRemainingKm rechnet LOGICAR aus der Position.
  • driver nennt den Fahrer mit Vorname und Initial — nur, wenn Ihr Konto das vorsieht. Telefon oder E-Mail des Fahrers gibt die Schnittstelle nie heraus.

Für Ihren Empfänger ist trackingUrl gedacht: die öffentliche Seite zur Sendungsverfolgung, ohne Anmeldung.

#Dokumente

GET /orders/{id}/documents (Recht documents:read) listet die Dokumente am Auftrag mit Art, Dateiname, Größe, SHA-256 und downloadUrl:

ArtWas es istRecht
PICKUP_PROTOCOL, DELIVERY_PROTOCOLÜbergabeprotokolle bei Abholung und Zustellungdocuments:read
DAMAGE_REPORTSchadensberichtdocuments:read
AUTHORIZATIONUnterschriebene Vollmachtdocuments:read
VEHICLE_DOCUMENTUnterlagen zum Fahrzeugdocuments:read
INVOICERechnungzusätzlich invoices:read
QUOTE, SIGNED_QUOTEAngebot, unterschrieben angenommenes Angebotzusätzlich quotes:read

GET /orders/{id}/documents/{documentId} liefert die Datei selbst (meist PDF). Sie kommt nur heraus, wenn sie seit der Ablage unverändert ist — prüfen Sie nach dem Herunterladen die SHA-256 aus der Liste. Ein neues Dokument meldet der Webhook document.uploaded.