Filialen

API Dokumentation – Filialen

Endpunkt /api/branches zum Abruf der Filial-IDs, Filialnamen und Anschriften. Mit diesen IDs lassen sich die filialbezogenen Datensätze der übrigen APIs zuordnen.

Authentifizierung
Der Endpunkt erfordert den Parameter token mit dem gültigen API-Token.
Bei ungültigem oder fehlendem Token wird HTTP 401 mit {"data": [], "status": 0, "message": "Invalid Token"} zurückgegeben.

Endpunkte

GET
/api/branches

Gibt alle Filialen der Instanz zurück – aktive und inaktive. So bleiben historische Belege einer inzwischen deaktivierten Filiale auflösbar. Die Antwort enthält nur Stammdaten und Anschrift, keine Zugangsdaten, Kassen- oder TSE-Informationen.

Parameter

Name Typ Beschreibung
token string API-Token Pflicht
id integer Einzelne Filiale anhand der Filial-ID (branch_id) optional
Beispiel-Aufrufe
GET /api/branches?token=IHRGEHEIMERCATAMATOKEN
    (alle Filialen)

GET /api/branches?token=IHRGEHEIMERCATAMATOKEN&id=2
    (nur Filiale 2)

Felder je Filiale

Feld Typ Beschreibung
branch_id integer Filial-ID. Dieselbe ID steht in den filialbezogenen APIs als branch_id
branch_name string Name der Filiale
branch_status integer 1 = aktiv, 0 = inaktiv
street string Straße
house_number string Hausnummer
address_extra string Adresszusatz
postal_code string Postleitzahl
city string Ort
state_region string Bundesland / Region
country string Land
phone string Telefon
email string E-Mail der Filiale
contact_person string Ansprechpartner
ustid string USt-IdNr. der Filiale
Nicht enthalten: Die API gibt keine Tokens, Remote-Zugänge, Kassen- oder TSE-Zertifikate, API-Passwörter, Bankdaten, FiBu-IDs oder Kostenstellen aus.
Erfolgreiche Antwort
{
  "data": [
    {
      "branch_id": 1,
      "branch_name": "Hauptbetrieb",
      "branch_status": 1,
      "street": "Musterstraße",
      "house_number": "12",
      "address_extra": "",
      "postal_code": "12345",
      "city": "Musterstadt",
      "state_region": "",
      "country": "Deutschland",
      "phone": "01234 567890",
      "email": "info@beispiel.de",
      "contact_person": "",
      "ustid": "DE123456789"
    }
  ],
  "status": 1,
  "message": "Success"
}
Fehler
{ "data": [], "status": 0, "message": "Invalid Token" }
{ "data": [], "status": 0, "message": "Parameter id is required and must be > 0" }
{ "data": [], "status": 0, "message": "Branch not found" }
Zuordnung: Artikel, Bestandsfahrzeuge, Kundenfahrzeuge und Belege tragen dieselbe branch_id. Den Namen und die Anschrift der Filiale holen Sie über diesen Endpunkt.

Bei Fragen zur API steht Ihnen unser Support jederzeit zur Verfügung.

Ähnliche Artikel