API rozhraní¶

V rámci modulu Navertica Product Platform Management je zahrnuto API rozhraní, které je možné využít pro export produktový dat mimo modul a jejich prezentaci. Toto rozhraní je primárně určené pro čtení dat, zápis dat je tedy povoolený pouze ve vyrbraných případech.

Kolekce s příklady použití API včetně vzorových dat je dostupná pod následujícím odkazem:

Kliněte zde pro stažení kolekce

endpoint pimProductPlatforms¶

Pro účely získání dat týkajících se aktuálního nastavení produktové platformy je připraven endpoint pimProductPaltforms (ve skupině navertica\productPlatforms), který bude sloužit k přenášení informací o produktových platformách a jejich hlavních parametrech. Tento endpoint bude vycházet převážně z tabulky Produktové platformy a podporuje výhradně metodu GET (tzn.nedává externím systémům možnost vytvářet, upravovat či mazat existující záznamy).

endpoint pimItems¶

Pro účely přenosu dat o základních kartách produktů byl vytvořen endpoint pimItems (ve skupině navertica\productPlatforms), který slouží k přenášení informací o výčtu existujících produktů. Tento endpoint bude vycházet převážně z tabulky Zboží (T27 Item) a podporuje výhradně metodu GET (není tedy očekáváno, že by externí systém prováděl vytváření, úpravy či mazání záznamů).

endpoint pimItemVariants¶

Pro účely předání dat o aktuálních variantách zboží byl vytvořen endpoint pimItemVariants (ve skupině navertica\productPlatforms), který slouží k přenášení informací o variantách produktů. Tento endpoint bude vycházet převážně z tabulky Varianty zboží a podporuje výhradně metodu GET (neumožňuje tedy vytváření, změny či odstranění záznamů). Tento endpoint je možné volat samostatně případně jako expand pod pimItems.

endpoint pimItemTranslations¶

Pro účely předávání základních překladů popisů produktů byl vytvořen endpoint pimItemTranslations (ve skupině navertica\productPlatforms), který slouží k přenášení informací o standardních základních překladech názvů produktů a jejich variant. Tento endpoint bude vycházet převážně z tabulky Překlad zboží a podporuje výhradně metodu GET (neumožňuje tedy vytváření, změny či odstranění záznamů).

Endpoint je možné volat samostatně, případně je možné jej volat jako expand pod pimItems, případně pimItemVariants.

endpoint pimItemReferences¶

Pro účely přenosu alternativních identifikátorů produktů či jejich variantu byl vytvořen endpoint pimItemReferences (ve skupině navertica\productPlatforms), který slouží k přenášení informací o standardních křížových odkazech zboží (tedy alternativních identifikátorech zboží z pohledu zákazníka/dodavatele či pro interní použití). Tento endpoint bude vycházet převážně z tabulky Odkazy na zboží a podporuje výhradně metodu GET (není tedy možné vytvářet, měnit či mazat záznamy).

Endpoint je možné volat samostatně, případně je možné jej volat jako expand pod pimItems, případně pimItemVariants.

endpoint pimItemUoMs¶

Pro účely přenosu informací o měrných jednotkách zboží byl vytvořen endpoint pimItemUoMs (ve skupině navertica\productPlatforms), který slouží k přenášení informací o standardních měrných jednotkách zboží (tedy měrných jednotek a jejich přepočtů). Tento endpoint bude vycházet převážně z tabulky Měrné jednotky zboží a je mmožné ho volat výhradně s metodou GET (nepředpokládá se tedy, že by externí systém měl možnost zakládat, měnit či mazat záznamy).

Endpoint je možné volat samostatně, případně je možné jej volat jako expand pod pimItems.

endpoint pimCategories¶

