Create Recipe

Creates a recipe that produces a variant from ingredient variants. variant is the produced variant's id; each ingredient references a variant id with a unit and quantity (the same ingredient cannot appear twice). prepared_locations lists where the recipe can be prepared, optionally drawing ingredient stock from a different stock_location_id. Requires the Create Recipes permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required

Id of the variant this recipe produces.

string
required

Unit of the produced quantity (one of the variant's units).

number
required

How much of the produced variant one preparation yields.

prepared_locations
array of objects
required

Locations the recipe is prepared at, as {"location_id", "stock_location_id"} objects (stock_location_id optional).

prepared_locations*
ingredients
array of objects
required

Ingredient lines as {"variant": <variant id>, "unit": <string>, "unit_quantity": <number>} objects.

ingredients*
Headers
string
required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json