Get a Stock Item's Inventory Information

Returns inventory information about a specific stock item at a specific outlet.

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

Aggregated quantities and values

The aggregated_quantity and aggregated_stock_value numbers are determined by the amounts of every other stock item in the same inventory that are defined in terms of the stock item being queried, or that it is defined in terms of.

In the example response, we have a Cola Can (33 cl) stock item and a Cola Can Pack (6 x 33 cl) that is defined as 6 units of the former. The inventory has 12 units of Cola Can and 1 unit of Cola Can Pack. The aggregated_quantity of Cola Can is 18 = 12 + (1 * 6).

On the other hand, quantity and stock_value are the amounts for the queried stock item only.

Path Params
string
required

An outlet's ID.

string
required

A stock item's ID.

Response

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