Skip to main content
GET
What to buy, how much, by when, and the itemised reasoning behind it (UI spec §16.3).

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_id
string
part_number
string
part_name
string
part_criticality
string
unit_of_measure
string
warehouse_id
string
warehouse_code
string
warehouse_name
string
demand_quantity
string
available_quantity
string
reserved_quantity
string
on_order_quantity
string
safety_stock_quantity
string
minimum_order_quantity
string
required_by
string
is_late
string
lead_time_days
string
suggested_vendor_id
string
suggested_vendor_name
string
estimated_cost
string
status
string
urgency
string
reason
string
evidence
string
computed_at
string
actioned_at
string
dismissed_reason
string
row_version
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

actioned_at
string<timestamp with time zone>
available_quantity
number<numeric>
computed_at
string<timestamp with time zone>
demand_quantity
number<numeric>
dismissed_reason
string<text>
estimated_cost
number<numeric>
evidence
string<jsonb>
id
string<uuid>

Note: This is a Primary Key.

is_late
boolean<boolean>
lead_time_days
integer<integer>
minimum_order_quantity
number<numeric>
on_order_quantity
number<numeric>
part_criticality
string<character varying>
Maximum string length: 20
part_id
string<uuid>

Note: This is a Foreign Key to inventory_available.part_id.

part_name
string<character varying>
Maximum string length: 250
part_number
string<character varying>
Maximum string length: 80
reason
string<text>
required_by
string<date>
reserved_quantity
number<numeric>
row_version
integer<bigint>
safety_stock_quantity
number<numeric>
status
string<character varying>
Maximum string length: 30
suggested_vendor_id
string<uuid>

Note: This is a Foreign Key to vendor_directory.vendor_id.

suggested_vendor_name
string<character varying>
Maximum string length: 200
unit_of_measure
string<character varying>
Maximum string length: 30
urgency
string<character varying>
Maximum string length: 20
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