Skip to main content

SkuSummary

Summary view of a SKU, returned in list endpoints and customer SKU lookups.

idstring

Unique identifier for the SKU.

Example: 1042
namestring

The product name, meant to be displayable to operators and customers.

Example: Roasted Garlic Hummus
versioninteger

The version number of this SKU snapshot. Starts at 1 and increments each time the formulation is updated. Work orders lock to the version that was current when they were created.

Example: 2
statusstring

Whether this SKU is currently available for production. Inactive SKUs cannot be assigned to new work orders.

Possible values: [active, inactive]

Example: active
descriptionstring

Free-text description of the product.

batchSizenumber

The quantity produced in a single production batch. Ingredient quantities in the recipe are specified for this batch size.

Example: 500
batchUnitstring

Unit of measure for the batch size (e.g., gal, lbs, units).

Example: lbs
itemTypestring

Classification of the product. Common values include finished_good and wip (work-in-progress).

Example: finished_good
SkuSummary
{
"id": "1042",
"name": "Roasted Garlic Hummus",
"version": 2,
"status": "active",
"description": "string",
"batchSize": 500,
"batchUnit": "lbs",
"itemType": "finished_good"
}