Guides

Retrieve All Product Mappings

Learn how to retrieve all product category mappings using the Smart Categorization API.

Suggest Edits
EndpointMethodRequired fields
/public-api/allproduct/all-product-mappingsPOSTNone

Use this request to get all available product category mappings from the Smart Categorization application.

📘

Note: Request body requirements

The request body is required, but all fields are optional. An empty request body {} is valid.

Sample request with selectedColumns

{
  "cursor": "",
  "recordsPerPage": 20,
  "sortField": "category",
  "sortDirection": "asc",
  "filters": [
    {
      "filterField": "productName",
      "filterOperation": "contains",
      "filterValues": "Systane"
    }
  ],
  "searchValue": "",
  "selectedColumns": [
    "productName",
    "clientId",
    "productId",
    "category",
    "createdDate"
  ]
}

Sample response with selectedColumns

{
  "cursor": "",
  "recordCount": 3,
  "products": [
    {
      "productName": "Systane Zaditor Itch Relief Antihistamine Sterile Eye Drops 5 ml",
      "clientId": 49,
      "productId": "73080",
      "category": "Over-the-Counter Drugs Sold Without Prescription",
      "createdDate": "2026-01-05T16:21:44.104579Z"
    },
    {
      "productName": "SYSTANE COMPLETE DRY DRPS TWN",
      "clientId": 49,
      "productId": "76866",
      "category": "Over-the-Counter Drugs Sold Without Prescription",
      "createdDate": "2026-01-09T21:04:22.998864Z"
    },
    {
      "productName": "SYSTANE PF PM DRY EYE OINTMNT",
      "clientId": 49,
      "productId": "76867",
      "category": "Over-the-Counter Drugs Sold Without Prescription",
      "createdDate": "2026-01-09T21:04:22.998864Z"
    }
  ]
}

Sample response without selectedColumns

{
  "cursor": "",
  "recordCount": 3,
  "productItems": [
    {
      "clientId": 49,
      "productId": "73080",
      "upc": "...",
      "productName": "...",
      "category": "...",
      "engineItemCategoryId": "...",
      "override": "...",
      "manufacturer": "...",
      "status": "...",
      "modifiedDate": "...",
      "effectiveDate": "...",
      "createdDate": "...",
      "reviewer": "...",
      "confidenceInterval": 0,
      "brand": "...",
      "engineWebEnrichedDesc": "...",
      "additionalColumnsJSON": {},
      "driversJSON": "...",
      "driverCodes": [],
      "driverNames": [],
      "fileName": "..."
    }
  ]
}

Sample request with multiple filters and multiple filterValues

{
  "clientId": 42,
  "recordsPerPage": 25,
  "sortField": "modifiedDate",
  "sortDirection": "desc",
  "filters": [
    {
      "filterField": "status",
      "filterOperation": "in",
      "filterValues": ["approved"; "underReview"]
    },
    {
      "filterField": "manufacturer",
      "filterOperation": "contains",
      "filterValues": ["ABC Corp"]
    }
  ]
}