Skip to main content

Sku

Full SKU detail, including recipe, production config, allergens, and nutritional data.

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
productionTimeMinutesinteger

Estimated total production time for one batch, in minutes. Calculated from the hours and minutes configured in Keychain OS.

Example: 360
operatorsRequiredinteger

Number of operators needed to run this production line for this SKU.

Example: 2
allergensExcludedstring[]

Allergens this SKU must not contain. Keychain OS uses this list to flag ingredient conflicts during recipe management.

Example: ["peanuts","soy"]
nutritionalInfo object

Nutritional information as free-form key/value pairs (e.g., calories, fat, protein). Structure varies by product.

property name*any

Nutritional information as free-form key/value pairs (e.g., calories, fat, protein). Structure varies by product.

imagesstring<uri>[]

URLs of product images stored in Keychain OS.

recipe object[]

The full ingredient list for one batch of this SKU. Each entry specifies the item, quantity, and unit.

  • Array [
  • ingredientIdstring

    Reference to the item used as an ingredient.

    Example: 2087
    ingredientNamestring

    Display name of the ingredient.

    Example: Organic Tahini
    inventoryCodestring

    The inventory tracking code for this item (e.g., INV-000312). Matches the inventoryCode on the Item object.

    Example: INV-000312
    sequenceOrderinteger

    The order in which this ingredient should be added during production. Starts at 1.

    Example: 1
    quantitynumber

    Amount of this ingredient required for one batch (as defined by the SKU's batchSize).

    Example: 12.5
    unitstring

    Unit of measure for the quantity.

    Example: lbs
    notesstring

    Optional operator notes for this ingredient (e.g., "add slowly while mixing").

  • ]
  • Sku
    {
    "id": "1042",
    "name": "Roasted Garlic Hummus",
    "version": 2,
    "status": "active",
    "description": "string",
    "batchSize": 500,
    "batchUnit": "lbs",
    "itemType": "finished_good",
    "productionTimeMinutes": 360,
    "operatorsRequired": 2,
    "allergensExcluded": [
    "peanuts",
    "soy"
    ],
    "nutritionalInfo": {},
    "images": [
    "string"
    ],
    "recipe": [
    {
    "ingredientId": "2087",
    "ingredientName": "Organic Tahini",
    "inventoryCode": "INV-000312",
    "sequenceOrder": 1,
    "quantity": 12.5,
    "unit": "lbs",
    "notes": "string"
    }
    ]
    }