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

Create a product if it does not exist, or update an existing product's attributes 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

identifier

required, string

UPC for the desired product

Request Body

Attributes you wish to create/update for the provided UPC. For the best classification results, be sure to provide "product_name" in the request body. You can further increase the quality of classifications by providing "brand_name" and "description" as well.

Additionally, the payload can include any parameters you wish to be persisted and returned back in future results to make integration with your application easier (for example, an internal SKU).

Unnamed Property

required, object
PUT
/classification/v1/products/:identifier
1
EXAMPLE BODY
{
  "product_name": "ACME Anvil",
  "internal_sku": "retailer-id-123",
  "brand": "ACME",
  "description": "Custom description for your product"
}

Bulk upload products

Upload products in text/csv format. The header row (case insensitive) must include either UPC, product_name, or both. For the best classification results, please provide "product_name", "brand_name" and "description".

Additionally, the CSV can include any parameters you wish to be persisted and returned back in future results to make integration with your application easier (for example, an internal SKU).

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)

page_token

optional, string

A pagination token used to continue retrieving results from a previous query. If omitted, the query starts from the beginning. Use the value returned in the response to request the next batch of results.

GET
/classification/v1/products
1

docs

ENDPOINTS
GET/classification/v1/docs

OpenAPI spec

GET
/classification/v1/docs
1