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:
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:
https://boss-test.smarterx.com
Retrieve the status of the service. Use to check that api key authentication is working.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
x-request-id
Unique request id for tracing purposes that can be provided in the header of any request
1
Creates a batch ingestion job
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
items
tags
tags used to group batches for retrieving results
1
{
"items": [
{
"identifiers": [
{
"gtin": "00757037351253",
"sku": "12345",
"external_id": "your-identifier-here-123"
}
],
"action": "upsert",
"data": {
"product_name": "Kaboom Bowl Blaster",
"product_name_french": "Kaboom Bowl Blaster",
"supplier_name": "Church and Dwight",
"supplier_id": "1234",
"supplier_id2": "abc123",
"reporting_metadata": {
"hello": "world"
},
"registration_required_by_retailer": true,
"active_purchasing": true,
"date_added_to_item_catalog": "2022-08-05",
"item_weight": 1,
"item_weight_measured_in": "lbs",
"random_weight": false,
"food_item": false,
"ebt_food_item": false
}
}
]
}
Get the status of a batch job and items in the batch
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
1
Retrieve multiple batch job results, using a tag and a date/time
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
tag
tag matching the submitted batch job
updated_since
return batches updated since the specified date/time (ISO-8601)
1