Fields Reference

Smart Categorization API fields

This table lists the fields included in the request body for Smart Categorization API requests.

Field	Type	Description
`products`	Required Type: Array of objects	The list of products to be categorized. Array [ - `productUniqueId` - `product_title` - `product_description` ]
`productUniqueId`	Required Type: string Max length: 20	The unique identifier for the product.
`productTitle`	Required Type: string Max length: 128	The title of the product.
`productDescription`	Optional Type: string	The description for the product.
`concatenatedExtraColumns`	Optional Type: object	The additional attributes for the product. Each key represents the name of a custom column, and each value is the corresponding data.
`jobId`	Required Type: uuid	The ID for the categorization job.
`cursor`	Optional Type: string	The optional cursor for pagination.
`clientId`	Optional Type: integer	The ID for the client.
`cursor`	Optional Type: string	The optional cursor for pagination.
`recordsPerPage`	Optional Type: integer Default: 10	The number of products to return per page.
`sortField`	Optional Type: string	The field to sort results by.
`sortDirection`	Optional Type: string	Sort direction: `asc` for ascending and `desc` for descending.
`searchValue`	Optional Type: string	The search value for filtering.
`filters`	Optional Type: Array of objects	The list of filter objects. Array [ - `filterField` - `filterOperation` - `filterValues` ]Note: The `filters` object contains three required fields that work together to define a filter: `filterField` specifies the product field to filter on, `filterOperation` sets the comparison type, and `filterValues` provides the value to compare against.
`filterField`	Required with `filters` Type: string	Specifies which product field to filter your results by. Use camelCase formatting for the value. This field is required with the use of the `filters` field. You can filter on any of the following fields: `productId` - Product identifier `productName` - Product name `gtin` - Global Trade Item Number `category` - Product category `engineItemCategoryId` - Engine item category identifier `manufacturer` - Manufacturer `brand` - Brand `status` - Product status `reviewer` - Assigned reviewer `fileName` - Source file name `modifiedDate` - Date last modified `effectiveDate` - Effective date `createdDate` - Date created `confidenceInterval` - Confidence interval `override` - Override indicator
`filterOperation`	Required with `filters` Type: string	Specifies the comparison operation to apply to your filter. This field is required with the use of the `filters` field. You can use any of the following operations: `eq` - Equal to `neq` - Not equal to `contains` - Contains the specified value `notContains` - Does not contain the specified value `startsWith` - Starts with the specified value `endsWith` - Ends with the specified value `in` - Matches any value in a specified list `notIn` - Does not match any value in a specified list `gt` - Greater than `lt` - Less than `gte` - Greater than or equal to `lte` - Less than or equal to `isEmpty` - Field is empty `isNotEmpty` - Field is not empty
`filterValues`	Required with `filters` Type: string	Specifies the value to match against when applying the filter operation. This field is required with the use of the `filters` field.
`selectedColumns`	Optional Type: Array of strings	The column names to include in the response.
`selectedIds`	Optional Type: Array of strings	The list of product IDs.