List inventory locations

GET /api/v1/inventory/locations

List all inventory locations for the business with optional filtering.

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

location_type LocationTypeEnum: Filter by location type
include_archived boolean default: False: Include archived locations
cursor string: Pagination cursor
limit integer default: 50: Page size
include_total_count boolean default: False: Include total count

Responses

200 Successful Response

Schema: LocationListResponse

items array · LocationResponse requiredLocationResponse

24 fields

name string required: Location name
code string: Short code like 'WH1', 'STORE-NYC'
location_type LocationTypeEnum LocationTypeEnum: Type of location
address_line1 string
address_line2 string
city string
state string
postal_code string
country string
is_default boolean: Default location for new inventory
is_active boolean: Whether location accepts new inventory
contact_name string
contact_email string
contact_phone string
notes string
id string required
business_id string required
archived boolean required
full_address string
display_name string required
can_receive_inventory boolean required
created_at string · date-time required
updated_at string · date-time required
shopify_location_id string

total_count integer

next_cursor string

prev_cursor string

has_next boolean

has_prev boolean

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

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

bash

curl -X GET 'https://api.ondayzero.com/api/v1/inventory/locations' \
  -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', {
  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", headers=headers)
data = response.json()