Stock movement totals by item

get

https://api.mrpeasy.com/rest/v2/stock-movement/items

List stock movement totals grouped by stock item for a date range, optionally filtered by available attributes.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

start_date

integer | null

Start of the reporting period as a Unix timestamp.

end_date

integer | null

End of the reporting period as a Unix timestamp.

site_id

Filter stock movement report by site(s).

type

integer | null

enum

Type of transaction.

0 - All transactions
1 - Inward transactions
2 - Goods that were bought and received during the period
13 - Goods received back into stock via RMA returns
3 - Goods added via stock adjustments
4 - Products that were manufactured during the period
5 - Goods received via transfer orders
6 - Outward transactions
7 - Products that have been shipped to customers
8 - Goods shipped via RMA
9 - Items used for shipment packing
10 - Goods written off
11 - Parts that have been consumed during the period
12 - Goods shipped via transfer orders

article_id

Filter by article ID(s).

product_id

Filter by product ID(s).

product_code

string | null

Filter by part number (partial match).

product_title

string | null

Filter by item name (partial match).

group_id

Filter by product group ID(s).

group_code

string | null

Filter by product group code (partial match).

group_title

string | null

Filter by product group name (partial match).

unit_id

Filter by unit of measurement ID(s).

unit

string | null

Filter by unit of measurement name (partial match).

quantity_min

string | null

Minimum net quantity filter (inclusive).

quantity_max

string | null

Maximum net quantity filter (inclusive).

cost_min

string | null

Minimum net cost value filter (inclusive).

cost_max

string | null

Maximum net cost value filter (inclusive).

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

200List of stock items with aggregated movement totals for the requested period

422Validation error