Struktura i jej opis

Plik gateway.xml jest głównym plikiem struktury formatu IOF stanowiącym zbiór szczegółowych informacji o dostawcy oraz adresów URL do podstawowych, różnicowych oraz referencyjnych plików oferty.

Szczegółowe dane dostawcy, czyli pod węzły

• <long_name> - długa nazwa dostawcy,
• <short_name> - skrócona nazwa dostawcy (nie może zawierać biały spacji, dopuszcza znak dolnego podkreślenia oraz symbole "0-9", "a-z", "A-Z"),
• <showcase_image> - adres URL do logotypu dostawcy,
• <email> - adres poczty elektronicznej dostawcy,
• <tel> - numer telefonu dostawcy,
• <fax> - faks dostawcy,
• <www> - adres URL strony dostawcy,
• <street> - ulica adresu dostawcy,
• <zipcode> - kod pocztowy adresu dostawcy,
• <city> - miasto adresu dostawcy,
• <country> - kraj adresu dostawcy,
• <province>- województwo adresu dostawcy.

umieszczone są w wymaganym węźle <meta>, w którym zwracana jest również:

• informacja o dacie wygenerowania oferty, czyli pod węzeł <meta><time><offer> z atrybutem @created,
• informację o dacie wygaśnięcia oferty, czyli pod węzeł <meta><time><offer> z atrybutem @expires.

Dalsze węzły wskazują na adresy URL do poszczególnych plików formatu:

Węzły wymagane

• <full> – adres URL do pierwszego podstawowego pliku oferty full.xml - zawierającego podstawowe informacje o towarach np. opisy, zdjęcia, atrybuty, załączniki czy grupy towarów bądź składowe zestawów i kolekcji itp.,
• <light> – adres URL do drugiego podstawowego pliku oferty light.xml - zawierającego informacje m.in. o rozmiarach, ich lokalizacji na magazynie i stanach dyspozycyjnych, kodach producenta, wagach oraz cenach uwzględniających rabaty i walutę indywidualnego odbiorcy,
• <categories> – adres URL do referencyjnego pliku oferty categories.xml - stanowiącego zbiór wszystkich kategorii towarów dostawcy,
• <sizes> – adres URL do referencyjnego pliku oferty sizes.xml - stanowiącego zbiór wszystkich rozmiarów towarów dostawcy,
• <producers> – adres URL do referencyjnego pliki oferty producers.xml - stanowiącego zbiór wszystkich producentów towarów dostawcy.

Węzły opcjonalne

• <change> - adresy URL do opcjonalnych plików oferty full_changeYYYY-MM-DDThh-mm-ss.xml - stanowiących pliki różnicowe dla podstawowego pliku oferty full.xml i zawierających informacje o głównych węzłach towarów, które uległy ostatnio zmianie,
• <series> – adres URL do referencyjnego pliku oferty series.xml - stanowiącego zbiór wszystkich serii towarów dostawcy,
• <warranties> – adres URL do referencyjnego pliku oferty warranties.xml - stanowiącego zbiór wszystkich gwarancji towarów dostawcy.,
• <parameters> – adres URL do referencyjnego pliku oferty parameters.xml - stanowiącego zbiór wszystkich parametrów towarów dostawcy,
• <units> – adres URL do referencyjnego pliku oferty units.xml - stanowiącego zbiór wszystkich jednostek miary towarów dostawcy,
• <stocks> - adres URL do referencyjnego pliku oferty stocks.xml - stanowiącego zbiór wszystkich magazynów towarów dostawcy,
• <preset> - adres URL do ostatniego opcjonalnego pliku oferty preset.xml - przechowującego informacje na temat konfiguracji oferty na potrzeby programu służącego do jej synchronizacji (np. Downloader).

Uwaga dotycząca znaczników opcjonalnych

W przypadku braku jednostki miary, serii, gwarancji czy parametrów dla danego towaru w pliku full.xml, puste tagi dodatkowe np. <unit/>, czy <series/> nie będą akceptowane, w takim przypadku nie należy takich tagów określać w pliku w ogóle.

Wycinek struktury z niepoprawnym zapisem węzłów opcjonalnych

<?xml version="1.0" encoding="utf-8"?>
<offer
    xmlns:iof="http://www.iai-shop.com/developers/iof.phtml"
    xmlns:iaiext="http://www.iai-shop.com/developers/iof/extensions.phtml" file_format="IOF" generated="2022-02-14 00:24:18" expires="2022-02-15 00:24:18" version="3.0" extensions="yes">
    <products
        xmlns:iaiext="http://www.iai-shop.com/developers/iof/extensions.phtml" currency="PLN" iof_translation_generated="yes" language="pol">
        <product id="33" currency="PLN" code_on_card="34567-11000" producer_code_standard="GTIN13" type="regular" vat="23.0" site="1">
            <producer id="1642669997" name="Lewis"/>
            <category id="1214553882" name="Kategoria testowa 1/Podkategoria 3"/>
            <category_idosell id="55" path="Aparaty, kamery i przyrządy optyczne > Akcesoria do aparatów, kamer i przyrządów optycznych > Zapasowe kable do aparatów, kamer i przyrządów optycznych"/>
            <unit/>
            <series/>
        </product>
    </products>
