/api/v1/product/detail

No description provided.

productgetApiV1ProductDetail

Parameters

4 query

4 total

Query · 4

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

slugstringRequired

localestring

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

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

get

curl -X GET "https://api.bizkithub.com/api/v1/product/detail?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&slug=example_slug&locale=cs&properties=orderStatistics%3BgalleryItemsCount" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Full product detail from the read model.

{
  "id": "burger",
  "code": "burger",
  "name": "Cheese Burger",
  "slug": "cheese-burger",
  "shortDescription": "example_shortDescription",
  "longDescription": "example_longDescription",
  "mainImageUrl": "https://storage.xhp.cz/...",
  "galleryItems": [
    {
      "type": "image",
      "id": 0,
      "url": "https://storage.xhp.cz/...",
      "title": "example_title",
      "tag": "example_tag"
    }
  ],
  "galleryItemsCount": 0,
  "isVariantProduct": false,
  "variantItems": [
    {
      "id": "abc123",
      "code": "cheese-burger",
      "name": "Cheese Burger",
      "ean": "8594000000001",
      "price": 250,
      "warehouseAllQuantity": 0
    }
  ],
  "active": false,
  "b2b": false,
  "showInFeed": false,
  "soldOut": false,
  "position": 1,
  "mainCategory": {
    "slug": "smartphone",
    "code": "CAT-001",
    "name": "Smartphones"
  },
  "categoryPathItems": [
    {
      "slug": "smartphone",
      "code": "CAT-001",
      "name": "Smartphones"
    }
  ],
  "categoryItems": [
    {
      "slug": "smartphone",
      "code": "CAT-001",
      "name": "Smartphones"
    }
  ],
  "brandId": 0,
  "price": 250,
  "priceWithoutVat": 206.61,
  "vat": 21,
  "standardPricePercentage": 0,
  "sizeWidthMm": 0,
  "sizeHeightMm": 0,
  "sizeDepthMm": 0,
  "weightGrams": 0,
  "warehouseAllQuantity": 0,
  "warehouseLimit": 0,
  "event": {
    "id": "example_id",
    "isAllDay": false,
    "isBlocking": false,
    "title": "example_title",
    "description": "example_description",
    "agenda": "example_agenda",
    "url": "example_url",
    "locationTitle": "example_locationTitle"
  },
  "advance": {
    "relatedCustomers": [
      "string"
    ]
  },
  "relatedProducts": [
    {
      "slug": "example_slug",
      "name": "example_name",
      "mainImageUrl": "example_mainImageUrl",
      "price": 0,
      "mainCategory": {
        "slug": "smartphone",
        "code": "CAT-001",
        "name": "Smartphones"
      },
      "shortDescription": "example_shortDescription"
    }
  ],
  "customFields": {},
  "orderStatistics": {
    "totalQuantitySold": 0,
    "statusNew": 0,
    "statusProcessing": 0,
    "statusStorno": 0,
    "statusDone": 0
  }
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key