Product Catalog API

Tell Smarter Sorting about products we should know about.

This API allows a retailer to submit and update their active item catalog to Smarter Sorting, indicating which products require registration by Suppliers as being potentially hazardous versus which are non-hazardous and only eligible for donation or disposal. Products submitted via this API form the base data set for results from the separate BOSS Recommendation API.

Usage:

1. POST your ingest batch job
2. Retain the id from the response
3. Poll your job status at the GET /ingest/product/batch/{batch_job_id} endpoint
4. Note success_count and error_count: once their sum matches item_count the job is complete

The batch job will be validated immediately for required fields, data types, etc. If this validation doesn't succeed a 400 will result and error messages will be returned.

Error messages may also be noted later in the job status output. If you see error messages of the form: "unable to update product, currently in X state (422)", this may occur if a product update is sent too quickly after the previous update, and the product is still going through automated processing. This condition is expected to be rare and temporary, and typically retrying the failed product update later (not the entire batch) should succeed. If it does not, contact support.

Unless otherwise noted, the following limits apply to fields in POST/PUT bodies, URL path and query params:

• Date/time strings must be provided in ISO 8601 format. All values converted to UTC, no time zone info will be retained.
• All string fields, path and query parameters are limited to 127 characters or fewer
• All floating-point numeric values are limited to approximately 6 decimal places of precision, with a range from approximately 1E-37 to 1E+37
• All integer numeric values are limited to ±2³²
• All UUIDs are UUIDv4. These will be generated initially by SmarterX, and used in subsequent ingest requests.