List expiring cost lots

GET /api/v1/inventory/lots/expiring

Return non-exhausted cost lots with an expiration_date within the next within_days days. Powers the 'Expiring soon' badge on the inventory overview.

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

within_days integer default: 30: Lookahead window in days (default 30).
include_expired boolean default: True: When false, exclude lots whose expiration_date is already in the past.
limit integer default: 200

Responses

200 Successful Response

Schema: ExpiringLotsResponse

within_days integer required

lots array · ExpiringLot ExpiringLot

11 fields

id string required
variant_id string
variant_name string
sku string
product_name string
lot_number string
external_lot_id string
expiration_date string · date
days_until_expiry integer: Days from today to expiration_date (negative when already expired).
quantity_remaining number required
unit_cost_cents integer required

total_remaining_value_cents integer

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

422 Validation Error - Invalid data format

Code samples

GET /api/v1/inventory/lots/expiring

bash

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