Get Inventory Stock Item Details

Returns inventory quantities for stock items in a given outlet.

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

Returns a list of stock items in inventory in the specified outlet with information about their current inventory status.

This endpoint does not return a full list of stock items in an outlet. Only base stock items of ingredients are listed. The quantities and values returned represent the total amounts for all stock items of that ingredient, expressed in units of the base stock item.

Path Params
string
required

An outlet's ID.

Query Params
string

Comma separated list of stock items IDs to filter.

string

If true, will return only stock items with quantity different than zero.

string

If provided, will exclude stock items that are present on the informed count event ID.

string

If true, will return only stock items that are countable (active and stockable).

Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json