Standorte

5 endpoints

The endpoint descriptions come directly from the API and are in German.

Standorte auflisten

get/v1/locations

Alle Standorte der Organisation.

Response 200LocationList

Name	Type	Description
`object`required	"list"
`data`required	Location[]
`has_more`required	boolean

Possible errors

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Example

curl -X GET https://api.ladehase.com/v1/locations \n  -H "Authorization: Bearer lh_test_…"

Response 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.

Parameters

Name	In	Type
`idempotency-key`optionalWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)	Header	string

Request

Name	Type	Description
`name`required	string
`street`optional	string \| null
`postal_code`optional	string \| null
`city`optional	string \| null
`country`optional	string
`latitude`optional	number \| null
`longitude`optional	number \| null
`time_zone`optional	string
`opening_hours`optional	string \| null
`payment_integration_id`optional	string \| null
`is_public`optional	boolean

Response 201Location

Name	Type	Description
`id`required	string	ID mit Präfix «loc_»
`object`required	"location"
`name`required	string
`street`required	string \| null
`postal_code`required	string \| null
`city`required	string \| null
`country`required	string
`latitude`required	number \| null
`longitude`required	number \| null
`time_zone`required	string
`opening_hours`required	string \| null
`payment_integration_id`required	string \| null	Zahlungskonto für QR-Zahlungen an diesem Standort
`is_public`required	boolean
`created_at`required	string

Possible errors

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Example

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

Response 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.

Parameters

Name	In	Type
`id`required	Path	string

Response 200Location

Name	Type	Description
`id`required	string	ID mit Präfix «loc_»
`object`required	"location"
`name`required	string
`street`required	string \| null
`postal_code`required	string \| null
`city`required	string \| null
`country`required	string
`latitude`required	number \| null
`longitude`required	number \| null
`time_zone`required	string
`opening_hours`required	string \| null
`payment_integration_id`required	string \| null	Zahlungskonto für QR-Zahlungen an diesem Standort
`is_public`required	boolean
`created_at`required	string

Possible errors

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Example

curl -X GET https://api.ladehase.com/v1/locations/{id} \n  -H "Authorization: Bearer lh_test_…"

Response 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.

Parameters

Name	In	Type
`id`required	Path	string

Request

Name	Type	Description
`name`optional	string
`street`optional	string \| null
`postal_code`optional	string \| null
`city`optional	string \| null
`country`optional	string
`latitude`optional	number \| null
`longitude`optional	number \| null
`time_zone`optional	string
`opening_hours`optional	string \| null
`payment_integration_id`optional	string \| null
`is_public`optional	boolean

Response 200Location

Name	Type	Description
`id`required	string	ID mit Präfix «loc_»
`object`required	"location"
`name`required	string
`street`required	string \| null
`postal_code`required	string \| null
`city`required	string \| null
`country`required	string
`latitude`required	number \| null
`longitude`required	number \| null
`time_zone`required	string
`opening_hours`required	string \| null
`payment_integration_id`required	string \| null	Zahlungskonto für QR-Zahlungen an diesem Standort
`is_public`required	boolean
`created_at`required	string

Possible errors

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Example

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

Response 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.

Parameters

Name	In	Type
`id`required	Path	string

Response 200Deleted

Name	Type	Description
`id`required	string
`object`required	string
`deleted`required	true

Possible errors

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Example

curl -X DELETE https://api.ladehase.com/v1/locations/{id} \n  -H "Authorization: Bearer lh_test_…"

Response 200

{
  "id": "string",
  "object": "string",
  "deleted": true
}