/bff/product/product-gallery-list

Returns all non-deleted images in the product gallery sorted by active status and position. Includes blob metadata (URL, dimensions) and identifies the main/featured image.

ProductgetBffProductProduct-gallery-list

Parameters

1 query

Query parameters

· 1

codestringRequired

Product code.

Examplemy-product

Response schema

1 status code documented

200Success

itemsobject[]Required

Gallery images sorted by active status then position.

Each array item:

idstringOptional

Blob token (used as image identifier in other endpoints).

urlstringOptional

External URL if the media is not a blob.

blobanyRequired

Blob file metadata (filename, URL, dimensions, size).

titlestringRequired

Image alt text / title.

positionnumberRequired

Display order position (1-based).

deletedbooleanRequired

Whether the image is soft-deleted.

activebooleanRequired

Whether the image is active (visible on the public site).

mainImageIdstringOptional

Blob token of the current main/featured image.

itemCountnumberRequired

Total number of non-deleted images in the gallery.

Response example

application/json

{
  "items": [
    {
      "id": "example_id",
      "url": "example_url",
      "title": "example_title",
      "position": 0,
      "deleted": false,
      "active": false
    }
  ],
  "mainImageId": "example_mainImageId",
  "itemCount": 0
}

Request example

GET /bff/product/product-gallery-list

get

curl -X GET "https://api.bizkithub.com/bff/product/product-gallery-list?code=my-product" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key