boss_handling_record
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
create_or_update_boss_handling_record
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.
boss_container_response
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
new_boss_container
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
boss_container_patch
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