List Inventory by Item

Retrieve item-level inventory availability with filtering, paging, and optional MRP history. Set include_mrp_history to true or 1 to include monthly MRPHistory entries with sold, purchased, consumed, produced, and forecast quantities. mrp_history_months defaults to 12 and supports up to 36 months.

get

Authorizations

AuthorizationstringRequired

Query parameters

item_numberstringOptional

Item or SKU number used to search for the item.

base_part_numberstringOptional

Base part number used to identify a product family or variant group.

item_idstringOptional

Xorosoft ERP item identifier used to retrieve item-specific records.

product_idstringOptional

Product identifier.

storestringOptional

Store or warehouse name.

min_on_handstringOptional

Minimum on-hand quantity filter.

max_on_handstringOptional

Maximum on-hand quantity filter.

tagsstringOptional

Comma-separated tags used to filter matching records.

brandstringOptional

Brand name used to filter items or products.

item_number_containsstringOptional

Filters items whose item number contains this text.

item_number_does_not_containstringOptional

Filters items whose item number does not contain this text.

include_mrp_historystringOptional

Set to true or 1 to include monthly MRP history in each inventory row.

mrp_history_monthsstringOptional

Number of months of MRP history to include. Defaults to 12 and cannot exceed 36.

Default: 12

page_numberstringOptional

Page number for paginated responses.

page_sizestringOptional

Number of records to return per page.

Default: 100

pagestringOptional

Page number for paginated responses.

Default: 1

account3pl_idstringOptional

3PL account identifier.

Responses

200

Request processed successfully.

application/json

Standard Xorosoft ERP API response envelope used by most endpoints.

ResultbooleanOptional

True when the operation completed successfully.

MessagestringOptional

Human-readable success or error message.

Pageinteger · nullableOptional

Current page number when paging is enabled.

TotalPagesinteger · nullableOptional

Total page count when paging is enabled.

400

Invalid request, failed validation, or business rule error.

text/plain

401

Missing or invalid private app credentials.

403

Private app does not have permission for this request.

get/api/xerp/inventory/getinventorybyitemv2

GET /api/xerp/inventory/getinventorybyitemv2 HTTP/1.1
Host: res.xorosoft.io
Authorization: Basic username:password
Accept: */*

{
  "Result": true,
  "Message": "Request processed successfully",
  "Data": {}
}