/api/v1/product/feed

Load full list of products from organisation database. By default, we only return basic properties for all products. If you want to return entire products, you need to specify additional properties.

Default properties (contains in all returned products): id, name, slug, shortDescription, mainImageUrl, mainCategory, price, priceWithoutVat, vat, position, active, soldOut, warehouseAllQuantity, warehouseLimit, customFields, event.

Endpoint Info

Base URLapi.bizkithub.com

AuthBearer Token

Methods1

Authentication Required

This endpoint requires a valid API key passed as a query parameter or Bearer token.

Get your API key

Parameters

8 query parameters

apiKeystringrequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

querystring

Search query

localestring

Locale code (e.g. "cs", "en"). Returns translated read models for the given locale with fallback to default.

orderBystring

Order by indexed internal field.

Supported values: position, price, priceDesc, eventDate.

Default: position

categorystring

Filter products from category by slug.

pagestring

Default: 1

limitstring

Default: 32

propertiesstring

Add extra on demand properties separated by semicolon.

Supported values:

Property	Description
`orderStatistics`	Extra statistics data like `totalQuantitySold` and count of orders in states.
`galleryItemsCount`	Count of public images in product detail.

Example Request

JavaScript fetch

const response = await fetch("https://api.bizkithub.com/api/v1/product/feed?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&query=iphone&locale=cs&orderBy=position&category=smartphone&page=1&limit=32&properties=orderStatistics%3BgalleryItemsCount", {
  method: "GET",
  headers: {
    "Content-Type": "application/json"
  }
});

const data = await response.json();
console.log(data);

get

Example Response

200Success

{}

cURL

Command line example

curl -X GET "https://api.bizkithub.com/api/v1/product/feed?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&query=iphone&locale=cs&orderBy=position&category=smartphone&page=1&limit=32&properties=orderStatistics%3BgalleryItemsCount" \
  -H "Content-Type: application/json"

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key

Back to API Documentation API Reference