Zum Inhalt springen
Als Markdown
API-Referenz

Standorte

5 Endpunkte

Standorte auflisten

get/v1/locations

Alle Standorte der Organisation.

Antwort 200LocationList

NameTypBeschreibung
objectPflicht"list"
dataPflichtLocation[]
has_morePflichtboolean

Mögliche Fehler

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Beispiel
curl -X GET https://api.ladehase.com/v1/locations \n  -H "Authorization: Bearer lh_test_…"
Antwort 200
{
  "object": "list",
  "data": [
    {
      "id": "loc_2b8e1c0d9f7a6b5c",
      "object": "location",
      "name": "Hofladen",
      "street": "string",
      "postal_code": "string",
      "city": "string",
      "country": "string",
      "latitude": 0,
      "longitude": 0,
      "time_zone": "string",
      "opening_hours": "string",
      "payment_integration_id": "string",
      "is_public": true,
      "created_at": "string"
    }
  ],
  "has_more": true
}

Standort anlegen

post/v1/locations

Neuer Standort mit Adresse und Zahlungskonto für QR-Zahlungen.

Parameter

NameOrtTyp
idempotency-keyoptionalWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)Kopfzeilestring

Anfrage

NameTypBeschreibung
namePflichtstring
streetoptionalstring | null
postal_codeoptionalstring | null
cityoptionalstring | null
countryoptionalstring
latitudeoptionalnumber | null
longitudeoptionalnumber | null
time_zoneoptionalstring
opening_hoursoptionalstring | null
payment_integration_idoptionalstring | null
is_publicoptionalboolean

Antwort 201Location

NameTypBeschreibung
idPflichtstringID mit Präfix «loc_»
objectPflicht"location"
namePflichtstring
streetPflichtstring | null
postal_codePflichtstring | null
cityPflichtstring | null
countryPflichtstring
latitudePflichtnumber | null
longitudePflichtnumber | null
time_zonePflichtstring
opening_hoursPflichtstring | null
payment_integration_idPflichtstring | nullZahlungskonto für QR-Zahlungen an diesem Standort
is_publicPflichtboolean
created_atPflichtstring

Mögliche Fehler

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Beispiel
curl -X POST https://api.ladehase.com/v1/locations \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"name":"string","street":"string","postal_code":"string","city":"string","country":"CH","latitude":-90,"longitude":-180,"time_zone":"Europe/Zurich","opening_hours":"string","payment_integration_id":"string","is_public":true}'
Antwort 201
{
  "id": "loc_2b8e1c0d9f7a6b5c",
  "object": "location",
  "name": "Hofladen",
  "street": "string",
  "postal_code": "string",
  "city": "string",
  "country": "string",
  "latitude": 0,
  "longitude": 0,
  "time_zone": "string",
  "opening_hours": "string",
  "payment_integration_id": "string",
  "is_public": true,
  "created_at": "string"
}

Standort abrufen

get/v1/locations/{id}

Ein Standort.

Parameter

NameOrtTyp
idPflichtPfadstring

Antwort 200Location

NameTypBeschreibung
idPflichtstringID mit Präfix «loc_»
objectPflicht"location"
namePflichtstring
streetPflichtstring | null
postal_codePflichtstring | null
cityPflichtstring | null
countryPflichtstring
latitudePflichtnumber | null
longitudePflichtnumber | null
time_zonePflichtstring
opening_hoursPflichtstring | null
payment_integration_idPflichtstring | nullZahlungskonto für QR-Zahlungen an diesem Standort
is_publicPflichtboolean
created_atPflichtstring

Mögliche Fehler

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Beispiel
curl -X GET https://api.ladehase.com/v1/locations/{id} \n  -H "Authorization: Bearer lh_test_…"
Antwort 200
{
  "id": "loc_2b8e1c0d9f7a6b5c",
  "object": "location",
  "name": "Hofladen",
  "street": "string",
  "postal_code": "string",
  "city": "string",
  "country": "string",
  "latitude": 0,
  "longitude": 0,
  "time_zone": "string",
  "opening_hours": "string",
  "payment_integration_id": "string",
  "is_public": true,
  "created_at": "string"
}

Standort ändern

patch/v1/locations/{id}

Ändert Name, Adresse, Öffnungszeiten oder das Zahlungskonto.

Parameter

NameOrtTyp
idPflichtPfadstring

Anfrage

NameTypBeschreibung
nameoptionalstring
streetoptionalstring | null
postal_codeoptionalstring | null
cityoptionalstring | null
countryoptionalstring
latitudeoptionalnumber | null
longitudeoptionalnumber | null
time_zoneoptionalstring
opening_hoursoptionalstring | null
payment_integration_idoptionalstring | null
is_publicoptionalboolean

Antwort 200Location

NameTypBeschreibung
idPflichtstringID mit Präfix «loc_»
objectPflicht"location"
namePflichtstring
streetPflichtstring | null
postal_codePflichtstring | null
cityPflichtstring | null
countryPflichtstring
latitudePflichtnumber | null
longitudePflichtnumber | null
time_zonePflichtstring
opening_hoursPflichtstring | null
payment_integration_idPflichtstring | nullZahlungskonto für QR-Zahlungen an diesem Standort
is_publicPflichtboolean
created_atPflichtstring

Mögliche Fehler

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Beispiel
curl -X PATCH https://api.ladehase.com/v1/locations/{id} \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"name":"string","street":"string","postal_code":"string","city":"string","country":"CH","latitude":-90,"longitude":-180,"time_zone":"Europe/Zurich","opening_hours":"string","payment_integration_id":"string","is_public":true}'
Antwort 200
{
  "id": "loc_2b8e1c0d9f7a6b5c",
  "object": "location",
  "name": "Hofladen",
  "street": "string",
  "postal_code": "string",
  "city": "string",
  "country": "string",
  "latitude": 0,
  "longitude": 0,
  "time_zone": "string",
  "opening_hours": "string",
  "payment_integration_id": "string",
  "is_public": true,
  "created_at": "string"
}

Standort löschen

delete/v1/locations/{id}

Nur Standorte ohne Geräte.

Parameter

NameOrtTyp
idPflichtPfadstring

Antwort 200Deleted

NameTypBeschreibung
idPflichtstring
objectPflichtstring
deletedPflichttrue

Mögliche Fehler

  • 400 Anfrage ungültig
  • 401 Nicht angemeldet
  • 403 Berechtigung fehlt
  • 404 Nicht gefunden
  • 409 Zustand passt nicht
  • 429 Zu viele Anfragen
Beispiel
curl -X DELETE https://api.ladehase.com/v1/locations/{id} \n  -H "Authorization: Bearer lh_test_…"
Antwort 200
{
  "id": "string",
  "object": "string",
  "deleted": true
}