/bff/product/list

Returns a list of products for the authenticated organisation. Products are ordered by active status (active first) and then by position. Each product includes basic metadata, main image URL, category, price, and order statistics.

ProductgetBffProductList

Parameters

7 query

7 total

Query · 7

mainCategoryCodestring

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

localestring

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

activestring

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

stockStatusstring

"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.

visibilitystring

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

dataQualitystring

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

deletedViewstring

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

Request

GET /bff/product/list

get

curl -X GET "https://api.bizkithub.com/bff/product/list?mainCategoryCode=electronics&locale=cs&active=true&stockStatus=available&visibility=inFeed&dataQuality=missingImage&deletedView=hide" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Paginated list of products.

{
  "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,
      "translatedLocales": [
        "string"
      ]
    }
  ],
  "itemCount": 0
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key