Pro účely přenosu informací o kategoriích zboží byl vytvořen endpoint pimCategories (ve skupině navertica\productPlatforms), který slouží k přenášení informací o stromech kategorií zboží, které jsou definovány v BC. Tento endpoint bude vycházet převážně z tabulky Kategorie zboží a bude možné jej volat výhradně s metodou GET (nepředpokládá se tedy, že by externí systém měl možnost vytvářet, měnit či mazat záznamy).

Endpoint bude možné volat samostatně.

endpoint pimRelations¶

Pro účely předávání informací o aktuálně platných vazbách entit v rámci pIM modulu byl vytvořen endpoint pimRelations (ve skupině navertica\productPlatforms), který slouží k přenášení informací o vazbách mezi jednotlivými entitami používanými v rámci PIM. Tento endpoint bude vycházet převážně z tabulky Vazby mezi entitami PIM a bude podporovat metody GET, POST, PATCH a DELETE, předpokladem totiž je, že do BC může být žádoucí přenášet i vazby, které budou generovány externím systémem (např. e-shop je napojený na umělou inteligenci, která generuje bundly či jiné varianty up-sellingu/cross-sellingu a ty je třeba dále využívat v BC).

Endpoint je možné volat samostatně.

endpoint pimLabelAssignments¶

Pro účely přenosu informací o přiřazených štítcích byl vytvořen endpoint pimLabelAssignments (ve skupině navertica\productPlatforms), který bude slouží k přenášení informací o evidovaných přiřazeních PIM štítků. Tento endpoint bude vycházet převážně z tabulky Přiřazení štítků PIM a bude podporovat výhradně metodu GET (nepředpokládá se tedy, že by externí systém měl možnost vytvářet, měnit či mazat záznamy).

Endpoint je možné volat samostatně, případně je možné jej volat jako expand pod pimItems, případně pimItemVariants.

endpoint pimLabels¶

Pro účely přenosu aktuálního výčtu štítků slouží endpoint pimLabels (ve skupině navertica\productPlatforms), který bude sloužit k přenášení informací o PIM štítcích nastavených v BC. Tento endpoint vychází převážně z tabulky PIM štítky a podporuje výhradně metodu GET (nepředpokládá se tedy, že by externí systém měl možnost vytvářet, měnit či mazat záznamy).

Endpoint je možné volat samostatně.

endpoint pimLabelTranslations¶

Pro účely přenosu překladů jednotlivých štítků definovaných v BC slouží endpoint pimLabelTranslations (ve skupině navertica\productPlatforms), který slouží k přenášení informací o překladech PIM štítků. Tento endpoint bude vycházet převážně z tabulky Překlady PIM štítku (T4028251 NVR PP Label Translation) a podporuje výhradně metodu GET (nepředpokládá se tedy, že by externí systém měl možnost vytvářet, měnit či mazat záznamy).

Endpoint je možné volat samostatně, případně je možné jej volat jako expand pod pimLabels.

endpoint pimPlatformAssignments¶

Pro účely předávání informaci o přiřazení produktů a kategorií jednotlivým produktovým platformám slouží endpoint pimPlatformAssignments (ve skupině navertica\productPlatforms), který slouží k přenášení informací o zařazení produktu do stromů kategorií a případně do produktových platforem. Tento endpoint bude vycházet převážně z tabulky Přiřazení produktových platforem a podporuje výhradně metodu GET (nepředpokládá se tedy, že by externí systém měl možnost vytvářet, měnit či mazat záznamy).

Endpoint je možné volat samostatně, případně je možné jej volat jako expand pod pimItems a pimItemVariants.

endpoint pimAttributeAssignmnets¶

Pro účely přenosu informací o aktuálním přiřazení atributů zboží byl vytvořen nový endpoint pimAttributeAssignment (ve skupině navertica\productPlatforms), který slouží k přenášení informací o přiřazení hodnot atributů k jednotlivým entitám. Tento endpoint bude vycházet převážně z tabulky Rozšířené mapování atributů zboží a bude podporovat výhradně metodu GET (nebude tedy umožňovat vytvářet, měnit či mazat záznamy).

