Skip to main content
Diese API befindet sich im Testing. Produktive Nutzung wird noch nicht empfohlen.

​
Definition

Kunden repräsentieren Unternehmen, denen ÖPNV-Tickets zugeordnet werden. Die Kundendaten (Name, Adresse) werden für die Erstellung von Sammelrechnungen benötigt. Jeder Kunde gehört zu einer Organisation und kann beliebig viele Tickets haben.

​
Kunde erstellen (CREATE)

Erstellt einen neuen Kunden mit Rechnungsadresse. Die Adresse wird automatisch an die Mobility Box API übermittelt. 
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "organization_id": "org-uuid",
  "mobilitybox_customer_id": "mb_cust_abc123",
  "name": "Mustermann GmbH",
  "address_lines": {
    "street": "Musterstraße 1",
    "postal_code": "50667",
    "city": "Köln"
  },
  "created_at": "2026-03-27T10:00:00.000Z",
  "updated_at": "2026-03-27T10:00:00.000Z"
}

​
Request Body

FeldTypPflichtBeschreibung
namestringjaName des Unternehmens
streetstringneinStraße und Hausnummer
postal_codestringneinPostleitzahl
citystringneinStadt
Die Adressfelder (street, postal_code, city) werden für die Rechnungserstellung benötigt. Ohne Adresse können keine Sammelrechnungen erstellt werden.

​
Kunden auflisten (READ)

Listet alle Kunden der Organisation auf, sortiert nach Erstellungsdatum (neueste zuerst). 
[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "organization_id": "org-uuid",
    "mobilitybox_customer_id": "mb_cust_abc123",
    "name": "Mustermann GmbH",
    "address_lines": {
      "street": "Musterstraße 1",
      "postal_code": "50667",
      "city": "Köln"
    },
    "created_at": "2026-03-27T10:00:00.000Z",
    "updated_at": "2026-03-27T10:00:00.000Z"
  }
]

​
Kunde abrufen (READ)

Ruft die Details eines Kunden inkl. zugehöriger Tickets ab. 
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Mustermann GmbH",
  "address_lines": {
    "street": "Musterstraße 1",
    "postal_code": "50667",
    "city": "Köln"
  },
  "tickets": [
    {
      "id": "ticket-uuid",
      "product_name": "Deutschlandticket",
      "status": "active",
      "valid_from": "2026-04-01T00:00:00.000Z",
      "valid_until": "2026-04-30T23:59:59.000Z"
    }
  ]
}

​
Kunde aktualisieren (UPDATE)

Aktualisiert Name und/oder Adresse eines Kunden. Nur übergebene Felder werden geändert, bestehende Werte bleiben erhalten.

​
Request Body

FeldTypPflichtBeschreibung
namestringneinNeuer Name
streetstringneinNeue Straße
postal_codestringneinNeue Postleitzahl
citystringneinNeue Stadt

​
Kunde löschen (DELETE)

Entfernt einen Kunden. Bereits erstellte Tickets und Rechnungen bleiben bestehen. 
{
  "ok": true
}

​
Verbrauch

Für die Kundenverwaltung werden keine Credits berechnet.