Overwrite an existing ModifierRecipe

put

https://qa2.revelup.com/resources/ModifierRecipe/{ModifierRecipeId}/

Overwrites a specific ModifierRecipe API object

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

ModifierRecipeId

int64

required

ID of ModifierRecipe to update

Body Params

new ModifierRecipe object

created_by

uri

required

URI of the User API object that created this resource.

created_date

date-time

required

ISO8601 timestamp of the time the resource was created

dining_option

integer

enum

ID of dining option, e.g. delivery, take out, eat-in, etc (defined in Establishment/Stations)

Dining option:

0 - TOGO
1 - EATIN
2 - DELIVERY
3 - CATERING
4 - DRIVETHROUGH
5 - ONLINE
6 - OTHER
7 - SHIPPING
8 - PICKUP

ingredient

uri

required

URI of the Ingredient API object that is to be consumed as part of this recipe. Should be set to null if product is provided instead.

modifier

uri

required

URI of the Modifier API object that the recipe is tied to. Multiple ModifierRecipe API objects can be tied to a single product to form a full recipe.

product

uri

URI of the Product API object that is to be consumed as part of this recipe. Should be set to null if ingredient is provided instead.

quantity

float

required

Quantity of the ingredients/products to be consumed for each use of this recipe. Values are expected to be greater than zero.

sort

int64

required

Numerical value that represents the sorting order for the resources displayed in the UI. Lower values appear higher on the list.

updated_by

uri

required

URI of the User API object that last made changes to this resource.

updated_date

date-time

required

ISO8601 timestamp of the last time the resource was updated

Responses

204

Resource successfully updated

301

Invalid request URL - make sure that the URL ends with a trailing slash.

400

Provided JSON body is either invalid or empty

401

Authentication error - make sure the API key & secret is valid, active and provided in the "API-AUTHENTICATION" header.

404

ModifierRecipe not found

445

Message: Integrity Error - one of the fields provided did not pass validation. Make sure the "quantity" field is contains a positive value.