Get recipe

GET /api/v1/inventory/production/recipes/{recipe_id}

Get a production recipe with all children.

Operation ID: get_recipe_api_v1_inventory_production_recipes__recipe_id__get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

recipe_id string required

Responses

200 Successful Response

Schema: RecipeResponse

id string required
business_id string required
name string required
description string
output_unit_name string required
output_unit_weight number required
output_unit_weight_unit string required
conversion_params object
materials array · RecipeMaterialResponse RecipeMaterialResponse
14 fields
category string

Grouping label: raw_material, inclusion, packaging, or other.

name string required

Material name.

quantity_type string required

pct_of_weight | fixed_per_unit | per_n_units | fixed_per_run

quantity_value number required

Numeric quantity parameter.

quantity_unit string

Unit of the quantity value (g, oz, ml, units …).

yield_factor number

Decimal yield 0-1.

cost_per_unit integer

Cost in cents (or whole-currency units for bulk like $/MT).

cost_unit string

Denominator: per_lb, per_kg, per_mt, per_unit, per_oz, per_gal.

position integer

Display ordering.

output_variant_id string

Scope to a specific output variant (for inclusions).

variant_id string

Optional link to an inventory Variant.

vendor_id string

Optional link to a Vendor.

id string required
recipe_id string required
output_variants array · RecipeOutputVariantResponse RecipeOutputVariantResponse
7 fields
name string required

Variant/SKU name.

allocation_pct number

Percentage of the run.

is_remainder boolean

Auto-calc as 100% minus others.

position integer
variant_id string

Optional link to inventory Variant.

id string required
recipe_id string required
processing_steps array · RecipeProcessingStepResponse RecipeProcessingStepResponse
11 fields
name string required

Step / vendor name.

step_type string

Label: Conversion, Co-Packing, Assembly …

allocation_type string required

pct_of_total | by_output_variant | all_units

allocation_pct number

Percentage if pct_of_total.

cost_per_unit integer

Cost in cents.

cost_unit string

per_lb, per_unit, per_kg …

output_variant_ids array · string

Output variant IDs for by_output_variant.

position integer
vendor_id string

Optional link to Vendor.

id string required
recipe_id string required
created_at string required
updated_at string required

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError
5 fields
loc array · string | integer required
msg string required
type string required
input object
ctx object