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_daysintegerdefault: 30: Lookahead window in days (default 30).
include_expiredbooleandefault: True: When false, exclude lots whose expiration_date is already in the past.
limitintegerdefault: 200

Responses

200Successful Response

Schema: SuccessEnvelope_ExpiringLotsResponse_

successboolean
messagestring
codestring
dataExpiringLotsResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation 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'