BizKitHub
DocsAPI ReferenceProduct/bff/product/product-variant-list
getProductAdmin BFF

/bff/product/product-variant-list

Returns a paginated list of product variants with full detail. By default only live variants are returned; pass includeDeleted=true to include hidden ones (each row carries a deleted flag). Ordered by warehouse quantity (highest first), then by position. Supports pagination via "page" and "limit" query parameters.

ProductgetBffProductProduct-variant-list

Parameters

2 query

Query parameters

· 2
productCodestringRequired

Product code to list variants for.

Examplemy-product
includeDeletedbooleanOptional

When true, hidden (soft-deleted) variants are included in the response so the operator can review and restore them. Defaults to false; hidden variants are never exposed to the public API or read model.

Examplefalse

Response schema

1 status code documented

200Success
itemsobject[]Required

Product variants.

Each array item:
idstringRequired

Variant relation hash (unique identifier).

namestringOptional

Variant display name.

codestringRequired

Variant code.

eanstringOptional

Variant EAN barcode.

priceanyRequired

Price object with priceWithVat, priceWithoutVat, vat, currency.

priceAdditionnumberRequired

Additional price on top of the base product price.

costnumberRequired

Internal cost in the organisation default currency. 0 when not set (falls back to product.cost at order time).

soldOutbooleanRequired

Whether the variant is sold out.

warehouseAllQuantitynumberRequired

Total warehouse stock for this variant.

deletedbooleanRequired

Whether the variant is hidden (soft-deleted). Hidden variants are excluded from the read model and public API.

mainImageobjectOptional
tokenstringRequired

Blob token (image identifier).

filenamestringRequired

Original filename.

downloadUrlstringRequired

Public download URL.

contentTypestringRequired

MIME content type.

itemCountnumberRequired

Total number of variants matching the current filter (respects includeDeleted).

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "name": "example_name",
      "code": "example_code",
      "ean": "example_ean",
      "priceAddition": 0,
      "cost": 0,
      "soldOut": false,
      "warehouseAllQuantity": 0,
      "deleted": false,
      "mainImage": {
        "token": "example_token",
        "filename": "example_filename",
        "downloadUrl": "example_downloadUrl",
        "contentType": "example_contentType"
      }
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/product/product-variant-list

get
curl -X GET "https://api.bizkithub.com/bff/product/product-variant-list?productCode=my-product&includeDeleted=false" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key