Preisgruppen auflisten, optional gefiltert und paginiert

Enthält auch inaktive Preisgruppen, sofern der Filter sie nicht ausschließt.

Verfügbarkeit: Nur Vollversion — eine Clock-Instanz antwortet auf diesen Endpunkt mit 404.

Request

GET /api/v1/price-groups

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/price-groups' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Query-Parameter

Name
perPage
Type
integer, nullable
Description
Wird auf diesem Endpunkt ignoriert — senden Sie stattdessen limit. Ein hier angegebener Wert wird durch limit ersetzt, oder durch den Standardwert, wenn limit fehlt.
Name
page
Type
integer, nullable
Description
Die zurückzugebende Ergebnisseite, beginnend bei 1.
Name
orderBy
Type
string, nullable
Description
Name des Feldes, nach dem sortiert wird.
Name
order
Type
string, nullable
Description
Sortierrichtung, aufsteigend oder absteigend.
Einer der Werte: "asc", "desc"
Name
limit
Type
integer, nullable
Description
Die Anzahl der Datensätze pro Seite, 1 bis 200. Standardwert ist 15.

Response

{
  "data": [
    {
      "id": 1,
      "name": "EU",
      "number": "string",
      "status": true,
      "description": {
        "de": "string",
        "en": "string",
        "fr": "string",
        "es": "string",
        "pl": "string"
      }
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "string",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Response-Felder

Name
id
Type
integer
Description
Die eindeutige Kennung der Preisgruppe.
Name
name
Type
string
Description
Der Name der Preisgruppe, wie er bei der Zuordnung zu einem Kunden oder Projekt angezeigt wird.
Name
number
Type
string, nullable
Description
Die Nummer der Preisgruppe, die zur externen Referenzierung verwendet wird.
Name
status
Type
boolean
Description
Ob die Preisgruppe aktiv ist; die zugrunde liegende Spalte wird invertiert gespeichert, true bedeutet hier aktiv.
Name
description
Type
object
Description
Die Beschreibung der Preisgruppe, ausgegeben als sprachabhängige Struktur (i18n) statt als einfache Zeichenkette.
Name
description.de
Type
string, nullable
Description
Name
description.en
Type
string
Description
Name
description.fr
Type
string
Description
Name
description.es
Type
string
Description
Name
description.pl
Type
string
Description

Aus der OpenAPI-Spezifikation erzeugt — Änderungen gehören in den Quellcode, nicht auf diese Seite.

Preisgruppen GET Einzelne Preisgruppe anhand ihrer ID abrufen