Get Product by ID

URL

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

Retrieve a complete, high-fidelity JSON representation of a product, including its variants, prices, assigned classifications, document files, relations, and attribute values.

---

Path Parameters

Parameter	Type	Required	Description
catalogId	string	Yes	Unique ID of the catalog containing the product (e.g., CAT_STANDARD).
productId	string	Yes	Unique ID of the product to retrieve (e.g., PROD_1001).

Query Parameters

Parameter	Type	Required	Description
languageId	string	No	Language tag to localize descriptions (e.g., en, de). If omitted, all translated values are returned.

---

Request Examples

cURL

curl -X GET "https://dev.pxm.eu.prodexa.com/pxm/pimapi/v1/catalogs/CAT_STANDARD/products/PROD_1001?languageId=en" \
  -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/PROD_1001?languageId=en", {
  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 the full product metadata payload.

{
  "status": 200,
  "meta": {
    "languageId": "en"
  },
  "data": {
    "productId": "PROD_1001",
    "catalogId": "CAT_STANDARD",
    "catalogId.description": "Standard Product Catalog",
    "supplierId": "SUP_ACME",
    "supplierId.description": "Acme Supplier Inc.",
    "statusId": "APPROVED",
    "statusId.description": [
      {
        "languageId": "en",
        "value": "Approved"
      }
    ],
    "mfgProductId": "MFG_99823",
    "manufacturerId": "MFG_COMP",
    "manufacturerId.name": "Component Manufacturer Corp.",
    "manufacturerName": "Component Manufacturer Corp.",
    "unitOfMeasureId": "UOM_PIECE",
    "unitOfMeasureId.symbol": "pcs",
    "unitOfMeasureId.description": [
      {
        "languageId": "en",
        "value": "Pieces"
      }
    ],
    "salesUnitOfMeasureId": "UOM_BOX",
    "salesUnitOfMeasureId.symbol": "box",
    "salesUnitOfMeasureId.description": [
      {
        "languageId": "en",
        "value": "Box of 10"
      }
    ],
    "extProductId": "EXT_PROD_1001",
    "productIdExtension": "",
    "keywords": "screw, metal, acme",
    "validFrom": "2026-06-15T00:00:00Z",
    "validTo": null,
    "variants": [
      {
        "variantId": "VAR_RED",
        "statusId": "APPROVED",
        "statusId.description": [
          {
            "languageId": "en",
            "value": "Approved"
          }
        ],
        "createdOn": "2026-06-15T09:00:00Z",
        "createdBy": "admin",
        "changedOn": "2026-06-15T09:00:00Z",
        "changedBy": "admin"
      }
    ],
    "productGroups": [
      {
        "classificationId": "ECLASS_10",
        "classificationGroupId": "SCREWS",
        "orderNo": 1,
        "variant": "VAR_RED",
        "classificationGroupId.description": [
          {
            "languageId": "en",
            "value": "Metal Screws"
          }
        ],
        "createdOn": "2026-06-15T09:00:00Z",
        "createdBy": "admin",
        "changedOn": "2026-06-15T09:00:00Z",
        "changedBy": "admin"
      }
    ],
    "values": {
      "COLOR": "RED"
    },
    "optionAttributes": {},
    "variantAttributes": {},
    "variantValues": {},
    "productDocuments": [
      {
        "path": "manuals/m6_screw_manual_en.pdf",
        "documentViewTypeId": "MANUAL",
        "orderNo": 1,
        "languageId": "en",
        "description": "Product User Manual",
        "caption": "Manual",
        "validFrom": "2026-06-15T00:00:00Z",
        "status": "APPROVED",
        "variant": "VAR_RED",
        "extDocumentId": "EXT_DOC_1",
        "documentViewTypeId.name": "Manual",
        "createdOn": "2026-06-15T09:00:00Z",
        "createdBy": "admin",
        "changedOn": "2026-06-15T09:00:00Z",
        "changedBy": "admin"
      }
    ],
    "prices": [
      {
        "contractId": "CON_2026",
        "statusId": "APPROVED",
        "variant": "VAR_RED",
        "currencyId": "EUR",
        "priceTypeId": "NET",
        "price": 12.99,
        "validFromQuantity": 1.0,
        "priceUnit": 1,
        "vatPercentage": 19.0,
        "isPreferred": true,
        "unitOfMeasureId": "UOM_PIECE",
        "unitOfMeasureId.symbol": "pcs",
        "contractId.description": "Standard Contract 2026",
        "priceTypeId.description": [
          {
            "languageId": "en",
            "value": "Net Price"
          }
        ],
        "createdOn": "2026-06-15T09:00:00Z",
        "createdBy": "admin",
        "changedOn": "2026-06-15T09:00:00Z",
        "changedBy": "admin"
      }
    ],
    "relations": [
      {
        "productId": "PROD_1001",
        "catalogId": "CAT_STANDARD",
        "relatedProductId": "PROD_1002",
        "relatedCatalogId": "CAT_STANDARD",
        "typeId": "ACCESSORY",
        "quantity": 1.0,
        "statusId": "APPROVED",
        "createdOn": "2026-06-15T09:00:00Z",
        "createdBy": "admin",
        "changedOn": "2026-06-15T09:00:00Z",
        "changedBy": "admin"
      }
    ],
    "createdOn": "2026-06-15T09:00:00Z",
    "createdBy": "admin",
    "changedOn": "2026-06-17T11:00:00Z",
    "changedBy": "editor_1"
  }
}

HTTP 404 Not Found Response

Returned if the product ID is not found in the catalog.

{
  "status": 404,
  "meta": {
    "languageId": "en"
  },
  "error": "Product [PROD_1001] was not found in the catalog [CAT_STANDARD]"
}