Returns the list of Ingredient objects

get

https://qa2.revelup.com/resources/Ingredient/

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

sku

string

Expects a string (case sensitive, no delimiters). Will only display Ingredient resources with a matching sku value.

updated_date

string

Expects an ISO8601 timestamp. Will only display Ingredient API objects that updated at this exact time. Useful in conjunction with the "less than" and "greater than" filters to isolate a specific time range.

name

string

Expects a string (case sensitive, no delimiters). Will only display Ingredient resources with a matching name.

track_in_inventory

boolean

Flag. If True, will only display Ingredient API objects that have their quantities tracked in the inventory.

default_inventory

boolean

Flag. If True, will only display Ingredient API objects that appear on the POS inventory managemnet screen by default.

active

boolean

Flag. If True, will only display currently active Ingredient API objects.

barcode

string

Expects a string (case sensitive, no delimiters). Will only display Ingredient resources with a matching barcode value.

establishment

integer

Expects ID of an Establishment API object. Will only display Ingredient API objects that are part of the specified establishment.

created_date

string

Expects an ISO8601 timestamp. Will only display Ingredient API objects that were created at this exact time. Useful in conjunction with the "less than" and "greater than" filters to isolate a specific time range.

fields

array of strings

Comma separated list of fields to display. Only the specified fields will be returned in the response body, along with fields related to those specified.

fields

order_by

string

enum

Allowed:

limit

integer

Limit for results count

offset

integer

Offset for returned results

Responses

301

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

401

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

200Resource successfully retrieved.