Structure of gateway.xml

Structure and its description

The gateway.xml file is the main file of the IOF format structure that is a collection of detailed provider information and URLs to the primary, differential, and reference offer files.

Provider details, i.e. sub-nodes

• <long_name> - long supplier name,
• <short_name> - short supplier name (cannot contain white space, lower underscore character and symbols "0-9", "a-z", "A-Z" are allowed),
• <showcase_image> - URL to the supplier's logo,
• <email> - supplier's email address,
• <tel> - supplier's phone number,
• <fax> - supplier's fax,
• <www> - supplier's website URL,
• <street> - the street address of the supplier,
• <zipcode> - zip code of the supplier address,
• <city> - city of the supplier address,
• <country> - the country of the supplier address,
• <province> - the province of the supplier address.

are placed in the required <meta> node, where it is also returned:

• information about the date the offer was generated, that is, under the <meta><time><offer> node with the @created attribute,
• information about the expiration date of the offer, that is, under the <meta><time><offer> node with the @expires attribute.

Further nodes point to URLs to the individual format files:

Required nodes

• <full> - URL address to the first basic offer file full.xml - containing basic information about products, e.g. descriptions, photos, attributes, attachments or groups of products or components of sets and collections, etc.,
• <light> - URL to the second base offer file light.xml - containing information, including those about sizes, their location in the warehouse and available stock quantites, producer's codes, weights and prices, including discounts and currency of the individual recipient,
• <categories> - URL to the reference offer file categories.xml - a set of all categories of supplier's products,
• <sizes> - URL to the reference offer file sizes.xml - a set of all supplier's products sizes,
• <producers> -URL to the reference offer files producers.xml - a set of all producers of products from the supplier.

Optional nodes

• <change> - URLs for optional offer files full_changeYYYY-MM-DDThh-mm-ss.xml - constituting differential files for the basic offer file full.xml and containing information about major nodes of products that have recently changed,
• <series> - URL to the reference offer file series.xml - constituting a set of all series of supplier's products,
• <warranties> - URL to the reference offer file warranties.xml - constituting a set of all the supplier's products warranties,
• <parameters> - URL to the reference offer file parameters.xml - constituting a set of all parameters of the supplier's products,
• <units> - URL to the reference offer file units.xml - a set of all units of measure for the supplier's products,
• <stocks> - URL to the reference offer file stocks.xml - constituting a collection of all supplier's warehouses,
• <preset> - URL address to the last optional offer file preset.xml - storing information about the offer configuration for the purpose of the program for its synchronization (e.g. Downloader).

Structure slice with incorrectly notation of optional nodes

<?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="Test Category 1/Subcategory 3"/>
            <category_idosell id="55" path="Cameras, cameras and optical instruments > Accessories for cameras, cameras and optical instruments > Backup cables for cameras, cameras and optical instruments"/>
            <unit/>
            <series/>
        </product>
    </products>
</offer>

Structure slice with correct notation of optional nodes

<?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="Test Category 1/Subcategory 3"/>
            <category_idosell id="55" path="Cameras, cameras and optical instruments > Accessories for cameras, cameras and optical instruments > Backup cables for cameras, cameras and optical instruments"/>
            <unit id="3" name="packaging"/>
            <series id="5" name="Spring Collection"/>
        </product>
    </products>
</offer>

Changelog:

IOF 3.0

• we have added the optional @generated_by attribute in the node <provider_description>, which allows you to return information about the platform from which the offer was generated,
• we added in the node <provider_description><meta><adress> an additional node <province>, which allows you to provide information about the province, district, region, voivodeship or status of the supplier's address,
• in nodes <provider_description><meta><time><offer> we changed the attribute names @date_created and @date_expires to @created and @expires,
• we have added to all offer files nodes except for the node <light> the required attribute @hash returning the md5 key of the given file and the optional attribute @changed returning the date and time of last modification of a given file,
• in the node <full> we have added an optional node<changes> containing any number of nodes <change> returning URLs to differential files containing information about products and their nodes that have changed in the last 30 minutes.

Sample XML file structure:

<?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>