Produkte suchen
GET
/pimapi/v1/catalogs/{catalogId}/products/searchFührt eine schnelle Produktsuche in einem Katalog durch, die den angegebenen Klassifikationssystemen und Gruppenfiltern entspricht.
Pfadparameter
Abschnitt betitelt „Pfadparameter“| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
catalogId | string | Ja | Eindeutige ID des zu durchsuchenden Katalogs (z. B. CAT_STANDARD). |
Abfrageparameter (Query-Parameter)
Abschnitt betitelt „Abfrageparameter (Query-Parameter)“| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
classificationId | string | Nein | Filtern nach der zugeordneten Klassifikationssystem-ID. |
classificationGroupClassificationId | string | Nein | Filtern nach der Klassifikationssystem-ID, die einer Klassifikationsgruppe zugeordnet ist. |
classificationGroupId | string | Nein | Filtern nach der Klassifikationsgruppen-ID. |
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 | Nullbasierte Seitennummer für die Paginierung. |
pageSize | integer | Nein | Anzahl der Elemente pro Seite. |
Code-Beispiele
Abschnitt betitelt „Code-Beispiele“curl -X GET "https://dev.pxm.eu.prodexa.com/pxm/pimapi/v1/catalogs/CAT_STANDARD/products/search?classificationId=ECLASS_10&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/search?classificationId=ECLASS_10&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
Abschnitt betitelt „Antwortstruktur“HTTP 200 OK Antwort
Abschnitt betitelt „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": 820, "totalPages": 820 }, "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
Abschnitt betitelt „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"}