Get inventory summaries for all locations

GET/api/v1/inventory/locations/summaries

Get inventory summaries for all locations of the business in a single request.

Operation ID: get_location_summaries_api_v1_inventory_locations_summaries_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

include_archivedbooleandefault: False: Include archived locations

Responses

200Successful Response

Schema: SuccessEnvelope_LocationInventorySummariesResponse_

successboolean
messagestring
codestring
dataLocationInventorySummariesResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/inventory/locations/summaries

bash

curl -X GET 'https://api.ondayzero.com/api/v1/inventory/locations/summaries' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'