List stock items

get

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

code

string

A unique part number to identify the item.

title

string

Name or description of the item.

article_id

integer

Database ID of the stock item.

product_id

integer

Database product ID.

group_id

integer

ID of the product group.

group_code

string

A unique number to identify the product group.

group_title

string

Name of the product group.

unit_id

integer

ID of the unit of measurement.

barcode

string

Barcode of the stock item.

is_raw

boolean

Shows if this is a raw material that is bought from vendors.

not_for_sale

boolean

Shows if this item is not for sale.

is_inventory

boolean

Shows whether this is an inventory item.

standalone_mo

boolean

Shows whether this item's MOs should be separate from the nested multi-level MOs of the top-level product.

deleted

boolean

Shows if this item is deleted.

selling_price_min

string

Minimum selling price of the item.

selling_price_max

string

Maximum selling price of the item.

avg_cost_min

string

Minimum approximate cost of the item.

avg_cost_max

string

Maximum approximate cost of the item.

in_stock_min

string

Minimum physical quantity in stock right now.

in_stock_max

string

Maximum physical quantity in stock right now.

boxed_min

string

boxed_max

string

rejected_min

string

rejected_max

string

expired_min

string

expired_max

string

available_min

string

Minimum quantity that is in stock and available.

available_max

string

Maximum quantity that is in stock and available.

booked_min

string

Minimum quantity that is in stock and booked.

booked_max

string

Maximum quantity that is in stock and booked.

expected_total_min

string

Minimum total quantity planned to be received in the future.

expected_total_max

string

Maximum total quantity planned to be received in the future.

expected_available_min

string

Minimum quantity expected and available, not booked yet.

expected_available_max

string

Maximum quantity expected and available, not booked yet.

expected_booked_min

string

Minimum quantity expected and already booked.

expected_booked_max

string

Maximum quantity expected and already booked.

wip_quantity_min

string

wip_quantity_max

string

min_quantity_min

string

Minimum reorder point quantity.

min_quantity_max

string

Maximum reorder point quantity.

min_prod_ord_qty_min

string

Minimum manufacturing order quantity.

min_prod_ord_qty_max

string

Maximum manufacturing order quantity.

ven_code

string

Filter by associated vendor code

ven_title

string

Filter by associated vendor name

vendor_code

string

Item's vendor-assigned code

lead_time_min

string

Minimum vendor lead time in days.

lead_time_max

string

Maximum vendor lead time in days.

producible

string

Filter by whether the item is producible.

weight_min

string

Minimum item weight.

weight_max

string

Maximum item weight.

estimated_weight

string

Filter by whether the item has estimated weight data.

revision

string

Revision of the stock item.

def_location_<site_id>

integer

Default storage location filter for a specific site.
Replace <site_id> with the site ID, for example def_location_1.

site_id

integer

Site used for site-specific stock values and filters.

Headers

Range

string

Pagination range (e.g., items=0-99, items=200-249)

Responses

429

Rate limited - another request is running

200Full list returned

206Partial content

400Validation failed

401Authentication failed