Manage locations and disposal for the Back of Store System, including available
disposal, recycling, and donation options.
Unless otherwise noted, the following limits apply to fields in 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 requests to identify options.
General Features
Endpoints that return a list of resources will include pagination info in the
response body, and paging may be controlled with query parameters. These endpoints
will also typically include query parameters to filter the list of items by name,
description, location or other fields.
For items that support DELETE operations, these are considered "soft deletes" which
will prevent the item from being returned in GET requests, but will not remove it
from the database. The items may be restored by performing a PATCH with the body
{"discarded": false}.
Location Management
The following use cases are supported:
- Creating new locations
- Updating existing locations
- Removing locations
- Retrieving one or more locations, with optional parameters to filter by name,
description or location
- Enabling or disabling single or multiple disposal options at a location
Note: API users are responsible for enforcing validity of options for a
location. For example, assigning a State Toxic disposal option for a
location in a state that does not have state-level regulations may result
in undesirable recommendation results.
Option Management
The following use cases are supported:
- Updating existing option names and descriptions
- Retrieving one or more options, with optional parameters to filter by name,
description, or category
- Enabling or disabling an option for multiple locations
- Removing options (soft delete)
With the exception of Donation Partners, new options must be created by
SmarterX, since they often require new rule sets and other configuration
behind the scenes to ensure proper bin results. Our future roadmap includes
self-service rule writing for retail customers via Smarter-1, but this is
out of scope for v1 of Location Management.
Donation Option Management
The following use cases are supported:
- Creating new donation options
- Updating existing donation options (names, descriptions, tax IDs, POC info, etc.)
- Retrieving one or more donation options, with optional parameters to filter by name,
description, or location
- Removing donation options (soft delete)
Donation options contain additional fields for linking to MealConnect, and for
storing contact info and other details about the donation partner.