Produktliste abrufen

URL

GET/pimapi/v1/catalogs/{catalogId}/products

Ruft eine Liste von Produkten innerhalb eines Katalogs ab, gefiltert nach Klassifikation, Status, Verträgen oder Änderungsdaten.

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`catalogId`	`string`	Ja	Eindeutige ID des Katalogs, der die Produkte enthält (z. B. `CAT_STANDARD`).

Abfrageparameter (Query-Parameter)

Parameter	Typ	Erforderlich	Standardwert	Beschreibung
`classificationId`	`string`	Nein		Filtern nach der zugewiesenen Klassifikationssystem-ID.
`classificationGroupClassificationId`	`string`	Nein		Filtern nach der Klassifikationssystem-ID, die einer Klassifikationsgruppe zugeordnet ist.
`classificationGroupId`	`string`	Nein		Filtern nach der zugewiesenen Klassifikationsgruppen-ID.
`contractId`	`string`	Nein		Kommagetrennte Liste von Vertrags-IDs zur Filterung der Produktpreise.
`statusId`	`string`	Nein		Kommagetrennte Liste von Produkt-Workflow-Status-IDs (z. B. `APPROVED,DRAFT`).
`changedOn`	`string`	Nein		Datumsbereichsfilter für Änderungen (z. B. `gte:-5d`). Unterstützt absolute und relative Offsets.
`createdOn`	`string`	Nein		Datumsbereichsfilter für Erstellungszeiten.
`languageId`	`string`	Nein		Sprachkürzel zur Lokalisierung von Beschreibungen (z. B. `en`, `de`).
`sorting`	`string`	Nein		Sortieranweisungen für Felder (z. B. `+productId`, `-statusId`).
`page`	`integer`	Nein	`0`	Nullbasierte Seitennummer für die Paginierung.
`pageSize`	`integer`	Nein	`20`	Anzahl der Elemente pro Seite.

curl -X GET "https://dev.pxm.eu.prodexa.com/pxm/pimapi/v1/catalogs/CAT_STANDARD/products?statusId=APPROVED&page=0&pageSize=1&languageId=de" \
  -H "X-API-KEY: ihr_hex_api_schluessel" \
  -H "Accept: application/json"

const headers = new Headers();
headers.append("X-API-KEY", "ihr_hex_api_schluessel");
headers.append("Accept", "application/json");

fetch("https://dev.pxm.eu.prodexa.com/pxm/pimapi/v1/catalogs/CAT_STANDARD/products?statusId=APPROVED&page=0&pageSize=1&languageId=de", {
  method: 'GET',
  headers: headers
})
  .then(response => response.json())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

Antwortstruktur

HTTP 200 OK Antwort

Gibt ein paginiertes Payload-Wrapper-Objekt zurück, das eine Liste passender Produkte enthält.

{
  "status": 200,
  "meta": {
    "languageId": "de",
    "page": 0,
    "pageSize": 1,
    "totalElements": 1500,
    "totalPages": 1500
  },
  "data": [
    {
      "productId": "PROD_1001",
      "catalogId": "CAT_STANDARD",
      "_objectPreviewURI": "https://dev.pxm.eu.prodexa.com/pxm/api/files/previews/screw_thumb.jpg",
      "_objectName": "M6 Stahlschraube",
      "_objectDescription": "Premium Edelstahl M6 Maschinenschraube mit Innensechskant."
    }
  ]
}

HTTP 404 Not Found Antwort

Wird zurückgegeben, wenn keine Produkte gefunden werden, die der Suchanfrage entsprechen.

{
  "status": 404,
  "meta": {
    "languageId": "de"
  },
  "error": "No Products found"
}