Prepare Recipe

Prepares a recipe at a location: consumes ingredient stock and adds the produced variant's stock in proportion to the prepared quantity. date (optional, Y-m-d H:i:s in the store timezone) backdates the stock movement — it must be in the past and within 30 days. Requires the Prepare Recipes permission.

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

Recipe id.

Body Params
integer
required

Location id where the recipe is prepared.

string
required

Unit of the prepared quantity.

number
required

Quantity produced (must be greater than 0).

string | null

Optional backdate, format Y-m-d H:i:s (store timezone), max 30 days back.

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