Kundenfahrzeugdaten

API Dokumentation – Kundenfahrzeuge

Alle Endpunkte unter /api/customerscars/ zum Abruf, zur Suche und zur Anlage von Kundenfahrzeugen.

Authentifizierung
Alle Endpunkte erfordern den Parameter token mit dem gültigen API-Token.
Bei ungültigem Token wird {"status": 0, "message": "Invalid Token"} zurückgegeben.

Endpunkte

GET
/api/customerscars/list

Gibt eine paginierbare Liste aller aktiven Kundenfahrzeuge zurück. Optional mit Kundendaten.

Parameter

Name Typ Beschreibung
token string API-Token Pflicht
take integer Anzahl der Ergebnisse (Limit) optional
offset integer Startposition fuer Paginierung optional
statusid integer Status-Typ filtern (Standard: 1) optional
withcustomerdata integer 1 = Kundendaten mitsenden, 0 = ohne (Standard: 0) optional
Paginierung: Ohne take und offset werden alle Fahrzeuge ausgegeben. Fuer grosse Datenmengen empfohlen: z. B. offset=0&take=50, dann offset=50&take=50 usw.
Erfolgreiche Antwort
{
  "data": {
    "1085": {
      "id": 1085,
      "customer_id": 200,
      "intern_id": "KFZ-001",
      "fabricator_id": 3,
      "fabricator": "Volkswagen",
      "name": "Golf VII",
      "modell": "1.4 TSI",
      "chassis_number": "WVWZZZ3CZWE123456",
      "plate": "B-AB 1234",
      "registration_date": "15.03.2019",
      "mileage": 85000,
      "power_ps": 150,
      "power_kw": 110,
      "general_inspection": "03.2026",
      "..."
    },
    "1086": { "..." }
  },
  "status": 1,
  "message": "Success"
}
Alle Felder im Fahrzeug-Objekt anzeigen
Feld Beschreibung
id Fahrzeug-ID
customer_id Zugeordneter Kunde
intern_id Interne Nummer
fabricator_id Fabrikat-ID
fabricator Fabrikat-Name
kind_id Fahrzeugart-ID
name Fahrzeugbezeichnung
modell Modellbezeichnung
chassis_number Fahrgestellnummer (VIN)
plate Kennzeichen
registration_date Erstzulassung (dd.mm.YYYY)
mileage Kilometerstand
power_ps Leistung in PS
power_kw Leistung in kW
cubic Hubraum in ccm
general_inspection HU/AU Datum
key_code Schluesselcode
guaranteestart Garantie-Start
guaranteeend Garantie-Ende
warrantystart Gewaehrleistung-Start
warrantyend Gewaehrleistung-Ende
handoverinspection Uebergabeinspektion
last_check Letzte Pruefung
salestype Verkaufstyp-ID
weight Gewicht
added_time Angelegt am
expected_delivery_date Voraussichtliches Lieferdatum
warranty_description Garantiebeschreibung
contract_notes Vertragsnotizen
deliverer_id Lieferanten-ID
vehicle_key_code Fahrzeug-Schluesselcode
vehicle_registration_code Fahrzeugbrief-Code
motor_code Motorcode
motor_type Motortyp
color Farbe
basic_color Grundfarbe
interiorcolor Innenraumfarbe
seats Sitzplaetze
gas Kraftstoffart
emission_id Emissionsklasse
geartype_id Getriebeart-ID
drivetype_id Antriebsart-ID
purchased_at Kaufdatum
oil_drain_screw_torque Oelablassschrauben-Drehmoment
engine_oil_info Motoroel-Info
nextservice_at Naechster Service
radio_code Radiocode
keys_amount Anzahl Schluessel
cambelt_info Zahnriemen-Info
description_html HTML-Beschreibung

GET
/api/customerscars/byid

Ruft ein oder mehrere Kundenfahrzeuge anhand der Fahrzeug-ID oder der Kunden-ID ab. Es darf nur einer der beiden Parameter angegeben werden.

Parameter

Name Typ Beschreibung
token string API-Token Pflicht
id integer Fahrzeug-ID (entweder id oder customerid)
customerid integer Kunden-ID – gibt alle Fahrzeuge des Kunden zurueck (entweder id oder customerid)
statusid integer Status-Typ filtern (Standard: 1, nur bei customerid) optional
withcustomerdata integer 1 = Kundendaten mitsenden (Standard: 0) optional
Hinweis: Es muss genau einer der Parameter id oder customerid angegeben werden. Werden beide oder keiner angegeben, wird ein Fehler zurueckgegeben.
Beispiel-Aufruf per Fahrzeug-ID
GET /api/customerscars/byid?token=xxx&id=1085
Beispiel-Aufruf per Kunden-ID
GET /api/customerscars/byid?token=xxx&customerid=200&withcustomerdata=1
Erfolgreiche Antwort
{
  "data": {
    "1085": {
      "id": 1085,
      "customer_id": 200,
      "fabricator": "Volkswagen",
      "name": "Golf VII",
      "chassis_number": "WVWZZZ3CZWE123456",
      "plate": "B-AB 1234",
      "customer_data": {
        "id": 200,
        "company": "Muster GmbH",
        "forename": "Max",
        "lastname": "Mustermann",
        "..."
      },
      "..."
    }
  },
  "status": 1,
  "message": "Success"
}
Fehler
{ "status": 0, "message": "Invalid Customer ID" }
{ "status": 0, "message": "Car or Customer ID is missing OR both provided" }

