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:
Unless otherwise noted, the following limits apply to URL path and query params:
https://boss-apis-gcp-release-ab7c1b9.zuplo.app
Returns Back of Store disposal recommendations for a product. Recommendations are specific to the provided location.
Location must be specified in the location_name
query parameter.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
location_name
Customer provided unique name for a location. This location name must be previously registered with SmarterX.
product_id
SmarterX uuid for a product
1
Returns Back of Store disposal recommendations for a product looked up on a GTIN 8, 12, 13, or 14. Recommendations are specific to the provided location.
Location must be specified in the location_name
query parameter.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
location_name
Customer provided unique name for a location. This location name must be previously registered with SmarterX.
gtin
GTIN of a product. 8, 12, 13, or 14 digits in length
1
Returns Back of Store disposal recommendations for a product looked up on an external product id previously provided to SmarterX via the Product Catalog API. Recommendations are specific to the provided location.
Location must be specified in the location_name
query parameter.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
location_name
Customer provided unique name for a location. This location name must be previously registered with SmarterX.
external_id
external product id provided by the customer through the Product Catalog API
1
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
.
1