</offer>

Wycinek struktury z poprawnym zapisem węzłów opcjonalnych

<?xml version="1.0" encoding="utf-8"?>
<offer
    xmlns:iof="http://www.iai-shop.com/developers/iof.phtml"
    xmlns:iaiext="http://www.iai-shop.com/developers/iof/extensions.phtml" file_format="IOF" generated="2022-02-14 00:24:18" expires="2022-02-15 00:24:18" version="3.0" extensions="yes">
    <products
        xmlns:iaiext="http://www.iai-shop.com/developers/iof/extensions.phtml" currency="PLN" iof_translation_generated="yes" language="pol">
        <product id="33" currency="PLN" code_on_card="34567-11000" producer_code_standard="GTIN13" type="regular" vat="23.0" site="1">
            <producer id="1642669997" name="Lewis"/>
            <category id="1214553882" name="Kategoria testowa 1/Podkategoria 3"/>
            <category_idosell id="55" path="Aparaty, kamery i przyrządy optyczne > Akcesoria do aparatów, kamer i przyrządów optycznych > Zapasowe kable do aparatów, kamer i przyrządów optycznych"/>
            <unit id="3" name="opakowanie"/>
            <series id="5" name="Kolekcja wiosenna"/>
        </product>
    </products>
</offer>

Changelog:

IOF 3.0

• dodaliśmy opcjonalny atrybut @generated_by w węźle <provider_description>, który umożliwia zwrócenie informacji o platformie, z której została wygenerowana oferta,
• dodaliśmy w węźle <provider_description><meta><adress> dodatkowy węzeł <province>, który pozwala na przekazanie informacji o prowincji, dzielnicy, regionie, województwie lub stanie adresu dostawcy,
• w węzłach <provider_description><meta><time><offer> zmieniliśmy nazwy atrybutów @date_created i @date_expires na @created i @expires,
• dodaliśmy dla do węzłów wszystkich plików oferty za wyjątkiem węzła <light> wymagany atrybut @hash zwracający klucz md5 danego pliku oraz opcjonalny atrybut @changed zwracający datę i godzinę ostatniej modyfikacji danego pliku,
• w węźle <full> dodaliśmy opcjonalny węzeł <changes> zawierający dowolną ilość węzłów <change> zwracających adresy URL do plików różnicowych zawierających informacje o towarach i ich węzłach, które zmieniły się w ciągu ostatnich 30 minut.

Przykładowa struktura pliku XML:

