Vai al contenuto
Come Markdown
Riferimento API

Organisation

2 endpoint

Le descrizioni degli endpoint provengono direttamente dall'API e sono in tedesco.

Organisation abrufen

get/v1/organization

Einstellungen der Organisation dieses API-Schlüssels: Name, Subdomain der Instanz, MWST, Branding, Testmodus.

Risposta 200Organization

NomeTipoDescrizione
idobbligatoriostringID mit Präfix «org_»
objectobbligatorio"organization"
nameobbligatoriostring
slugobbligatoriostringSubdomain der Instanz
instance_urlobbligatoriostring
test_modeobbligatoriobooleanTestmodus mit simulierten Ladepunkten und Testzahlungen
vat_registeredobbligatorioboolean
vat_numberobbligatoriostring | null
vat_rate_bpsobbligatoriointegerMWST-Satz in Basispunkten (810 = 8.1 %)
accent_colorobbligatoriostring | null

Errori possibili

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Esempio
curl -X GET https://api.ladehase.com/v1/organization \n  -H "Authorization: Bearer lh_test_…"
Risposta 200
{
  "id": "org_9c1f0b7a2e3d4c5b",
  "object": "organization",
  "name": "Hof Meier",
  "slug": "hof-meier",
  "instance_url": "https://hof-meier.ladehase.com",
  "test_mode": true,
  "vat_registered": true,
  "vat_number": "string",
  "vat_rate_bps": 0,
  "accent_color": "string"
}

Organisation ändern

patch/v1/organization

Ändert Name, Subdomain (alte Subdomain bleibt als Weiterleitung), Adresse, MWST, Akzentfarbe, Bedingungen für Fahrende oder Sichtbarkeit der Instanzseite.

Richiesta

NomeTipoDescrizione
namefacoltativostring
slugfacoltativostring
legal_namefacoltativostring | null
streetfacoltativostring | null
postal_codefacoltativostring | null
cityfacoltativostring | null
countryfacoltativostring
contact_emailfacoltativostring | null
contact_phonefacoltativostring | null
websitefacoltativostring | null
vat_registeredfacoltativoboolean
vat_numberfacoltativostring | null
vat_rate_bpsfacoltativointeger
accent_colorfacoltativostring | null
logo_urlfacoltativostring | null
welcome_textfacoltativoobject | null
driver_termsfacoltativoobject | null
public_pagefacoltativoobject
test_modefacoltativoboolean

Risposta 200Organization

NomeTipoDescrizione
idobbligatoriostringID mit Präfix «org_»
objectobbligatorio"organization"
nameobbligatoriostring
slugobbligatoriostringSubdomain der Instanz
instance_urlobbligatoriostring
test_modeobbligatoriobooleanTestmodus mit simulierten Ladepunkten und Testzahlungen
vat_registeredobbligatorioboolean
vat_numberobbligatoriostring | null
vat_rate_bpsobbligatoriointegerMWST-Satz in Basispunkten (810 = 8.1 %)
accent_colorobbligatoriostring | null

Errori possibili

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Esempio
curl -X PATCH https://api.ladehase.com/v1/organization \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"name":"string","slug":"string","legal_name":"string","street":"string","postal_code":"string","city":"string","country":"string","contact_email":"person@example.ch","contact_phone":"string","website":"https://example.ch/webhooks/ladehase","vat_registered":true,"vat_number":"string","vat_rate_bps":0,"accent_color":"string","logo_url":"https://example.ch/webhooks/ladehase","welcome_text":{"de":"string","fr":"string","it":"string","en":"string"},"driver_terms":{"de":"string","fr":"string","it":"string","en":"string"},"public_page":{"showLocations":true,"showTariffs":true,"showMap":true,"showContact":true,"showOpeningHours":true},"test_mode":true}'
Risposta 200
{
  "id": "org_9c1f0b7a2e3d4c5b",
  "object": "organization",
  "name": "Hof Meier",
  "slug": "hof-meier",
  "instance_url": "https://hof-meier.ladehase.com",
  "test_mode": true,
  "vat_registered": true,
  "vat_number": "string",
  "vat_rate_bps": 0,
  "accent_color": "string"
}