Skip to main content
GET
Stock with reorder context. available_quantity is generated from the ledger, not stored.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

stock_id
string
part_id
string
part_number
string
part_name
string
part_category
string
unit_of_measure
string
warehouse_id
string
warehouse_code
string
warehouse_name
string
inventory_location_id
string
on_hand_quantity
string
reserved_quantity
string
available_quantity
string
on_order_quantity
string
in_transit_quantity
string
average_unit_cost
string
average_unit_cost_currency_id
string
minimum_quantity
string
reorder_point
string
maximum_quantity
string
safety_stock
string
at_or_below_reorder_point
string
criticality
string
tracking_mode
string
last_movement_at
string
last_counted_at
string
primary_image_file_id
string
row_version
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

at_or_below_reorder_point
boolean<boolean>
available_quantity
number<numeric>
average_unit_cost
number<numeric>
average_unit_cost_currency_id
string<uuid>
criticality
string<character varying>
Maximum string length: 20
in_transit_quantity
number<numeric>
inventory_location_id
string<uuid>

Note: This is a Foreign Key to bin_settings.id.

last_counted_at
string<timestamp with time zone>
last_movement_at
string<timestamp with time zone>
maximum_quantity
number<numeric>
minimum_quantity
number<numeric>
on_hand_quantity
number<numeric>
on_order_quantity
number<numeric>
part_category
string<character varying>
Maximum string length: 60
part_id
string<uuid>

Note: This is a Primary Key.

part_name
string<character varying>
Maximum string length: 250
part_number
string<character varying>
Maximum string length: 80
primary_image_file_id
string<uuid>
reorder_point
number<numeric>
reserved_quantity
number<numeric>
row_version
integer<bigint>
safety_stock
number<numeric>
stock_id
string<uuid>

Note: This is a Primary Key.

tracking_mode
string<character varying>
Maximum string length: 20
unit_of_measure
string<character varying>
Maximum string length: 30
warehouse_code
string<character varying>
Maximum string length: 60
warehouse_id
string<uuid>

Note: This is a Foreign Key to warehouse_settings.id.

warehouse_name
string<character varying>
Maximum string length: 200