List product variants

GET/api/v1/inventory/products/variants

Retrieve all variants with optional filtering by product.

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

product_idstring

Filter by parent product ID

archivedboolean

Filter by archived status

cursorstring

Cursor for pagination

limitinteger

Pagination limit

directionstringdefault: next

Pagination direction: 'next' or 'prev'

include_total_countbooleandefault: False

Whether to include total count (expensive - avoid if possible)

sort_bystring

Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.

descendingbooleandefault: True

Sort direction: true for descending (newest/largest first), false for ascending

Responses

200Successful Response

successboolean
messagestring
codestring
dataVariantsListResponse

404Business not found

422Invalid query parameters