API for triggering and retrieving classifications for products
https://api.staging.smarterx.comCounts products based on specified filters
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
statuses
Filter by product status - must be included in array format.
PENDING
CLASSIFICATION_COMPLETE
IN_REVIEW
start_date
Only count records with last_updated_date > start_date
end_date
Only count records with last_updated_date < end_date
1
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
upc
UPC for the desired product
1
For the provided UPC, overwrite the existing product's attributes.
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
upc
UPC for the desired product
The full set of attributes you wish to persist for the provided UPC. Note that any previously existing attributes will be overwritten by the ones provided in the request body. For the best classification results, be sure to provide "product_name". 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
1
{
"product_name": "ACME Anvil",
"internal_sku": "retailer-id-123",
"brand": "ACME",
"description": "Custom description for your product"
}Update or append attributes to the product identified by the provided UPC.
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
upc
UPC for the desired product
The full set of attributes you wish to update or append for the provided UPC. Note that any previously existing attributes will be maintained, and those included in the request body will either (1) update an existing attribute with the same name or (2) add a new attribute to the existing set. For the best classification results, be sure to provide "product_name". 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
1
{
"product_name": "ACME Anvil",
"internal_sku": "retailer-id-123",
"brand": "ACME",
"description": "Custom description for your product"
}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).
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
The full CSV payload to be uploaded
Unnamed Property
1
Returns products based on specified filters with pagination. Products will be ordered by last_updated_date descending.
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
start_date
Only include records with last_updated_date > start_date
end_date
Only include records with last_updated_date < end_date
statuses
Filter by product status - must be included in array format.
PENDING
CLASSIFICATION_COMPLETE
IN_REVIEW
page_size
Number of products per page (default 50, max 100)
page_token
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.
1
1