BizKitHub

API pro produktový feed

Produktový feed je čtecí koncový bod, který pohání jakýkoli seznam produktů s mnoha položkami na obchodníkově e-shopu — na úvodní stránce, stránce kategorie, ve výsledcích vyhledávání nebo při exportu do srovnávače cen. Vrací stránku produktů s poli, která jsou pro zobrazení seznamu potřebná (název, cena, miniatura, dostupnost, hlavní kategorie), bez plného detailního obsahu. Volající mohou feed volat při každém zobrazení stránky; platforma ho poskytuje z interně uložené kopie, která se aktualizuje při každé změně katalogu, takže je jeho volání při vysoké frekvenci levné.

Naposledy aktualizováno 1. srpna 2026

Produktový feed je čtecí koncový bod, který pohání jakýkoli seznam produktů s mnoha položkami na obchodníkově e-shopu — na úvodní stránce, stránce kategorie, ve výsledcích vyhledávání nebo při exportu do srovnávače cen. Vrací stránku produktů s poli, která jsou pro zobrazení seznamu potřebná (název, cena, miniatura, dostupnost, hlavní kategorie), bez plného detailního obsahu. Volající mohou feed volat při každém zobrazení stránky; platforma ho poskytuje z interně uložené kopie, která se aktualizuje při každé změně katalogu, takže je jeho volání při vysoké frekvenci levné.

A produkt v rámci platformy je širší pojem než "položka s cenou": může to být fyzické zboží, digitální stažení, virtuální dárek, doplňková služba, událost vázaná na kalendář (vstupenky, kurzy, tábory) nebo nezprodejný záznam v adresáři (trenér v posilovně, místnost v areálu). Všechny z nich žijí ve stejném virtuálním katalogu produktů a jsou zpřístupněny tímto koncovým bodem.

Pro protějšek na straně administrace — jak jsou produkty vytvářeny, oceňovány a seskupovány z administrace — viz článek Produkty. Tento dokument je smlouvou pro vývojáře pro koncový bod feedu. Pro detailní odpověď jednoho produktu viz API detailu produktu.

Koncový bod

GET https://api.bizkithub.com/product/v1/feed

Autentizace probíhá pomocí standardního parametru apiKey (viz článek API klíč).

Parametry dotazu

Všechny parametry jsou volitelné; pokud nejsou zadány žádné, feed vrátí každý produkt v organizaci, v výchozím pořadí platformy.

Vlastnost Typ Význam
query string Fulltextový vyhledávací termín. Shoduje se s názvem produktu, kódem a popisem.
category string Kód kategorie, do které produkty musí patřit. Výchozí hodnota jsou všechny kategorie.
page number Číslo stránky (od 1) pro velké sady výsledků. Výchozí hodnota je 1.
limit number Maximální počet položek na stránku. Výchozí hodnota je 32.

Odpověď

export type ProductId = `${string}`;
export type PublicProductFeedResponse = {
count: number;
items: ProductFeedItem[];
};
export type ProductFeedItem = {
id: ProductId;
name: string;
slug: string;
shortDescription?: TrustedHTML;
mainImageUrl?: string;
mainCategory?: { code: string; name: string };
price: number;
position: number;
active: boolean;
soldOut: boolean;
warehouseAllQuantity?: number;
warehouseLimit?: number;
customFields: Record<string, string>;
event?: PublicProductEventResponse;
};

Každá položka ve feedu je kompaktní reprezentace určená pro uživatelské rozhraní seznamu. Sledujte slug položky k API detailu produktu, když volající potřebuje plné detaily — dlouhý popis, galerii, varianty, fyzické rozměry a všechna ostatní bohatá pole.

Řazení

Seznam výsledků je deterministicky seřazen. Nevyprodané položky jsou vždy zobrazeny jako první a v rámci této části jsou položky seřazeny podle jejich ručně přiřazené pozice. Vyprodané položky jsou umístěny za dostupnými položkami.

Pořadí je stabilní napříč voláními. Dva po sobě jdoucí požadavky se stejnými parametry vrátí položky ve stejných slotech, i když byly mezitím upraveny nesouvisející produkty v katalogu. To je důležité pro SEO: stránka seznamu, jejíž pořadí produktů se mění každou hodinu, se vyhledávačům jeví jako nestabilní a oslabuje zpětné odkazy, které směřují na konkrétní pozice v seznamu.

Aktuálnost

Položky feedu jsou poskytovány z uložené kopie, která se aktualizuje při každé změně katalogu (název, cena, obrázky, přiřazení kategorie, varianty, vlastní pole). Nestabilní provozní pole — dostupnost, příznak vyprodání, příznak smazání — jsou obohaceny v době čtení z živé databáze, takže odpověď je vždy konzistentní snímek marketingových dat plus provozní stav v reálném čase. Není nutná žádná ruční invalidace cache; úprava obchodníka je viditelná při dalším volání.

Související články

Související články