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

productgetApiV1ProductFeed

Parameters

8 query

8 total

Query · 8

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.

Request

GET /api/v1/product/feed

get

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" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Paginated product feed response.

{
  "count": 0,
  "totalCount": 0,
  "items": [
    {
      "id": 42,
      "name": "Cheese Burger",
      "slug": "cheese-burger",
      "shortDescription": "example_shortDescription",
      "mainImageUrl": "example_mainImageUrl",
      "mainCategory": {
        "slug": "smartphone",
        "code": "CAT-001",
        "name": "Smartphones"
      },
      "price": 250,
      "priceWithoutVat": 0,
      "vat": 0,
      "position": 1,
      "active": false,
      "soldOut": false,
      "warehouseAllQuantity": 0,
      "warehouseLimit": 0,
      "customFields": {},
      "event": {
        "id": "example_id",
        "isAllDay": false,
        "isBlocking": false,
        "title": "example_title",
        "description": "example_description",
        "agenda": "example_agenda",
        "url": "example_url",
        "locationTitle": "example_locationTitle"
      },
      "orderStatistics": {
        "totalQuantitySold": 0,
        "statusNew": 0,
        "statusProcessing": 0,
        "statusStorno": 0,
        "statusDone": 0
      },
      "galleryItemsCount": 0
    }
  ]
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key