Stock GET /inventory/warehouses/r1/warehouses/stocks/availabilities

Http Verb	GET
Url	`/inventory/warehouses/r1/warehouses/stocks/availabilities`
Permissions required
Personally Identifiable Information (PII)	No
Sensitive Information	No
Last Modified Version	r2
Released since	2026 W07 (FSM 26.0)
Deprecated since
Removed since
Tech Tags	Inventory, Warehouse, Central

Business Logic

An advanced spatial search API. It finds the availability of specific materials across various warehouse types, supporting geographic distance filtering and Estimated Time of Arrival (ETA) computations based on the requester's coordinates.

Path Parameters

Query String Parameters (Filters)

Field	Type	Note
`materialId`	Collection<Long>	The materials to search for.
`typeId`	Collection<Long>	Filter by specific stock types.
`quantity`	Double	Minimum quantity required.
`searchOnMobileWarehouses`	Boolean	Include mobile warehouses in the search.
`searchOnPreferredWarehouses`	Boolean	Include the user's preferred warehouses.
`searchOnOtherCentralWarehouses`	Boolean	Include other central warehouses.
`maxDistanceFromCurrentPosition`	Double	Radius limit for the search.
`currentXCoordinate`	Double	Longitude of the requester.
`currentYCoordinate`	Double	Latitude of the requester.
`computeEstimatedTimeToArrive`	Boolean	Trigger ETA calculation engine.
`departure`	ZonedDateTimeRange	Time window for departure calculations.

Language ℹ️

Default.

Header Parameters

Default.

Response documentation

Response payload fields

Field	Type	Description
`materialId`	Long	Identifier of the material found.
`stockId`	Long	Identifier of the specific stock holding the material.
`warehouseId`	Long	Identifier of the warehouse.
`codeWarehouse`	String	The alphanumeric code of the warehouse.
`warehouseTypeId`	Long	The type of the warehouse found.
`preferred`	Boolean	Indicates if this is a preferred warehouse.
`resourceId`	Long	Associated resource ID (if mobile warehouse).
`distance`	Long	Calculated distance from the requester's coordinates.
`quantity`	Double	Available quantity at this location.
`measureUnitId`	Long	Unit of measure for the quantity.
`longitude`	Double	Longitude of the warehouse.
`latitude`	Double	Latitude of the warehouse.
`detectionDate`	ZonedDateTime	When the availability was calculated.
`estimatedTimeOfArrival`	ZonedDateTime	Computed ETA (if requested).

Response error codes