Die Fahrzeug-Felder im Response sind identisch mit /api/customerscars/list. Bei withcustomerdata=1 wird zusaetzlich ein customer_data-Objekt mitgeliefert.

GET
/api/customerscars/byparam

Sucht Kundenfahrzeuge anhand der Fahrgestellnummer (VIN) und/oder des Kennzeichens. Die Suche erfolgt als Teilstring-Suche.

Parameter

Name Typ Beschreibung
token string API-Token Pflicht
vin string Fahrgestellnummer (VIN) oder Teil davon (mind. vin oder plate)
plate string Kennzeichen oder Teil davon (mind. vin oder plate)
withcustomerdata integer 1 = Kundendaten mitsenden (Standard: 0) optional
Suchlogik: Mindestens einer der Parameter vin oder plate muss angegeben werden. Werden beide angegeben, werden Fahrzeuge gefunden, die auf einen der beiden Werte passen (OR-Verknuepfung). Die Suche ist nicht case-sensitive und findet auch Teilstrings (z. B. vin=ZZZ3CZ).
Beispiel-Aufrufe
GET /api/customerscars/byparam?token=xxx&vin=WVWZZZ3CZWE123456
GET /api/customerscars/byparam?token=xxx&plate=B-AB
GET /api/customerscars/byparam?token=xxx&vin=ZZZ3CZ&plate=B-AB&withcustomerdata=1
Erfolgreiche Antwort
{
  "data": {
    "1085": {
      "id": 1085,
      "customer_id": 200,
      "chassis_number": "WVWZZZ3CZWE123456",
      "plate": "B-AB 1234",
      "fabricator": "Volkswagen",
      "name": "Golf VII",
      "..."
    }
  },
  "status": 1,
  "message": "Success"
}
Fehler
{ "status": 0, "message": "vin or plate parameter is required" }

Die Fahrzeug-Felder im Response sind identisch mit /api/customerscars/byid.

POST
/api/customerscars/create

Legt ein neues Kundenfahrzeug an. Der angegebene Kunde und das Fabrikat muessen bereits im System existieren.

Pflichtparameter

Name Typ Beschreibung
token string API-Token Pflicht
customer_id integer ID des Kunden Pflicht
fabricator integer ID des Fabrikats (siehe Fabrikate-API) Pflicht
name string Fahrzeugbezeichnung, z. B. „Golf VII“ Pflicht

Optionale Parameter

Name Typ Beschreibung
modell string Modellbezeichnung
chassis_number string Fahrgestellnummer (VIN)
mobile_sign string Kennzeichen
ez string Erstzulassung – Formate: 01.03.2020, 03/2020 oder 2020
mileage integer Kilometerstand
color string Farbe
color_code string Farbcode
color_designation string Farbbezeichnung
cubic integer Hubraum in ccm
power_kw integer Leistung in kW
power_ps integer Leistung in PS
mobile_gas string Kraftstoffart
geartype integer Getriebeart
drivetype integer Antriebsart
general_inspection string HU/AU – Formate: 03/2026 oder 01.03.2026
category_id integer Warengruppe (Standard: 1)
co2 integer CO2-Ausstoss in g/km
emission_id integer Emissionsklasse
seats integer Anzahl Sitzplaetze
previous_owner integer Anzahl Vorbesitzer
tsnumber string TSN / Schluesselnummer
intern_id string Interne Nummer
serial_number string Seriennummer
motor_code string Motorcode
motor_type string Motortyp
mobile_desc string Kurzbeschreibung
mobile_notes string Notizen
mobile_kind integer Fahrzeugart (Standard: 2)
branch_id integer Filial-ID
weight integer Gewicht in kg
model_year integer Modelljahr
Erfolgreiche Antwort
{
  "data": {
    "clientmobile_id": 1085,
    "customer_id": 200,
    "fabricator": 3,
    "name": "Golf VII",
    "modell": "1.4 TSI",
    "mobile_sign": "B-AB 1234"
  },
  "status": 1,
  "message": "Success",
  "clientmobile_id": 1085
}
Fehler – Beispiele
{ "status": 0, "message": "customer_id is required" }
{ "status": 0, "message": "fabricator is required" }
{ "status": 0, "message": "name is required" }
{ "status": 0, "message": "Customer not found" }
{ "status": 0, "message": "Fabricator not found" }

Kundendaten-Objekt (withcustomerdata=1)

Wenn bei /list, /byid oder /byparam der Parameter withcustomerdata=1 gesetzt wird, enthaelt jedes Fahrzeug-Objekt ein zusaetzliches Feld customer_data mit folgenden Feldern:

Feld Beschreibung
id Kunden-ID
title_id Anrede-ID
title Anrede (z. B. „Herr“)
company Firmenname
forename Vorname
lastname Nachname
extra Zusatz
street Strasse
zip PLZ
city Stadt
country Land
phone_mobile Mobilnummer
phone_primary Telefon (privat)
phone_secondary Telefon (geschaeftlich)
email_primary E-Mail
email_secondary E-Mail 2
email_tertiary E-Mail 3
kind_id Kundenart-ID
kind_name Kundenart
type_id Kundentyp-ID
type_name Kundentyp
type_shortcode Kundentyp-Kuerzel
bank_name Bankname
bank_account_holder Kontoinhaber
bank_iban IBAN
bank_bic BIC
birthday Geburtstag (dd.mm.YYYY)
online_invoice Online-Rechnung (0/1)

Ähnliche Artikel