API ReferenceLocations

List Materials at Location

Returns a paginated list of materials currently stocked at a location, including on-hand quantity, unit of measurement, and pricing information. Returns `404` if the ID belongs to a job — use `GET /jobs/{id}/materials` for job materials. Each row's `materialDetailsId` is the identifier to pass when adding the material to a pick list (see `POST /pick-lists/{id}/materials`). Use the `materialIds` filter to quickly locate the record(s) for a known catalog material at this location. Requires scope: `locations:read`

Authentication

API_KEYstring
API Key authentication via header

Path parameters

idUUIDRequired
Location ID.

Query parameters

pageintegerOptional

Zero-based page index. Defaults to 0.

sizeintegerOptional

Items per page. Defaults to 20, maximum 100.

materialIdslist of UUIDsOptional

Filter to one or more catalog material IDs (the material.id value). Repeat the parameter to pass several IDs (e.g. ?materialIds=<id1>&materialIds=<id2>). When omitted, all materials stocked at the location are returned. IDs not stocked at this location simply contribute no rows.

sortstringOptional
Sort by `field,direction` (Spring Pageable format; direction `asc` or `desc`, default `asc`). Allowed fields: materialDetailsId, id (deprecated alias of materialDetailsId), quantity, measurement, cost, unitPrice, itemNumber, brand, manufacturer. Default order (when no sort is supplied): related material name, ascending.

Response

This endpoint returns an object.
datalist of objects
paginationobject
Pagination metadata returned on all list endpoints.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error