Get Products List

URL

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

Retrieve a list of products within a catalog, filtered by classification, status, contracts, or modification dates.

---

Path Parameters

Parameter	Type	Required	Description
catalogId	string	Yes	Unique ID of the catalog containing the products (e.g., CAT_STANDARD).

Query Parameters

Parameter	Type	Required	Default	Description
classificationId	string	No		Filter by assigned classification system ID.
classificationGroupClassificationId	string	No		Filter by classification system ID associated with a classification group.
classificationGroupId	string	No		Filter by assigned classification group ID.
contractId	string	No		Comma-separated list of contract IDs to filter product pricing.
statusId	string	No		Comma-separated list of product workflow status IDs (e.g., APPROVED,DRAFT).
changedOn	string	No		Date range filter for modifications (e.g., gte:-5d). Supports absolute and relative offsets.
createdOn	string	No		Date range filter for creation times.
languageId	string	No		Language tag to localize descriptions (e.g., en, de).
sorting	string	No		Field sorting instructions (e.g., +productId, -statusId).
page	integer	No	0	Zero-indexed page number for pagination.
pageSize	integer	No	20	Number of items per page.

---

Request Examples

cURL

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

JavaScript (Fetch)

const headers = new Headers();
headers.append("X-API-KEY", "your_hex_api_key");
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", {
  method: 'GET',
  headers: headers
})
  .then(response => response.json())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

---

Response Structure

HTTP 200 OK Response

Returns a paginated list wrapper with matching product items.

{
  "status": 200,
  "meta": {
    "languageId": "en",
    "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 Steel Screw",
      "_objectDescription": "Premium stainless steel M6 machine screw with hex socket head."
    }
  ]
}

HTTP 404 Not Found Response

Returned if no products are found matching the query.

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