Adjustments grouped by reason

GET /api/v1/inventory/reports/adjustment-reasons

Aggregates inventory ledger rows whose correction_reason is set (i.e. manual adjustments and cycle-count posts) by reason code. Returns count, signed units, and a $-impact estimate using each variant's stored unit_cost. Use since/until ISO-8601 strings to scope the window (defaults to all-time).

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

since string · date-time: Inclusive lower bound (ISO-8601). Omit for all-time.
until string · date-time: Exclusive upper bound (ISO-8601). Omit for now.

Responses

200 Successful Response

Schema: AdjustmentReasonsResponse

since string · date-time

until string · date-time

rows array · AdjustmentReasonRow AdjustmentReasonRow

6 fields

reason string required
label string required
adjustment_count integer required
total_units number required: Sum of inventory.delta for this reason (signed).
total_value_cents integer required: Total $-value impact (cents) using each variant's unit_cost as a proxy for the GL impact.
is_canonical boolean required: True when the reason matches a known enum value.

total_adjustments integer

total_value_cents integer

400 Bad Request - Invalid input

422 Validation Error - Invalid data format

Code samples

GET /api/v1/inventory/reports/adjustment-reasons

bash

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