Stock items

get

https://api.mrpeasy.com/rest/v2/items

List stock items/products and their current inventory and planning data, optionally filtered by available attributes.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

product_id

Database product_id of the stock item.

article_id

Database article_id of the stock item. It identifies a product variant with particular parameter values (if Matrix BOM functionality is turned on).

code

string | null

A unique part number to identify the item (partial match).

title

string | null

Name or description of the item (partial match).

group_id

ID of the product group.

group_code

string | null

A unique number to identify the product group (partial match).

group_title

string | null

Name of the product group (partial match).

unit_id

ID of the unit of measurement.

include_deleted

boolean | null

When set to true, includes deleted items in the result.

location_id

integer | null

ID of the default storage location.

barcode

string | null

Barcode of the stock item (partial match, if Barcodes functionality is enabled).

is_raw

boolean | null

Filter by raw material flag. Set to true to return only purchased items, false for manufactured items.

not_for_sale

boolean | null

Filter by not for sale flag.

is_inventory

boolean | null

Filter only inventory or non-inventory items.

is_producible

boolean | null

Filter by whether the item has a normal BOM.

is_standalone_mo

boolean | null

Filter by Standalone MO flag.

revision

string | null

Filter by the revision of the stock item (partial match).

vendor_code

string | null

Filter by associated vendor code (partial match).

vendor_title

string | null

Filter by associated vendor name (partial match).

vendor_part_code

string | null

Item's vendor-assigned code (partial match).

lead_time_min

integer | null

Minimum vendor lead time in days.

lead_time_max

integer | null

Maximum vendor lead time in days.

selling_price_min

string | null

Minimum selling price of the item.

selling_price_max

string | null

Maximum selling price of the item.

average_cost_min

string | null

Minimum approximate cost of the item.

average_cost_max

string | null

Maximum approximate cost of the item.

in_stock_min

Minimum physical quantity in stock right now. Can be a single decimal value to filter by total, or an array of per-site quantities.

in_stock_max

Maximum physical quantity in stock right now. Can be a single decimal value to filter by total, or an array of per-site quantities.

available_min

Minimum quantity that is in stock and available. Can be a single decimal value to filter by total, or an array of per-site quantities.

available_max

Maximum quantity that is in stock and available. Can be a single decimal value to filter by total, or an array of per-site quantities.

booked_min

Minimum quantity that is in stock and booked. Can be a single decimal value to filter by total, or an array of per-site quantities.

booked_max

Maximum quantity that is in stock and booked. Can be a single decimal value to filter by total, or an array of per-site quantities.

boxed_min

Minimum boxed quantity. Can be a single decimal value to filter by total, or an array of per-site quantities.

boxed_max

Maximum boxed quantity. Can be a single decimal value to filter by total, or an array of per-site quantities.

expired_min

Minimum expired quantity. Can be a single decimal value to filter by total, or an array of per-site quantities.

expired_max

Maximum expired quantity. Can be a single decimal value to filter by total, or an array of per-site quantities.

rejected_min

Minimum rejected quantity. Can be a single decimal value to filter by total, or an array of per-site quantities.

rejected_max

Maximum rejected quantity. Can be a single decimal value to filter by total, or an array of per-site quantities.

expected_total_min

Minimum total quantity planned to be received in the future. Can be a single decimal value to filter by total, or an array of per-site quantities.

expected_total_max

Maximum total quantity planned to be received in the future. Can be a single decimal value to filter by total, or an array of per-site quantities.

expected_available_min

Minimum quantity expected and available, not booked yet. Can be a single decimal value to filter by total, or an array of per-site quantities.

expected_available_max

Maximum quantity expected and available, not booked yet. Can be a single decimal value to filter by total, or an array of per-site quantities.

expected_booked_min

Minimum quantity expected and already booked. Can be a single decimal value to filter by total, or an array of per-site quantities.

expected_booked_max

Maximum quantity expected and already booked. Can be a single decimal value to filter by total, or an array of per-site quantities.

min_quantity_min

Minimum reorder point quantity. Can be a single decimal value to filter by total, or an array of per-site quantities.

min_quantity_max

Maximum reorder point quantity. Can be a single decimal value to filter by total, or an array of per-site quantities.

min_manufacturing_quantity_min

string | null

Filter by the smallest minimum manufacturing order quantity. Decimal number as a string.

min_manufacturing_quantity_max

string | null

Filter by the greatest minimum manufacturing order quantity. Decimal number as a string.

weight_min

string | null

Minimum item weight.

weight_max

string | null

Maximum item weight.

weight_unit_id

integer | null

enum

Unit of weight.

1 - g
2 - oz
3 - lbs
4 - kg

Allowed:

custom_values

array of objects | null

Filter by custom values.

custom_values

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

422Validation error