Customer Classification API

API for triggering and retrieving classifications for products

BASE URL
https://api.smarterx.com/

Authentication

Sign into view and manage your API credentials

Lookup product by UPC

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

upc

required, string

UPC for the desired product

GET
/classification/v1/products/:upc
1

Upsert product attributes by UPC or SMARTERX_ID

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

identifier
required

UPC or SMARTERX_ID for the desired product.

Request Body

Attributes for the product to upsert

Unnamed Property

required, object
PUT
/classification/v1/products/:identifier
1
EXAMPLE BODY
{
  "name": "Sample Product",
  "category": "Electronics",
  "brand": "SampleBrand",
  "price": 299.99,
  "stock_status": true
}

Bulk upload products

Upload products in text/csv format. The header row must include either UPC, product_name, or both- the headers are case-insensitive. Each row must include either UPC or product_name if UPC is not specified to ensure that SmarterX's enrichment pipeline can identify and enrich the product appropriately. Additional values aside from upc or product_name should be provided if available to ensure the accuracy of classification results.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Request Body

The full CSV payload to be uploaded

Unnamed Property

required, string
POST
/classification/v1/products/bulk
1

Retrieve filtered products

Returns products based on specified filters with pagination. Products will be ordered by LAST_UPDATED_DATE descending.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

start_date

optional, string

Only include records with LAST_UPDATED_DATE > start_date

end_date

optional, string

Only include records with LAST_UPDATED_DATE < end_date

statuses

optional, array of strings

Filter by product status - must be included in array format.

Possible Enum Values

PENDING

CLASSIFICATION_COMPLETE

IN_REVIEW

page_size

optional, integer, default: 50, maximum value of 100, minimum value of 1

Number of products per page (default 50, max 100)

record_offset

optional, integer, default: 0, minimum value of 0

Record number at which to start the page (default 0)

GET
/classification/v1/products
1

docs

ENDPOINTS
GET/classification/v1/docs

OpenAPI spec

GET
/classification/v1/docs
1