BizKitHub Developer Documentation

Parameters

7 query

Query parameters

· 7

mainCategoryCodestringOptional

Filter products by main category code, or pass the literal "none" to return products that have no main category. Omit for all products.

Exampleelectronics

localestringOptional

Locale code for translated product names and descriptions (e.g. "cs", "en").

Examplecs

activestringOptional

"true" → active products only, "false" → inactive only. Omit for both.

Exampletrue

stockStatusstringOptional

"available" = in stock & not sold-out (NULL qty = unlimited); "lowStock" = qty > 0 AND qty ≤ warehouse_limit (limit required); "soldOut" = sold_out flag set OR qty = 0.

Exampleavailable

visibilitystringOptional

"inFeed" = show_in_feed=true; "notInFeed" = show_in_feed=false; "b2bOnly" = b2b=true.

ExampleinFeed

dataQualitystringOptional

"missingImage" = no main image; "missingEan" = empty EAN.

ExamplemissingImage

deletedViewstringOptional

Soft-delete view: "hide" (default) = live only, "only" = soft-deleted only (recycle bin), "include" = both. Anything else is treated as "hide".

Examplehide

Response schema

1 status code documented

200SuccessPaginated list of products.

itemsobject[]Required

Array of products matching the query criteria.

Each array item:

Single product item in the list.

idstringRequired

Product code (used as unique identifier).

codestringRequired

URL-friendly unique product code.

namestringRequired

Product name (translated if locale is specified).

slugstringRequired

URL slug for the product.

eanstringOptional

EAN barcode (13 digits).

descriptionstringOptional

Short plain-text description, truncated to 200 characters.

internalNotestringOptional

Internal note visible only in admin.

mainCategoryobjectOptional

Main category the product belongs to.

codestringRequired

Category code.

namestringRequired

Category display name.

mainImageUrlstringOptional

URL of the main product image.

positionnumberRequired

Display order position.

activebooleanRequired

Whether the product is active and visible.

deletedDatestringOptional

ISO timestamp when the product was soft-deleted. Absent on live products.

b2bbooleanRequired

Whether the product is B2B only.

showInFeedbooleanRequired

Whether the product appears in product feeds (e.g. Google Shopping).

soldOutbooleanRequired

Whether the product is sold out.

priceanyOptional

Price object with priceWithVat, priceWithoutVat, vat, currency.

warehouseAllQuantitynumberOptional

Total warehouse stock quantity.

warehouseLimitnumberOptional

Minimum stock level before reorder alert.

variantCountnumberRequired

Number of variants attached to this product (0 = plain product).

isVariantProductbooleanRequired

Convenience flag equal to variantCount > 0.

voucherTemplateCountnumberRequired

Number of voucher templates linked to this product.

subscriptionPlanCountnumberRequired

Number of subscription plans linked to this product.

statisticanyOptional

Order statistics aggregated by status type.

translatedLocalesstring[]Required

Locales for which a translation exists.

Locale code (e.g. "cs", "en").

itemCountnumberRequired

Total number of products matching the query (before pagination).

Response example

application/json

{
  "items": [
    {
      "id": "example_id",
      "code": "example_code",
      "name": "example_name",
      "slug": "example_slug",
      "ean": "example_ean",
      "description": "example_description",
      "internalNote": "example_internalNote",
      "mainCategory": {
        "code": "example_code",
        "name": "example_name"
      },
      "mainImageUrl": "example_mainImageUrl",
      "position": 0,
      "active": false,
      "deletedDate": "example_deletedDate",
      "b2b": false,
      "showInFeed": false,
      "soldOut": false,
      "warehouseAllQuantity": 0,
      "warehouseLimit": 0,
      "variantCount": 0,
      "isVariantProduct": false,
      "voucherTemplateCount": 0,
      "subscriptionPlanCount": 0,
      "translatedLocales": [
        "string"
      ]
    }
  ],
  "itemCount": 0
}

/bff/product/list