Endpoint je možné volat samostatně, případně je možné jej volat jako expand pod pimAttributes.

endpoint pimAttributes¶

Pro účely přenosu informací o existujících atributech zboží byl vytvořen endpoint pimAttributes (ve skupině navertica\productPlatforms), který slouží k přenášení informací o atributech zboží. Tento endpoint bude vycházet převážně z tabulky Atributy zboží a podporuje výhradně metodu GET (nebude tedy umožňovat vkládat, měnit či mazat záznamy).

Endpoint je možné volat samostatně.

endpoint pimAttributeTranslations¶

Pro účely přenosu překladů definovaných pro atributy byl vytvořen nový endpoint pimAttributeTranslations (ve skupině navertica\productPlatforms), který slouží k přenášení informací o překladech atributů. Tento endpoint vychází převážně z tabulky Překlady atributů zboží a podporuje výhradně metodu GET (nepředpokládá se tedy, že by externí systém měl možnost vytvářet, měnit či mazat záznamy).

Endpoint je možné volat samostatně, případně je možné jej volat jako expand pod pimAttributes.

endpoint pimAttributeValues¶

Pro účely přenosu výčtu hodnot atributů je přiřaven endpoint pimAttributeValues (ve skupině navertica\productPlatforms), který slouží k přenášení informací o hodnotách atributů. Tento endpoint vychází převážně z tabulky Hodnoty atributů zboží a podporuje výhradně metodu GET (nepředpokládá se tedy, že by externí systém měl možnost vytvářet, měnit či mazat záznamy).

Endpoint je možné volat samostatně, případně je možné jej volat jako expand pod pimAttributes.

endpoint pimAttributeValueTranslations¶

Pro účely přenosu překladů hodnot atributů byl připraven endpoint pimAttributeValueTranslations (ve skupině navertica\productPlatforms), který slouží k přenášení informací o překladech hodnot atributů. Tento endpoint vychází převážně z tabulky Překlady hodnot atributů zboží a podporuje výhradně metodu GET (nepředpokládá se t edy, že by externí systém měl možnost vytvářet, měnit či mazat záznamy).

Endpoint je možné volat samostatně, případně je možné jej volat jako expand pod pimAttributeValues.

endpoint pimTexts¶

Pro účely přenosu rozšířených textů byl vytvořen endpoint pimTexts (ve skupině navertica\productPlatforms), který slouží k přenášení dat PIM textů do externích systémů. Tento endpoint vychází převážně z tabulky PIM text a podporuje výhradně metodu GET (nepředpokládá se tedy, že by externí systém měl možnost vytvářet, měnit či mazat záznamy).

Endpoint je možné volat samostatně, případně je možné jej volat jako expand pod pimItems, pimItemVariants a pimCategories.

endpoint pimPrices¶

Pro účely přenosu informace o aktuálních cenách byl vytvořen endpoint pimPrices (ve skupině navertica\productPlatforms), který slouží k přenášení informací o nákupních a prodejních cenách produktů. Tento endpoint vychází převážně z tabulky Řádky ceníku a podporuje výhradně metodu GET (nepředpokládá se tedy, že by externí systém měl možnost vytvářet, měnit či mazat záznamy).

Endpoint je možné volat samostatně.

endpoint pimMedia¶

Pro účely přenosu souvesejících médiíBude vytvořen nový endpoint pimMedia (ve skupině navertica\productPlatforms), který slouží k přenášení informací o přiřazených dokumentech, médiích, odkazech či obrázcích. Tento endpoint vychází převážně z tabulky Média PIM a podporuje výhradně metodu GET (nepřepokládá se, že by externí systém mohl vytvářet, měnit či mazat záznamy).

Endpoint je možné volat samostatně, případně je možné jej volat jako expand pod pimItems, pimItemVariants a pimCategories.