Create Categorization

Use this request to create and start a categorization job. In the request, include these details:

• The type of unique identifier used in the productUniqueId field. Use one of the enumerated values, such as GTIN, SKU, NDC, UDI-DI, HIBC, MPN, Catalog Number, UNSPSC, or HSN.
• The unique identifier for the product. This value is required and must be unique for each product in the request. Specify the identifier type once for the entire request using the uniqueIdentifierType field.
• The title of the product.
• The description of the product
• Additional product identifiers provided as key-value pairs. Use supported identifier types such as GTIN, SKU, NDC, UDI-DI, HIBC, MPN, Catalog Number, UNSPSC, or HSN as the keys. Do not include the identifier type specified in uniqueIdentifierType here. Instead, provide that identifier's value in the productUniqueId field.
• Additional product attributes provided as key-value pairs. Use this field to supply product details that are not included in the standard identifier fields. Do not include the value specified by uniqueIdentifierType in this field.

After you submit a POST request to /categorize, a new categorization job is created. The response includes a job ID that you can use to retrieve the results.

📘

Note: Job results do persist

The results of a categorization job are not stored in the Smart Categorization application. If you want the job results to be stored in the application for modification, use the POST /categorize/persist endpoint.

Sample request - Categorize products

{
  "uniqueIdentifierType": "SKU",
  "products": [
    {
    "productUniqueId": "A12345",
    "productTitle": "Wireless Mouse",
    "productDescription": "Ergonomic wireless mouse with USB receiver.",
    "identifiers": {
      "GTIN": "00012345678905",
      "UNSPSC": "43211708",
      "HSN": "8471"
     },
  "concatenatedExtraColumns": {
    "Category": "Computer Accessories",
    "Product Type": "Peripheral",
    "Region": "North America"
     }
    }
  ]
}

Sample response - Categorize products

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clientVertexId": "3fa85f64-5717-4562-b3fc-2c963f66afa60",
  "startTime": "2025-04-05T00:32:09.6587169Z",
  "endTime": null,
  "persistent": false,
  "numProducts": 1,
  "numIssues": 0,
  "blobUri": null,
  "retentionDays": 30,
  "result": null
}