Get Attributes List
GET
/pimapi/v1/attributesRetrieve a list of attributes matching specified query parameters and filtering criteria.
Query Parameters
Section titled “Query Parameters”| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
changedOn | string | No | Date range filter for modifications (e.g., gte:20200901223000). 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., +id, -changedOn). Prefix + for ASC and - for DESC. | |
page | integer | No | 0 | Zero-indexed page number for pagination. |
pageSize | integer | No | 20 | Number of items per page. |
Request Examples
Section titled “Request Examples”curl -X GET "https://dev.pxm.eu.prodexa.com/pxm/pimapi/v1/attributes?page=0&pageSize=2" \ -H "X-API-KEY: your_hex_api_key" \ -H "Accept: application/json"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/attributes?page=0&pageSize=2", { method: 'GET', headers: headers}) .then(response => response.json()) .then(result => console.log(result)) .catch(error => console.log('error', error));Response Structure
Section titled “Response Structure”HTTP 200 OK Response
Section titled “HTTP 200 OK Response”Returns a wrapper list containing metadata and matching attribute records.
{ "status": 200, "meta": { "languageId": "en", "page": 0, "pageSize": 2, "totalElements": 15, "totalPages": 8 }, "data": [ { "attributeId": "COLOR", "attribute.description": [ { "languageId": "en", "value": "Color" } ] }, { "attributeId": "WEIGHT", "attribute.description": [ { "languageId": "en", "value": "Weight" } ] } ]}HTTP 404 Not Found Response
Section titled “HTTP 404 Not Found Response”Returned if no attributes match the criteria.
{ "status": 404, "meta": { "languageId": "en" }, "error": "No Attributes found"}