Overwrite an existing Ingredient

put

https://qa2.revelup.com/resources/Ingredient/{IngredientId}/

Overwrites a specific Ingredient API object

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

IngredientId

int64

required

ID of the Ingredient API object

Body Params

new Ingredient object

active

boolean

Defaults to true

Flag. If set to True, the Ingredient is visible and can be used in product sales.

barcode

string

Alphanumeric barcode - can be used to find Ingredients quickly. Must be unique in a given Establishment and can not exceed 200 characters.

bin_value

string

cost

string

required

Inventory cost of the Ingredient. Up to 4 decimal places supported. Maximum length is 16 characters.

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

default_invetory

boolean

Defaults to false

Flag. If set to True, the Ingredient will be automatically displayed when the inventory management screen is pulled up on the POS.

establishment

uri

required

URI of an Establishment API object which is related to the Ingredient

minimum_prep_count

integer

Numeric value used alongside the product forecasting feature. Represents the minimum amount of the ingredient that should be prepared for the day regardless of forecasted quantity.

name

string

required

Name of the ingredient. Can not be greater than 200 characters in length.

prep_recipe

boolean

Defaults to false

Flag. If set to True, the Ingredient inventory quantity can be increased through the Inventory page by consuming products/ingredients specified in the Ingredient recipe. See the linked IngredientRecipe API objects for a list of consumed items.

prep_time

integer

Numeric value used alongside the product forecasting feature. Represents the amount of minutes it should take to prepare the ingredient. Values should range between 0 and 1440

prep_yield

string

Prep recipe efficiency. Specifies how much the inventory quantity is increased per use of the prep recipe feature. Value must be greater than zero and can not exceed 16 characters. Up to 4 decimal places supported.

productclass

uri

URI of a ProductClass API object. Represents which product class this ingredient falls under, which is used in several inventory-related reports.

shelf_life

integer

Numeric value used alongside the product forecasting feature. Represents the length of time in minutes for which an item remains usable.

sku

string

Ingredient SKU - can be used to find Ingredients quickly. Must be unique in a given Establishment and can not exceed 200 characters. Allows letters, numbers, underscores, dots, dashes and commas.

sort

int64

required

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

thaw_time

integer

Numeric value used alongside the product forecasting feature. Represents the amount of minutes it takes for an ingredient to thaw if it is frozen. Values should range between 0 and 1440.

track_in_inventory

boolean

Defaults to true

Flag. If set to True, the ingredient quantity will be tracked in the inventory and reduced on ingredient usage.

unit_type

uri

required

URI of a UnitType API object. Represents the units of measurement by which the ingredient will be tracked.

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.

404

Ingredient with the provided ID not found.