Retrieve container inventory
Retrieves containers at a location. By default, returns the full inventory of containers at the location.
Use the order sort the resulting containers returned with 6 options: name_asc (default), name_desc, updated_asc, updated_desc, created_desc, created_asc.
Query Params
Use state query param to limit results to containers with one of these states:
- open
- closed
- picked_up
Use start_date and end_date query params to retrieve historical records. Returned containers must intersect with this range if both are provided.
- start_date: matches any container with a finish_datetime on or after this date, or containers without a finish_datetime
- end_date: matches any container with a start_datetime on or before this date
Use page and page_size query params to page through chunks of results.
Use cases
Searching Closed or Picked Up Containers
Use state=closed to return containers that are finished and ready for pickup. Use state=picked_up to return containers that have been collected by the disposal partner.
The number of closed/picked up containers will naturally increase over time, and a query for these states may eventually return a large number of results. Since all of these containers are expected to have a finish_datetime value, we can use start_date and end_date to limit the results to the desired time range.
- Use start_date and end_date together to limit the results to containers that intersect with this time range, e.g. start_date=2023-02-01&end_date=2023-02-28 to return containers that had items added in the month of Februrary
- Use start_date alone to limit the results to containers that have finish_datetime after this date, e.g. start_date=2023-03-01 to return containers that had items added after March 1st
- Use end_date alone to limit the results to containers that have start_datetime prior this date, e.g. end_date=2023-01-01 to return containers that had items added prior to 2023
Searching Open Containers
Use state=open to return only open containers. These are containers that are available for adding additional items.
Because the count of open containers on-site at a retail location tends to be a manageable number during a relatively short window of time, filtering by date range on these statuses is usually unnecessary, although still supported. Note that since these containers typically don't have a finish_datetime, they'll match any query where only start_date is provided.
query Parameters
option.idstring · uuidSmarter Sorting ID of the option to filter by
statestring · enumContainer state to filter by
Enum values:openclosedpicked_upDefault: openpageintegerpage_sizeintegerstart_datestring · date-timeSet this to match containers with a finish_datetime on or after this date, or without a finish_datimetime value
end_datestring · date-timeSet this to match containers with a start_datetime on or before this date
orderstring · enumSet this param to determine the order of containers returned. If none provided, defaults to name_asc: container name in ascending order.
Enum values:name_ascname_descupdated_descupdated_asccreated_desccreated_asc
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
OK
resultsobject[]paginationobject
Create new container
Create a new container
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
option_idstring · uuid · requiredUUID of the sorting option that the container is for
total_weight_measured_instring · enum · requiredUnit of measure for total_weight
Enum values:lbsgkgExample: lbs
statestring · enumState of the container. Closed containers cannot have more items added. Picked up containers are no longer in the back-of-store.
Enum values:openclosedpicked_upstart_datetimestring · date-timeUTC date-time when the container was started
finish_datetimestring · date-timeUTC date-time when the container was closed
Responses
Created
idstring · uuid · readOnlyUUID of the container. Generated by Smarter Sorting when creating a new container
option_idstring · uuidUUID of the sorting option that the container is for
container_numbernumber · readOnlySequential number of the container. Generated by Smarter Sorting when creating a new container
Example: 5container_namestring · readOnlyName of the container. Includes the option and container number. Generated by Smarter Sorting when creating a new container.
Example: Flammable Liquids 5number_of_itemsnumber · min: 0 · readOnlyNumber of items in the container. Calculated value.
Example: 10total_weightnumber · float · min: 0 · readOnlyTotal weight of all items in the container. Calculated value. Precision: at least 6 decimal places
Example: 12.5total_weight_measured_instring · enumUnit of measure for total_weight
Enum values:lbsgkgExample: lbsstatestring · enumState of the container. Closed containers cannot have more items added. Picked up containers are no longer in the back-of-store.
Enum values:openclosedpicked_upstart_datetimestring · date-timeUTC date-time when the container was started
finish_datetimestring · date-timeUTC date-time when the container was closed
Retrieve existing container
Get information about a specific container
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
OK
idstring · uuid · readOnlyUUID of the container. Generated by Smarter Sorting when creating a new container
option_idstring · uuidUUID of the sorting option that the container is for
container_numbernumber · readOnlySequential number of the container. Generated by Smarter Sorting when creating a new container
Example: 5container_namestring · readOnlyName of the container. Includes the option and container number. Generated by Smarter Sorting when creating a new container.
Example: Flammable Liquids 5number_of_itemsnumber · min: 0 · readOnlyNumber of items in the container. Calculated value.
Example: 10total_weightnumber · float · min: 0 · readOnlyTotal weight of all items in the container. Calculated value. Precision: at least 6 decimal places
Example: 12.5total_weight_measured_instring · enumUnit of measure for total_weight
Enum values:lbsgkgExample: lbsstatestring · enumState of the container. Closed containers cannot have more items added. Picked up containers are no longer in the back-of-store.
Enum values:openclosedpicked_upstart_datetimestring · date-timeUTC date-time when the container was started
finish_datetimestring · date-timeUTC date-time when the container was closed
Update existing container
Update information about a specific container
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
option_idstring · uuidUUID of the sorting option that the container is for
total_weight_measured_instring · enumUnit of measure for total_weight
Enum values:lbsgkgExample: lbsstatestring · enumState of the container. Closed containers cannot have more items added. Picked up containers are no longer in the back-of-store.
Enum values:openclosedpicked_upstart_datetimestring · date-timeUTC date-time when the container was started
finish_datetimestring · date-timeUTC date-time when the container was closed
Responses
OK
idstring · uuid · readOnlyUUID of the container. Generated by Smarter Sorting when creating a new container
option_idstring · uuidUUID of the sorting option that the container is for
container_numbernumber · readOnlySequential number of the container. Generated by Smarter Sorting when creating a new container
Example: 5container_namestring · readOnlyName of the container. Includes the option and container number. Generated by Smarter Sorting when creating a new container.
Example: Flammable Liquids 5number_of_itemsnumber · min: 0 · readOnlyNumber of items in the container. Calculated value.
Example: 10total_weightnumber · float · min: 0 · readOnlyTotal weight of all items in the container. Calculated value. Precision: at least 6 decimal places
Example: 12.5total_weight_measured_instring · enumUnit of measure for total_weight
Enum values:lbsgkgExample: lbsstatestring · enumState of the container. Closed containers cannot have more items added. Picked up containers are no longer in the back-of-store.
Enum values:openclosedpicked_upstart_datetimestring · date-timeUTC date-time when the container was started
finish_datetimestring · date-timeUTC date-time when the container was closed
Add a product to a container
Add a product to a container
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
product_idstring · uuid · requiredSmarter Sorting id of the product that was handled
option_idstring · uuid · requiredSmarter Sorting id of the handling option that was selected
handled_atstring · date-time · requiredThe time at which the product was handled
quantitynumber · min: 1 · requiredQuantity of the product handled
recommendation_idstring · uuidSmarter Sorting id of the BOSS recommendation shown to the user, if available
weightnumber · float · min: 0Real world measured weight of a single unit of the product
Precision: at least 6 decimal places
Total weight is reported as weight * quantity
weight_measured_instring · enumUnit of measure for weight. Required if weight is provided.
Enum values:lbsgkgExample: lbsmetadataobjectObject containing additional string metadata about a product as key value pairs.
Examples of information that can be tracked:
- Where did the item come from?
- What was the condition of the item?
- What department handled the item?
userstringName or identifier of the user who handled the product
Example: John Doecontainer_idstring · uuidSmarter Sorting id of the container that the product is placed in.
Responses
Created
product_idstring · uuid · requiredSmarter Sorting id of the product that was handled
option_idstring · uuid · requiredSmarter Sorting id of the handling option that was selected
handled_atstring · date-time · requiredThe time at which the product was handled
quantitynumber · min: 1 · requiredQuantity of the product handled
idstring · uuid · readOnlyuuid of the handling record
Read-only. Do NOT include in POST requests
gtinstring · pattern:^[0-9]{8,14}$GTIN of the product if available. Ignored if provided in a request body.
8, 12, 13, or 14 digits in length
Example: 00757037351253skustring · maxLength: 128 · pattern:^[A-Za-z0-9-_]+$SKU (alphanumeric). Ignored if sent in with a request body.
Example: 12345external_idstring · maxLength: 128 · pattern:^[A-Za-z0-9-_]+$Custom identifier. Ignored if sent in with a request body.
Example: ITEM_12345recommendation_idstring · uuidSmarter Sorting id of the BOSS recommendation shown to the user, if available
weightnumber · float · min: 0Real world measured weight of a single unit of the product
Precision: at least 6 decimal places
Total weight is reported as weight * quantity
weight_measured_instring · enumUnit of measure for weight. Required if weight is provided.
Enum values:lbsgkgExample: lbsmetadataobjectObject containing additional string metadata about a product as key value pairs.
Examples of information that can be tracked:
- Where did the item come from?
- What was the condition of the item?
- What department handled the item?
userstringName or identifier of the user who handled the product
Example: John Doecontainer_idstring · uuidSmarter Sorting id of the container that the product is placed in.
product_namestringProducts name
Example: Incredible Hand Soap