Get location inventory summary

GET /api/v1/inventory/locations/{location_id}/summary

Get summary of inventory at a location.

Operation ID: get_location_summary_api_v1_inventory_locations__location_id__summary_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

Path

location_id string required

Responses

200 Successful Response

Schema: LocationInventorySummary

location_id string required
location_name string required
location_code string
total_variants integer
total_on_hand integer
total_available integer
needs_reorder_count integer
inbound_quantity integer
outbound_quantity integer
ready_to_ship_quantity integer

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

GET /api/v1/inventory/locations/{location_id}/summary

bash

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

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/inventory/locations/{location_id}/summary', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/inventory/locations/{location_id}/summary", headers=headers)
data = response.json()