Skip to main content
GET
Inventory available with every field of the records each row points at: location, part, 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

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
site_id
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
is_consumable
string
last_movement_at
string
last_counted_at
string
primary_image_file_id
string
custom_fields
string
row_version
string
created_at
string
created_by_id
string
created_by_name
string
created_source
string
updated_at
string
updated_by_id
string
updated_by_name
string
location__site_code
string
location__parent_name
string
location__location_type
string
location__level_hint
string
location__code
string
location__name
string
location__path
string
location__depth
string
location__latitude
string
location__longitude
string
location__is_active
string
location__allows_direct_filing
string
location__takes_filing
string
location__primary_location_head_name
string
location__alternate_location_heads
string
location__children
string
location__assets
string
location__assets_in_branch
string
part__part_number
string
part__name
string
part__description
string
part__part_category
string
part__unit_of_measure
string
part__criticality
string
part__tracking_mode
string
part__is_stocked
string
part__is_consumable
string
part__is_active
string
part__on_hand_quantity
string
part__reserved_quantity
string
part__available_quantity
string
part__on_order_quantity
string
part__reorder_point
string
part__at_or_below_reorder_point
string
part__lead_time_days
string
part__open_recommendations
string
part__shortages_12m
string
part__shortages_that_stopped_work
string
part__created_at
string
part__created_by_name
string
part__updated_at
string
part__updated_by_name
string
warehouse__code
string
warehouse__name
string
warehouse__site_code
string
warehouse__site_name
string
warehouse__warehouse_type
string
warehouse__keeper_name
string
warehouse__allows_negative_stock
string
warehouse__is_active
string
warehouse__bins
string
warehouse__parts_stocked
string
warehouse__units_on_hand
string
warehouse__negative_rows
string
reference_records
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>

Note: This is a Foreign Key to asset_cost_to_keep.currency_id.

created_at
string<timestamp with time zone>
created_by_id
string<uuid>

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

created_by_name
string<character varying>
Maximum string length: 200
created_source
string<text>
criticality
string<character varying>
Maximum string length: 20
custom_fields
string<jsonb>
in_transit_quantity
number<numeric>
inventory_location_id
string<uuid>

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

is_consumable
boolean<boolean>
last_counted_at
string<timestamp with time zone>
last_movement_at
string<timestamp with time zone>
location__allows_direct_filing
boolean<boolean>
location__alternate_location_heads
string<jsonb>
location__assets
integer<bigint>
location__assets_in_branch
integer<bigint>
location__children
integer<bigint>
location__code
string<character varying>
Maximum string length: 80
location__depth
integer<smallint>
location__is_active
boolean<boolean>
location__latitude
number<numeric>
location__level_hint
integer<smallint>
location__location_type
string<character varying>
Maximum string length: 150
location__longitude
number<numeric>
location__name
string<character varying>
Maximum string length: 200
location__parent_name
string<character varying>
Maximum string length: 200
location__path
string<text>
location__primary_location_head_name
string<character varying>
Maximum string length: 200
location__site_code
string<character varying>
Maximum string length: 50
location__takes_filing
boolean<boolean>
maximum_quantity
number<numeric>
minimum_quantity
number<numeric>
on_hand_quantity
number<numeric>
on_order_quantity
number<numeric>
part__at_or_below_reorder_point
boolean<boolean>
part__available_quantity
number<numeric>
part__created_at
string<timestamp with time zone>
part__created_by_name
string<character varying>
Maximum string length: 200
part__criticality
string<character varying>
Maximum string length: 20
part__description
string<text>
part__is_active
boolean<boolean>
part__is_consumable
boolean<boolean>
part__is_stocked
boolean<boolean>
part__lead_time_days
integer<integer>
part__name
string<character varying>
Maximum string length: 250
part__on_hand_quantity
number<numeric>
part__on_order_quantity
number<numeric>
part__open_recommendations
integer<bigint>
part__part_category
string<character varying>
Maximum string length: 60
part__part_number
string<character varying>
Maximum string length: 80
part__reorder_point
number<numeric>
part__reserved_quantity
number<numeric>
part__shortages_12m
integer<bigint>
part__shortages_that_stopped_work
integer<bigint>
part__tracking_mode
string<character varying>
Maximum string length: 20
part__unit_of_measure
string<character varying>
Maximum string length: 30
part__updated_at
string<timestamp with time zone>
part__updated_by_name
string<character varying>
Maximum string length: 200
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>
reference_records
string<jsonb>
reorder_point
number<numeric>
reserved_quantity
number<numeric>
row_version
integer<bigint>
safety_stock
number<numeric>
site_id
string<uuid>

Note: This is a Foreign Key to entry_currencies.for_site_id.

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
updated_at
string<timestamp with time zone>
updated_by_id
string<uuid>

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

updated_by_name
string<character varying>
Maximum string length: 200
warehouse__allows_negative_stock
boolean<boolean>
warehouse__bins
integer<bigint>
warehouse__code
string<character varying>
Maximum string length: 60
warehouse__is_active
boolean<boolean>
warehouse__keeper_name
string<character varying>
Maximum string length: 200
warehouse__name
string<character varying>
Maximum string length: 200
warehouse__negative_rows
integer<bigint>
warehouse__parts_stocked
integer<bigint>
warehouse__site_code
string<character varying>
Maximum string length: 50
warehouse__site_name
string<character varying>
Maximum string length: 200
warehouse__units_on_hand
number<numeric>
warehouse__warehouse_type
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