Add a new Ingredient

Add a new Ingredient

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

Ingredient object that needs to be added

boolean
Defaults to true

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

string

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

string
string
required

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

uri
required

URI of the User API object that created this resource.

date-time
required

ISO8601 timestamp of the time the resource was created

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.

uri
required

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

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.

string
required

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

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.

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

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.

uri

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

integer

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

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.

int64
required

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

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.

boolean
Defaults to true

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

uri
required

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

uri
required

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

date-time
required

ISO8601 timestamp of the last time the resource was updated.

Responses
201

Resource successfully created.

400

Invalid input - please run the request body through a JSON validator.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here!