Create Categorization
Learn how to categorize products with the Smart Categorization API.
Endpoint | Method | Required fields |
---|---|---|
/v1/categorize | POST | products |
Use this request to create and start a categorization job. In the request, include each product's:
- Unique ID
- Title
- Description
- (Optional) Additional columns
After you submit a POST
request to /categorize
, a new categorization job is created. The response includes a job ID which you can use to retrieve the results.
Note: Job results are not persisted
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
{
"products": [
{
"productUniqueId": "009300002875-test",
"productTitle": "Bread & Butter Sliders",
"productDescription": "Mt Olive Old-Fashioned Sweet Bread & Butter Sliders 24 fl oz",
"concatenatedExtraColumns": {}
}
]
}
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
}
Updated 29 days ago