List Distributors

Returns a paginated list of distributors, sorted by internal ID ascending.

Required license

This endpoint requires the Stock management add-on.

Request

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

Header

Header	Value
Authorization	Bearer {access_token}

Query parameters

Parameter	Type	Required	Description
offset	integer	No	Start position (default: 0)
limit	integer	No	Number of results (default: 50, max: 200)
status	string	No	Filter by status. Allowed values: active, deleted, all. Comma-separated multiple values are supported, default all. See Conventions

Response

Success (200 OK)

{
  "data": [
    {
      "id": "a7b8c9d0-e1f2-3456-abcd-456789012345",
      "name": "Sanitätshaus Muster GmbH",
      "contactPerson": "Max Mustermann",
      "street": "Musterstraße 1",
      "zip": "1010",
      "city": "Wien",
      "country": "Österreich",
      "telCode": "+43",
      "tel": "1 2345678",
      "email": "kontakt@muster-sanitaet.at",
      "description": null,
      "color": "#df3a7f",
      "deleted": false
    }
  ],
  "meta": {
    "total": 5,
    "offset": 0,
    "limit": 50
  }
}

Response fields

Field	Type	Description
data	Array	List of distributors
data[].id	string (UUID)	Unique ID of the distributor
data[].name	string	Name of the distributor
data[].contactPerson	string | null	Contact person
data[].street	string | null	Street and house number
data[].zip	string | null	ZIP / postal code
data[].city	string | null	City
data[].country	string | null	Country
data[].telCode	string | null	Phone country code
data[].tel	string | null	Phone number
data[].email	string | null	Email address
data[].description	string | null	Description text
data[].color	string	Color as hex code (e.g. #df3a7f)
data[].deleted	boolean	Whether the distributor is deleted
meta.total	integer	Total number of distributors
meta.offset	integer	Current start position
meta.limit	integer	Number of returned entries

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

Possible errors

Status	Code	Description
400	validation_error	Invalid status value
401	invalid_client	Invalid or missing access token
403	insufficient_scope	Scope wares not present, or Stock management add-on not licensed