API Reference
  1. MRPeasy API
  2. Inventory

Inventory

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

List stock items with on-hand quantities and costs, optionally filtered by available attributes. Historical inventory can be requested with the date parameter.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer | null

Inventory date as a Unix timestamp; quantities and costs are reported as of the end of that day. Defaults to the current date.

integer | null

Filter by the site where the inventory is stored.

integer | null

Filter by stock item ID.

integer | null

Filter by product ID.

string | null

Filter by product code (partial match).

string | null

Filter by product title (partial match).

integer | null

Filter by product group ID.

string | null

Filter by product group code (partial match).

string | null

Filter by product group title (partial match).

integer

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

integer

Number of records to skip for pagination.

Responses

401

Unauthorized

413

Content Too Large - please use smaller ´limit´

429

Too many requests

Updated about 1 month ago

Did this page help you?
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?