<?xml version="1.0" encoding="UTF-8"?>
<provider_description file_format="IOF" version="3.0" generated_by="IdoSell" generated="2022-02-15 15:46:37">
    <meta>
        <long_name><![CDATA[Moj sklep IdoSell]]></long_name>
        <short_name><![CDATA[iof]]></short_name>
        <showcase_image url="http://iof.shop.pl/data/system/panel_logo.png"/>
        <email><![CDATA[no-reply@idosell.com]]></email>
        <tel><![CDATA[+48 91 443 66 00]]></tel>
        <tel><![CDATA[+48 91 443 66 00]]></tel>
        <www><![CDATA[iof.shop.pl]]></www>
        <address>
            <street><![CDATA[Aleja Piastów 30]]></street>
            <zipcode><![CDATA[71-064]]></zipcode>
            <city><![CDATA[Szczecin]]></city>
            <country><![CDATA[Polska]]></country>
            <province><![CDATA[]]></province>
        </address>
        <time>
            <offer created="2022-02-15 15:46:37"/>
            <offer expires="2022-02-22 15:46:37"/>
        </time>
    </meta>
    <full url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=e19156ecfdeaf09da54cd9f&shop=1&type=full&format=xml&iof_3_0" hash="98b7e54f96335e632524ab267c11b8c3" changed="2022-02-14 23:08:30">
        <changes>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-15T15-23-16&format=xml&iof_3_0" hash="982a963722ff18c7e1580de635841caa" changed="2022-02-15 15:23:16"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-15T14-19-03&format=xml&iof_3_0" hash="982a963722ff18c7e1580de635841caa" changed="2022-02-15 14:19:04"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-15T13-18-53&format=xml&iof_3_0" hash="982a963722ff18c7e1580de635841caa" changed="2022-02-15 13:18:53"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-15T12-16-27&format=xml&iof_3_0" hash="982a963722ff18c7e1580de635841caa" changed="2022-02-15 12:16:27"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-15T11-14-54&format=xml&iof_3_0" hash="982a963722ff18c7e1580de635841caa" changed="2022-02-15 11:14:55"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-15T10-20-47&format=xml&iof_3_0" hash="982a963722ff18c7e1580de635841caa" changed="2022-02-15 10:20:48"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-15T09-19-48&format=xml&iof_3_0" hash="982a963722ff18c7e1580de635841caa" changed="2022-02-15 09:19:49"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-15T08-22-26&format=xml&iof_3_0" hash="982a963722ff18c7e1580de635841caa" changed="2022-02-15 08:22:26"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-15T07-06-47&format=xml&iof_3_0" hash="982a963722ff18c7e1580de635841caa" changed="2022-02-15 07:06:48"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-15T06-14-45&format=xml&iof_3_0" hash="982a963722ff18c7e1580de635841caa" changed="2022-02-15 06:14:46"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-15T05-12-39&format=xml&iof_3_0" hash="982a963722ff18c7e1580de635841caa" changed="2022-02-15 05:12:40"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-15T04-16-24&format=xml&iof_3_0" hash="982a963722ff18c7e1580de635841caa" changed="2022-02-15 04:16:24"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-15T03-20-05&format=xml&iof_3_0" hash="982a963722ff18c7e1580de635841caa" changed="2022-02-15 03:20:05"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-15T02-23-50&format=xml&iof_3_0" hash="982a963722ff18c7e1580de635841caa" changed="2022-02-15 02:23:51"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-15T01-17-25&format=xml&iof_3_0" hash="982a963722ff18c7e1580de635841caa" changed="2022-02-15 01:17:25"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-15T00-26-36&format=xml&iof_3_0" hash="982a963722ff18c7e1580de635841caa" changed="2022-02-15 00:26:36"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-14T22-20-27&format=xml&iof_3_0" hash="7ce2707299161bec392ad00f6ec14661" changed="2022-02-14 22:20:28"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-14T21-22-14&format=xml&iof_3_0" hash="7ce2707299161bec392ad00f6ec14661" changed="2022-02-14 21:22:15"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-14T20-09-38&format=xml&iof_3_0" hash="7ce2707299161bec392ad00f6ec14661" changed="2022-02-14 20:09:39"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-14T19-09-58&format=xml&iof_3_0" hash="7ce2707299161bec392ad00f6ec14661" changed="2022-02-14 19:09:58"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-14T18-09-21&format=xml&iof_3_0" hash="7ce2707299161bec392ad00f6ec14661" changed="2022-02-14 18:09:21"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-14T17-21-06&format=xml&iof_3_0" hash="7ce2707299161bec392ad00f6ec14661" changed="2022-02-14 17:21:07"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-14T16-12-19&format=xml&iof_3_0" hash="7ce2707299161bec392ad00f6ec14661" changed="2022-02-14 16:12:20"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-14T15-16-54&format=xml&iof_3_0" hash="7ce2707299161bec392ad00f6ec14661" changed="2022-02-14 15:16:54"/>
            <change url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=8ea59f574526debab4d1c54&shop=1&type=full_change2022-02-14T14-06-48&format=xml&iof_3_0" hash="7ce2707299161bec392ad00f6ec14661" changed="2022-02-14 14:06:49"/>
        </changes>
    </full>
    <light url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=9db5a606746e292d3230c66&shop=1&type=light&format=xml&iof_3_0"/>
    <categories url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=a67204c7d297437b18d15a0&shop=1&type=categories&format=xml&iof_3_0" hash="9043b72e02c57f13306f5b85d93ad534" changed="2022-02-15 05:12:27"/>
    <sizes url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=eb03fe0d7e57a060d4ad744&shop=1&type=sizes&format=xml&iof_3_0" hash="a0d3802a66185e7dde26acb86aa1fa25" changed="2022-02-15 05:12:27"/>
    <producers url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=0be8bd7a34cee18fbca5e4b&shop=1&type=producers&format=xml&iof_3_0" hash="aa12f69dde2a0babd42e79e28d2c40b0" changed="2022-02-15 05:12:27"/>
    <units url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=480f05b0ae61536842475dd&shop=1&type=units&format=xml&iof_3_0" hash="008572912c0afc620832459d3ec9b0e3" changed="2022-02-15 05:12:27"/>
    <parameters url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=ea949767daf9658ddbab874&shop=1&type=parameters&format=xml&iof_3_0" hash="79b433144d3a6e6469479bfc9fe08ea7" changed="2022-02-15 05:12:27"/>
    <stocks url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=3045d0e1977c06fc068bd62&shop=1&type=stocks&format=xml&iof_3_0" hash="06366fbd57b697c827111eac943e9944" changed="2022-02-15 05:12:27"/>
    <series url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=db571db18e2422d0cac0907&shop=1&type=series&format=xml&iof_3_0" hash="5aa001c1ef2e296c912ff921bd0db0c8" changed="2022-02-15 05:12:27"/>
    <warranties url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=f7c71d39b58a37e7215b76f&shop=1&type=warranties&format=xml&iof_3_0" hash="a8dc24d3f7f9eb36d04f1e06e92b32d3" changed="2022-02-15 05:12:27"/>
    <preset url="https://iof.shop.pl/edi/export-offer.php?client=iof&language=pol&token=29a8853cc185963a3dfad7585a75d4a8&shop=1&type=preset&format=xml&iof_3_0" hash="29a8853cc185963a3dfad7585a75d4a8" changed="2022-02-15 05:12:27"/>
</provider_description>

Pliki do pobrania

• Download example XML file gateway
• Download the XSD schema validator gateway