BOSS Recommendation API

Back of Store System Recommendation API

Get recommendations on how to handle products through donations, recycling, disposal, and more!

Primary API endpoint to provide retail users with location-specific recommended disposal/diversion instructions for all items in a retailer’s catalog submitted via the Product Ingestion API and registered by Suppliers via the SmarterX Product Intelligence Platform for display in Client’s own back of store interface.

Recommendations may be one of the following:

• A "BOSS" response that includes a set of recommendations for a single product (no sub-components), under the key "boss"
• A multicomponent recommendation that provides recommendations for individual product components, each of which might have their own handling requirements. A "rollup" recommendation of common paths shared by all components is also provided for the whole product under the key "boss"
• An "all options" response that includes all possible handling options for a product at a location, which is provided when a product is not found in the retailer catalog, or hasn't been registered by a supplier

Unless otherwise noted, the following limits apply to 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 UUIDs are UUIDv4. These will be generated initially by SmarterX, and used in subsequent ingest requests.