Retino Products XML feed

Doplněk Dodavatelské reklamace na Marketplace rozšiřuje funkcionalitu Retina o vytváření reklamací z již existujících případů, ale také tvorbu skladových reklamací. Pro zjednodušení tvorby skladových reklamací Retino potřebuje znát produkty nabízené vaším e-shopem. K tomu slouží Retino Products XML feed.

Pokud používáte platformu Shoptet, poté se vás tento článek netýká a produkty se z vašeho e-shopu synchronizují automaticky přes API.

Struktura feedu

Feed začíná xml hlavičkou s verzí 1.0 a UTF-8 kódování. Podporujeme pouze UTF-8 kódování. Poté následuje párový tag PRODUCTS , ve kterém jsou všechny objednávky (každá v tagu PRODUCT ). Tagy jsou case-sensitive. White-space (mezery apod.) mezi tagy jsou ignorovány. Ceny (typ DECIMAL ) jsou psány s desetinnou tečkou (.), bez oddělovače tisíců. Příklad:

<?xml version="1.0" encoding="UTF-8"?>
<PRODUCTS>
    <PRODUCT>
        (... product structure - see below ...)
    </PRODUCT>
    <PRODUCT>
        (... product structure - see below ...)
    </PRODUCT>
    (... more products ...)
</PRODUCTS>

Struktura `PRODUCT`

Příklad:

<?xml version="1.0" encoding="utf-8" ?>
<PRODUCTS>
    <PRODUCT>
        <!-- Identifikatory -->
        <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>

        <!-- Nabizeni dalsich produktu -->
        <RELATED_PRODUCTS>1</RELATED_PRODUCTS>
        <ALTERNATIVE_PRODUCTS>2</ALTERNATIVE_PRODUCTS>
    </PRODUCT>
</PRODUCTS>

Popis polí:

Název	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
NAME	VARCHAR(255)	Ano	Název
DESCRIPTION	VARCHAR(255)	Ne	Popis
VARIANT	VARCHAR(255)	Ne	Varianta
SUPPLIER	VARCHAR(255)	Ne	Dodavatel
MANUFACTURER	VARCHAR(255)	Ne	Výrobce
CATEGORY	VARCHAR(255)	Ne	Kategorie
IMG_URL	VARCHAR(255)	Ne	Obrázek produktu
URL	VARCHAR(255)	Ne	Odkaz na veřejný detail produktu
PRICE	DECIMAL	Ano	Cena produktu (s, nebo bez DPH podle VAT_INCLUDED)
CURRENCY	VARCHAR(3)	Ano	Měna ve formátu ISO 4217
VAT_PERCENT	DECIMAL	Ano	Procent DPH.
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	Související produkty (připraveno pro budoucí použití), Kódy produktu oddělené čárkou
ALTERNATIVE_PRODUCTS	VARCHAR	Ne	Alternativní produkty (připraveno pro budoucí použití), Kódy produktu oddělené čárkou

Jak probíhá synchronizace?

Připravený feed se všemi produkty z vašeho e-shopu umístěte na veřejnou adresu, kterou nám zašlete na support@retino.com. My jej z této adresy budeme stahovat jednou denně.

Přenos dat probíhá přes HTTPS a lze jej zabezpečit přes HTTP Basic autentizaci. Doporučujeme toto zabezpečení s ohledem na bezpečnost dat. Pokud to ve vašem případě není možné, doporučujeme alespoň URL feedu nastavit na „neuhodnutelnou“ adresu, např. www.store.com/9b9972387feb11eabc550242ac130003.xml.

Váš server musí vrátit odpověď do 60 sekund.

Pozor na speciální znaky

Upozorňujeme, že XML formát nedovoluje mít v řetězcích uvnitř dokumentu určité znaky jako <, > nebo &. Nejjednodušší řešení je všechny tagy, ve kterých se speciální znaky mohou objevit, obalit do entity CDATA.

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>

Kontrola feedu

Pro kontrolu správnosti formátu dat ve XML feedu můžete použít soubor typu XSD. Stáhněte si soubor obsahující schéma feedu níže:

retino_products_xml.xsd