Lieferanten abrufen

Gibt eine paginierte Liste aller Lieferanten des Unternehmens zurück, sortiert nach interner ID aufsteigend.

Benötigte Lizenz

Dieser Endpoint erfordert die Lizenz Lagerverwaltung.

Request

GET /api/oauth/v2/resource/wares/distributors

Header

Header	Wert
Authorization	Bearer {access_token}

Query-Parameter

Parameter	Typ	Pflicht	Beschreibung
offset	integer	Nein	Startposition (Standard: 0)
limit	integer	Nein	Anzahl Ergebnisse (Standard: 50, Max: 200)
status	string	Nein	Filtert nach Status. Erlaubte Werte: active, deleted, all. Kommagetrennte Mehrfachwerte möglich, Standard all. Siehe Konventionen

Response

Erfolg (200 OK)

{
  "data": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "Kosmetik Großhandel GmbH",
      "contactPerson": "Julia Berger",
      "street": "Industriestraße 5",
      "zip": "4020",
      "city": "Linz",
      "country": "AT",
      "telCode": "+43",
      "tel": "732 123456",
      "email": "bestellung@kosmetik-grosshandel.at",
      "description": "Hauptlieferant für Kosmetikprodukte",
      "color": "#00adba",
      "deleted": false
    }
  ],
  "meta": {
    "total": 8,
    "offset": 0,
    "limit": 50
  }
}

Response-Felder

Feld	Typ	Beschreibung
data	Array	Liste der Lieferanten
data[].id	string (UUID)	Eindeutige ID des Lieferanten
data[].name	string	Name des Lieferanten
data[].contactPerson	string | null	Ansprechpartner:in
data[].street	string | null	Straße
data[].zip	string | null	PLZ
data[].city	string | null	Ort
data[].country	string | null	Land
data[].telCode	string | null	Telefon-Vorwahl (z.B. +43)
data[].tel	string | null	Telefonnummer
data[].email	string | null	E-Mail-Adresse
data[].description	string | null	Beschreibungstext
data[].color	string	Farbe als Hex-Code
data[].deleted	boolean	Ob der Lieferant gelöscht ist
meta.total	integer	Gesamtanzahl der Lieferanten
meta.offset	integer	Aktuelle Startposition
meta.limit	integer	Anzahl der zurückgegebenen Einträge

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/wares/distributors?offset=0&limit=50&status=beispiel" \
  -H "Authorization: Bearer {access_token}"

Server

Client-ID

Client-Secret

Parameter

offset integer

limit integer

status string

Zuerst Token anfordern

Mögliche Fehler

Status	Code	Beschreibung
400	validation_error	Ungültiger Wert für status
401	invalid_client	Ungültiger oder fehlender Access Token
403	insufficient_scope	Scope wares nicht vorhanden
403	insufficient_scope	Lizenz Lagerverwaltung nicht vorhanden