Skip to main content
GET
The part catalogue with total availability. api.inventory_available is stock per warehouse.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
part_number
string
name
string
description
string
part_category
string
unit_of_measure
string
criticality
string
tracking_mode
string
is_stocked
string
is_active
string
on_hand_quantity
string
reserved_quantity
string
available_quantity
string
on_order_quantity
string
reorder_point
string
at_or_below_reorder_point
string
lead_time_days
string
open_recommendations
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>
criticality
string<character varying>
Maximum string length: 20
description
string<text>
id
string<uuid>

Note: This is a Primary Key.

is_active
boolean<boolean>
is_stocked
boolean<boolean>
lead_time_days
integer<integer>
name
string<character varying>
Maximum string length: 250
on_hand_quantity
number<numeric>
on_order_quantity
number<numeric>
open_recommendations
integer<bigint>
part_category
string<character varying>
Maximum string length: 60
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>
tracking_mode
string<character varying>
Maximum string length: 20
unit_of_measure
string<character varying>
Maximum string length: 30