Retino Products XML feed
Retino Products XML feed je klíčový nástroj, který umožňuje synchronizaci produktového katalogu vašeho e-shopu s Retino systémem. Díky této integraci můžete využívat rozšířené funkce jako například vytváření skladových reklamací, vyhledávání produktů podle kódu nebo EAN a další pokročilé možnosti správy produktů.
K čemu slouží Retino Products XML feed
Produktový feed slouží především k těmto účelům:
- Vytváření skladových reklamací v doplňku Dodavatelské reklamace bez nutnosti existující zákaznické reklamace
- Rychlé vyhledávání produktů podle kódu, názvu, EAN nebo dalších parametrů
- Získání přesných informací o produktech včetně cen, kategorií a skladových zásob
- Možnost detailního popisu produktů pro lepší správu reklamací
Důležitá informace. Pokud používáte platformu Shoptet, produkty se z vašeho e-shopu synchronizují automaticky přes API a není potřeba konfigurovat XML feed popsaný v tomto článku.
Struktura XML feedu
Produktový feed má jasně definovanou strukturu, která musí být dodržena pro správnou funkčnost:
Základní struktura dokumentu
Feed začíná XML hlavičkou s verzí 1.0 a UTF-8 kódováním (podporujeme pouze UTF-8). Poté následuje párový tag PRODUCTS
, ve kterém jsou umístěny všechny produkty, každý v samostatném tagu PRODUCT
.
Příklad základní struktury:
<?xml version="1.0" encoding="UTF-8"?> <PRODUCTS> <PRODUCT> <!-- detaily produktu --> </PRODUCT> <PRODUCT> <!-- detaily dalšího produktu --> </PRODUCT> <!-- další produkty --> </PRODUCTS>
Struktura jednotlivého produktu
Každý produkt obsahuje řadu tagů s informacemi o produktu. Zde je kompletní příklad struktury jednoho produktu:
<PRODUCT> <!-- Identifikátory --> <CODE>product-code</CODE> <EXTERNAL_ID>external-id-1</EXTERNAL_ID> <PRODUCT_ID>1234567890123</PRODUCT_ID> <EAN>1234567890123</EAN> <!-- Popis --> <NAME>Product 1</NAME> <DESCRIPTION>Product description</DESCRIPTION> <VARIANT>Variant</VARIANT> <SUPPLIER>Supplier</SUPPLIER> <MANUFACTURER>Manufacturer</MANUFACTURER> <CATEGORY>Category</CATEGORY> <!-- Odkazy --> <IMG_URL>http://www.example.com/image.jpg</IMG_URL> <URL>http://www.example.com/product.html</URL> <!-- Cena --> <PRICE>100</PRICE> <CURRENCY>EUR</CURRENCY> <VAT_PERCENT>20</VAT_PERCENT> <VAT_INCLUDED>0</VAT_INCLUDED> <!-- Sklad --> <STOCK_IS_AVAILABLE>1</STOCK_IS_AVAILABLE> <STOCK_QUANTITY>10</STOCK_QUANTITY> <STOCK_UNIT>ks</STOCK_UNIT> <!-- Nabízení dalších produktů --> <RELATED_PRODUCTS>related-product-code-1,related-product-code-2</RELATED_PRODUCTS> <ALTERNATIVE_PRODUCTS>alternative-product-code-1,alternative-product-code-2</ALTERNATIVE_PRODUCTS> </PRODUCT>
Popis polí produktového feedu
Název pole | Typ | Povinné | Popis |
---|---|---|---|
CODE | VARCHAR(255) | Ano | Kód produktu, který vidí zákazník |
EXTERNAL_ID | VARCHAR(255) | Ano | Externí systémové ID produktu |
PRODUCT_ID | VARCHAR(255) | Ano | ID produktu |
EAN | VARCHAR(255) | Ne | EAN kód produktu |
NAME | VARCHAR(255) | Ano | Název produktu |
DESCRIPTION | VARCHAR(255) | Ne | Popis produktu |
VARIANT | VARCHAR(255) | Ne | Varianta produktu |
SUPPLIER | VARCHAR(255) | Ne | Dodavatel produktu |
MANUFACTURER | VARCHAR(255) | Ne | Výrobce produktu |
CATEGORY | VARCHAR(255) | Ne | Kategorie produktu |
IMG_URL | VARCHAR(255) | Ne | URL adresa obrázku produktu |
URL | VARCHAR(255) | Ne | URL adresa produktu v e-shopu |
PRICE | DECIMAL | Ano | Cena produktu (s nebo bez DPH podle VAT_INCLUDED) |
CURRENCY | VARCHAR(3) | Ano | Měna ve formátu ISO 4217 (CZK, EUR...) |
VAT_PERCENT | DECIMAL | Ano | Sazba DPH v procentech (např. 21) |
VAT_INCLUDED | 1 nebo 0 | Ano | Je DPH v ceně? (1 = ano, 0 = ne) |
STOCK_IS_AVAILABLE | 1 nebo 0 | Ne | Je dostupný skladem? (1 = ano, 0 = ne) |
STOCK_QUANTITY | DECIMAL | Ne | Počet jednotek skladem |
STOCK_UNIT | VARCHAR(255) | Ne | Skladová jednotka (ks, kg, ...) |
RELATED_PRODUCTS | VARCHAR | Ne | Kódy souvisejících produktů oddělené čárkou |
ALTERNATIVE_PRODUCTS | VARCHAR | Ne | Kódy alternativních produktů oddělené čárkou |
Jak probíhá synchronizace produktového feedu
Proces synchronizace produktů z vašeho e-shopu do Retino je jednoduchý:
- Vytvořte XML feed podle výše uvedené struktury obsahující všechny vaše produkty
- Umístěte feed na veřejně dostupnou URL adresu
- Zašlete tuto adresu na support@retino.com
- Retino bude z této adresy stahovat data jednou denně
Bezpečnostní doporučení
Přenos dat probíhá přes HTTPS a doporučujeme jej zabezpečit jedním z těchto způsobů:
- HTTP Basic autentizace - nejbezpečnější řešení, které vyžaduje uživatelské jméno a heslo pro přístup k feedu
- "Neuhodnutelná" URL adresa - pokud HTTP Basic autentizace není možná, umístěte feed na adresu s náhodným identifikátorem, např.
www.vas-eshop.cz/feeds/9b9972387feb11eabc550242ac130003.xml
Technická poznámka: Váš server musí vrátit odpověď do 60 sekund od požadavku.
Správné formátování dat v XML
Při přípravě XML feedu je potřeba věnovat pozornost několika technickým aspektům:
Práce se speciálními znaky
XML formát nedovoluje mít v řetězcích uvnitř dokumentu určité znaky jako <, > nebo &. Pro řešení tohoto problému máte dvě možnosti:
- Nahradit speciální znaky jejich XML entitami:
- < nahradit za <
- > nahradit za >
- & nahradit za &
- Obalit obsah tagu do entity CDATA (doporučený přístup)
Chybný příklad (XML parser vyhodí chybu):
<NAME>Slim&Sun 100 tablet</NAME>
Správný příklad (ošetřeno pomocí CDATA):
<NAME><![CDATA[Slim&Sun 100 tablet]]></NAME>
Formát číselných hodnot
Při zadávání číselných hodnot v tagu PRICE
, VAT_PERCENT
nebo STOCK_QUANTITY
dodržujte následující pravidla:
- Používejte desetinnou tečku (.) pro oddělení desetinných míst
- Nepoužívejte oddělovač tisíců
- Nezadávejte měnu společně s hodnotou (měna patří do tagu
CURRENCY
)
Správné příklady:
<PRICE>1299.90</PRICE> <VAT_PERCENT>21</VAT_PERCENT> <STOCK_QUANTITY>42</STOCK_QUANTITY>
Kontrola validity feedu
Pro ověření správnosti formátu vašeho XML feedu můžete použít XSD schéma, které definuje všechny povolené prvky a jejich strukturu:
Stáhnout XSD schéma pro Retino Products XML feed
Toto schéma můžete použít v různých XML validátorech pro kontrolu, zda váš feed splňuje všechny požadavky.
Využití produktového feedu v Retino
Po úspěšné synchronizaci produktového feedu můžete v Retino využívat řadu funkcí:
Vytváření skladových reklamací
Při vytváření případu typu "Dodavatelská reklamace" můžete vyhledávat produkty z vašeho katalogu:
- Zadejte alespoň 3 znaky do vyhledávacího pole (název, kód, EAN, atd.)
- Systém vám zobrazí odpovídající produkty
- Kliknutím na tlačítko "+" přidáte produkt do reklamace
- Vyplňte potřebné údaje o reklamaci (důvod, navrhované řešení, atd.)
Vyhledávání produktů podle různých parametrů
Produktový feed umožňuje vyhledávat produkty podle různých kritérií:
- Podle kódu produktu (CODE)
- Podle EAN kódu
- Podle názvu produktu
- Podle dodavatele (SUPPLIER)
- Podle výrobce (MANUFACTURER)
Toto vyhledávání je dostupné všude, kde pracujete s produkty v rámci systému Retino.
Často kladené otázky
Jak často se aktualizuje produktový feed?
Standardně probíhá synchronizace jednou denně. Pokud potřebujete častější aktualizace, kontaktujte nás na support@retino.com.
Co když se změní struktura mého XML feedu?
Jakékoliv změny ve struktuře feedu je potřeba konzultovat s naším týmem podpory, aby nedošlo k narušení synchronizace.
Je možné použít jiný formát než XML?
V současné době podporujeme pouze XML formát podle definované struktury. Pro platformu Shoptet používáme přímou API integraci.
Mohu do jednoho feedu zahrnout produkty z více e-shopů?
Ne, pro každý e-shop by měl existovat samostatný feed.
Co dělat, když některá pole nemám k dispozici?
Vyplňte všechna povinná pole. Nepovinná pole můžete vynechat, pokud danou informaci nemáte k dispozici.
Technická podpora
Pokud potřebujete pomoc s vytvořením nebo implementací produktového feedu, neváhejte nás kontaktovat:
- E-mail: support@retino.com