Vai al contenuto
Come Markdown
Riferimento API

Standorte

5 endpoint

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

Standorte auflisten

get/v1/locations

Alle Standorte der Organisation.

Risposta 200LocationList

NomeTipoDescrizione
objectobbligatorio"list"
dataobbligatorioLocation[]
has_moreobbligatorioboolean

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/locations \n  -H "Authorization: Bearer lh_test_…"
Risposta 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.

Parametri

NomePosizioneTipo
idempotency-keyfacoltativoWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)Intestazionestring

Richiesta

NomeTipoDescrizione
nameobbligatoriostring
streetfacoltativostring | null
postal_codefacoltativostring | null
cityfacoltativostring | null
countryfacoltativostring
latitudefacoltativonumber | null
longitudefacoltativonumber | null
time_zonefacoltativostring
opening_hoursfacoltativostring | null
payment_integration_idfacoltativostring | null
is_publicfacoltativoboolean

Risposta 201Location

NomeTipoDescrizione
idobbligatoriostringID mit Präfix «loc_»
objectobbligatorio"location"
nameobbligatoriostring
streetobbligatoriostring | null
postal_codeobbligatoriostring | null
cityobbligatoriostring | null
countryobbligatoriostring
latitudeobbligatorionumber | null
longitudeobbligatorionumber | null
time_zoneobbligatoriostring
opening_hoursobbligatoriostring | null
payment_integration_idobbligatoriostring | nullZahlungskonto für QR-Zahlungen an diesem Standort
is_publicobbligatorioboolean
created_atobbligatoriostring

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 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}'
Risposta 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.

Parametri

NomePosizioneTipo
idobbligatorioPercorsostring

Risposta 200Location

NomeTipoDescrizione
idobbligatoriostringID mit Präfix «loc_»
objectobbligatorio"location"
nameobbligatoriostring
streetobbligatoriostring | null
postal_codeobbligatoriostring | null
cityobbligatoriostring | null
countryobbligatoriostring
latitudeobbligatorionumber | null
longitudeobbligatorionumber | null
time_zoneobbligatoriostring
opening_hoursobbligatoriostring | null
payment_integration_idobbligatoriostring | nullZahlungskonto für QR-Zahlungen an diesem Standort
is_publicobbligatorioboolean
created_atobbligatoriostring

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/locations/{id} \n  -H "Authorization: Bearer lh_test_…"
Risposta 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.

Parametri

NomePosizioneTipo
idobbligatorioPercorsostring

Richiesta

NomeTipoDescrizione
namefacoltativostring
streetfacoltativostring | null
postal_codefacoltativostring | null
cityfacoltativostring | null
countryfacoltativostring
latitudefacoltativonumber | null
longitudefacoltativonumber | null
time_zonefacoltativostring
opening_hoursfacoltativostring | null
payment_integration_idfacoltativostring | null
is_publicfacoltativoboolean

Risposta 200Location

NomeTipoDescrizione
idobbligatoriostringID mit Präfix «loc_»
objectobbligatorio"location"
nameobbligatoriostring
streetobbligatoriostring | null
postal_codeobbligatoriostring | null
cityobbligatoriostring | null
countryobbligatoriostring
latitudeobbligatorionumber | null
longitudeobbligatorionumber | null
time_zoneobbligatoriostring
opening_hoursobbligatoriostring | null
payment_integration_idobbligatoriostring | nullZahlungskonto für QR-Zahlungen an diesem Standort
is_publicobbligatorioboolean
created_atobbligatoriostring

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/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}'
Risposta 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.

Parametri

NomePosizioneTipo
idobbligatorioPercorsostring

Risposta 200Deleted

NomeTipoDescrizione
idobbligatoriostring
objectobbligatoriostring
deletedobbligatoriotrue

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 DELETE https://api.ladehase.com/v1/locations/{id} \n  -H "Authorization: Bearer lh_test_…"
Risposta 200
{
  "id": "string",
  "object": "string",
  "deleted": true
}