Skip to main content
POST
/
site-platform
/
api
/
v1
/
categorize
/
product
Categorize Product
curl --request POST \
  --url https://{HOST_NAME}/site-platform/api/v1/categorize/product \
  --header 'Content-Type: application/json' \
  --header 'X-SureBright-Access-Token: <x-surebright-access-token>' \
  --data '
{
  "productTitle": "Sony Bravia OLED 4K",
  "storeId": "3226a01adbf64d94803dac879d1fba099",
  "description": "55-inch 4K OLED Smart TV with HDR",
  "quantity": 1,
  "productPrice": 21
}
'
{
  "isError": false,
  "message": "Product categorized successfully",
  "lineItemsList": {
    "productTitle": "Sony Bravia OLED 4K",
    "quantity": 1,
    "productPrice": 21,
    "sbCategoryId": "aedd580b-9a9e-4ceb-8f9a-f239f04f817a",
    "categoryName": "System Warranty - B",
    "sbCategoryName": "TV_MONITOR"
  }
}

Headers

HeaderDescriptionRequired
AuthorizationBearer token for authenticationYes
Content-Typeapplication/jsonYes

Headers

X-SureBright-Access-Token
string
required

Access token for authentication

Body

application/json
productTitle
string
required

The title or name of the product to be categorized

Example:

"Sony Bravia OLED 4K"

storeId
string
required

A unique identifier for a store will be shared as part of the integration kit

Example:

"3226a01adbf64d94803dac879d1fba099"

description
string

The description of the product

Example:

"55-inch 4K OLED Smart TV with HDR"

quantity
integer

The quantity of the product

Example:

1

productPrice
number

The price of the product

Example:

21

Response

Product categorized successfully

isError
boolean

Indicates if an error occurred

Example:

false

message
string

Response message

Example:

"Product categorized successfully"

lineItemsList
object

The categorized product information