Critical on-hand

get

https://api.mrpeasy.com/rest/v2/inventory/critical

Critical on-hand report: stock items whose projected quantity (available + expected available) has fallen below their reorder point. The report reflects the current situation; it cannot be requested for a past date.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

article_id

integer | null

Filter by stock item ID.

product_id[]

Filter by product ID(s).

product_code

string | null

Filter by product code (partial match).

product_title

string | null

Filter by product title (partial match).

group_id

integer | null

Filter by product group ID.

group_code

string | null

Filter by product group code (partial match).

group_title

string | null

Filter by product group title (partial match).

site_id

integer | null

Filter by site. Used only when the multi-site functionality is enabled.

is_raw

boolean | null

Filter by item type: true for procured items, false for manufactured items.

in_stock_min

string | null

Filter by minimum on-hand quantity.

in_stock_max

string | null

Filter by maximum on-hand quantity.

available_min

string | null

Filter by minimum available quantity.

available_max

string | null

Filter by maximum available quantity.

expected_available_min

string | null

Filter by minimum expected available quantity.

expected_available_max

string | null

Filter by maximum expected available quantity.

min_quantity_min

string | null

Filter by minimum reorder point.

min_quantity_max

string | null

Filter by maximum reorder point.

limit

integer

Maximum number of records to return (1–1000).

offset

integer

Number of records to skip for pagination.

Responses

401

Unauthorized

413

Content Too Large - please use smaller ´limit´

429

Too many requests

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200List of stock items below their reorder point

422Validation error