|
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
Path Parameters
Query String Parameters (Filters)
|
Field |
Type |
Note |
|---|---|---|
|
materialId |
Collection<Long> |
Filter by one or more material identifiers. |
|
typeId |
Collection<Long> |
Filter by one or more warehouse type identifiers. |
|
quantity |
Double |
The required quantity to check for availability. |
|
searchOnMobileWarehouses |
Boolean |
If true, includes mobile warehouses (e.g., technician van stocks) in the search. |
|
searchOnPreferredWarehouses |
Boolean |
If true, prioritizes or limits the search to preferred warehouses. |
|
searchOnOtherCentralWarehouses |
Boolean |
If true, extends the search to other central warehouses. |
|
maxDistanceFromCurrentPosition |
Double |
Maximum radius (distance) for the availability search from the current coordinates. |
|
currentXCoordinate |
Double |
X coordinate (Longitude) for proximity-based search. |
|
currentYCoordinate |
Double |
Y coordinate (Latitude) for proximity-based search. |
|
computeEstimatedTimeToArrive |
Boolean |
If true, the system calculates the ETA to the warehouse. |
|
departure |
ZonedDateTimeRange |
Time range for departure, used for ETA and availability window calculations (Format: ISO-8601). |
Language ℹ️
Default.
Header Parameters
Default.
Response documentation
Response payload fields
|
Field |
Type |
Description |
|---|---|---|
|
materialId |
Long |
Identifier of the material found. |
|
stockId |
Long |
Unique identifier of the specific stock record. |
|
warehouseId |
Long |
Identifier of the warehouse where the material is located. |
|
codeWarehouse |
String |
Alphanumeric code of the warehouse. |
|
warehouseTypeId |
Long |
Identifier of the warehouse type. |
|
preferred |
Boolean |
Indicates if this warehouse is marked as a preferred location for the user. |
|
resourceId |
Long |
Identifier of the resource (e.g., technician) if the warehouse is mobile. |
|
distance |
Long |
Distance from the search origin (usually in meters). |
|
quantity |
Double |
The available quantity of the material. |
|
measureUnitId |
Long |
Identifier of the unit of measurement. |
|
longitude |
Double |
Longitude coordinate of the warehouse position. |
|
latitude |
Double |
Latitude coordinate of the warehouse position. |
|
detectionDate |
ZonedDateTime |
Timestamp of when the availability was last detected/recorded. |
|
estimatedTimeOfArrival |
ZonedDateTime |
Estimated time of arrival (ETA) at the warehouse location. |
|
insertUserId |
Long |
ID of the user who created the record (inherited from DynO). |
|
insertDate |
ZonedDateTime |
Creation timestamp (inherited from DynO). |
|
updateUserId |
Long |
ID of the user who last updated the record (inherited from DynO). |
|
updateDate |
ZonedDateTime |
Last update timestamp (inherited from DynO). |
Response error codes