API referenceStock
List Stock
List stock with optional product, location, tracker, lock, and reservation filters.
GET
/stockcurl -X GET "https://dash.lockii.app/api/v1/stock" \
-H "x-api-key: $LOCKII_API_KEY"Authorization
x-api-keystringheaderAPI key from Settings → Integrations → API.
AuthorizationstringheaderThe same API key, or an OAuth access token, sent as Authorization: Bearer.
api_keystringqueryAPI key query parameter.
Parameters
productIDstringquerylocationIDstringquerywithTrackerbooleanqueryDefault:falsewithCurrentReservationbooleanqueryDefault:falsewithReservationsbooleanqueryDefault:falsewithLockbooleanqueryDefault:falseexcludeStockIDany ofqueryPass as a JSON string.
excludeOrderIDstringqueryreservationDateRangeobjectqueryPass as a JSON string.
availabilityenum<string>queryFilter by hire availability. available = free in the window. unavailable = already reserved. Omit unused. Pair with reservationDateRange, or omit the range for right now.
One of:availableunavailablestockIDSearchstringquerylimitnumberquery
Response
application/json
JSON result for this operation.
object
{}