Structure of gateway.xml file

Technical Specification
Language used in this document: English (en-US)

It is the main file of the IOF for Shops format. This file contains data of supplier who share his offer to a business customer, and URL addresses to files of the IOF for Shops format, e.g. full.xml and light.xml.

<meta> section is required and specifies provider details and time period within which the offer is valid. The <long_name> and <short_name> tags can contain white-spaces and using only symbols such as '0-9', 'a-z', 'A-Z', '_', '-'.

The @url attribute is always required, it is somewhat differently with the @hash attribute, which is required in all nodes of format files outside the light.xml file node, which due to dynamic generation does not have the md5 key returned in the gateway.xml file. The @changed attribute is optional.

Rest of required tags

  • <full> – URL to full.xml file containing the most important information about products, i.e. name, price provided by supplier, short description, long description, URL address to product tab, relations between categories, producers, picture information, file attachments etc.,
  • <light> – URL to light.xml file containing information, which are also included in full.xml file, i.e. unique code, prices, weig and stock quantities for particular size,
  • <categories> – URL to categories.xml file containing category tree,
  • <sizes> – URL to sizes.xml file containing groups of sizes,
  • <producers> – URL to producers.xml file containing information about producers.

Optional tags

  • <change> - URL to the file full_change.xml (where YYYY-MM-DDThh-mm-ss should indicate the date and time of the last change in the ISO 8601 standard) containing information about products that have changed in the last 30 minutes. The number of occurrences of <change> nodes is unlimited. All <change> nodes as well as their parent node <changes> are optional elements of the required node <full>.
  • <units> – URL to list of units of measure (units.xml),
  • <parameters> – URL to list of parameters (parameters.xml),
  • <series> – URL to list of product series (series.xml),
  • <warranties> – URL list of warranties (warranties.xml),
  • <stocks> - URL do list of stocks (stocks.xml),
  • <preset> - URL to configuration of settings for application handling offers (preset.xml).
Notice for optional tags

In case any unit of measure, series, warranty or dictionary are not specified for particular product in full.xml, providing its empty tags (e.g. <series /> or <units /> tag) will remove information about a given node from the product.

<?xml version="1.0" encoding="UTF-8"?>
<offer file_format="IOF" version="3.0" generated="2018-04-12 12:35:52" extensions="yes" xmlns="http://www.iai-shop.com/developers/iof.phtml">
    <products xmlns:iaiext="http://www.iai-shop.com/developers/iof/extensions.phtml" language="eng" currency="GBP">
       <product id="1" vat="23.0" producer_code_standard="GTIN14" code_on_card="REE-4315124/AA">
          <producer id="23" name="Bosh"/>
          <category id="10" name="Drill"/>
          <unit/> 
          <series/>
          ...
       </product>
    </products>
</offer>

If you do not want to provide information about a given tag (e.g. <series /> or <units /> tag), do not specify its tag in the full.xml file at all.

<?xml version="1.0" encoding="UTF-8"?>
<offer file_format="IOF" version="3.0" generated="2018-04-12 12:35:52" extensions="yes" xmlns="http://www.iai-shop.com/developers/iof.phtml">
    <products xmlns:iaiext="http://www.iai-shop.com/developers/iof/extensions.phtml" language="eng" currency="GBP">
       <product id="1" vat="23.0" producer_code_standard="GTIN14" code_on_card="REE-4315124/AA">
          <producer id="23" name="Bosh"/>
          <category id="10" name="Drill"/>
          ...
       </product>
    </products>
</offer>

XML Example plik gateway (XML) file

<provider_description file_format="IOF" version="3.0" generated="2018-04-12 12:00:00" generated_by="IdoSell Shop">
    <meta>
        <long_name><![CDATA[My IdoSell Shop]]></long_name>
        <short_name><![CDATA[IdoSell Shop]]></short_name>
        <showcase_image url="http://iai-shop.com/gfx/iai_logo.png"/>
        <email><![CDATA[office@iai-sa.com]]></email>
        <tel><![CDATA[+442071931010]]></tel>
        <fax><![CDATA[+48914436601]]></fax>
        <www><![CDATA[hhtps://www.idosell.com]]></www>
        <address>
            <street><![CDATA[Aleja Piastów 30]]></street>
            <zipcode><![CDATA[71-064]]></zipcode>
            <city><![CDATA[Szczecin]]></city>
            <country><![CDATA[Polska]]></country>
            <province><![CDATA[Zachodniopomorskie]]></province>
        </address>
        <time>
            <offer created="2018-04-12 12:00:00"/>
            <offer expires="2018-04-19 12:00:00"/>
        </time>
    </meta>
    <full url="http://example.iai-shop.com/edi/export-offer.php?client=test&amp;language=eng&amp;token=44b59f94b5a18473a5f7a57&amp;shop=1&amp;type=full&amp;format=xml&amp;iof_3_0" hash="b8396d5dcc80a83580088e342515dc0f" changed="2018-04-12 12:00:00">
        <changes>
            <change url="http://example.iai-shop.com/edi/export-offer.php?client=test&amp;language=eng&amp;token=44b59f94b5a18473a5f7a57&amp;shop=1&amp;type=full_change2018-04-23T10-00-00&amp;format=xml&amp;iof_3_0" hash="76f66fabc375c374a2094c60792f0462" changed="2018-04-12 10:00:00" />
            <change url="http://example.iai-shop.com/edi/export-offer.php?client=test&amp;language=eng&amp;token=44b59f94b5a18473a5f7a57&amp;shop=1&amp;type=full_change2018-04-23T10-30-00&amp;format=xml&amp;iof_3_0" hash="76f66fabc375c374a2094c60792f0462" changed="2018-04-12 10:30:00" />
            <change url="http://example.iai-shop.com/edi/export-offer.php?client=test&amp;language=eng&amp;token=44b59f94b5a18473a5f7a57&amp;shop=1&amp;type=full_change2018-04-23T11-00-00&amp;format=xml&amp;iof_3_0" hash="76f66fabc375c374a2094c60792f0462" changed="2018-04-12 11:00:00" />
            <change url="http://example.iai-shop.com/edi/export-offer.php?client=test&amp;language=eng&amp;token=44b59f94b5a18473a5f7a57&amp;shop=1&amp;type=full_change2018-04-23T11-30-00&amp;format=xml&amp;iof_3_0" hash="76f66fabc375c374a2094c60792f0462" changed="2018-04-12 11:30:00" />
            <change url="http://example.iai-shop.com/edi/export-offer.php?client=test&amp;language=eng&amp;token=44b59f94b5a18473a5f7a57&amp;shop=1&amp;type=full_change2018-04-23T12-00-00&amp;format=xml&amp;iof_3_0" hash="76f66fabc375c374a2094c60792f0462" changed="2018-04-12 12:00:00" />
        </changes>
    </full>    
    <light url="http://example.iai-shop.com/edi/export-offer.php?client=example&amp;language=eng&amp;token=c28ed37e15f9ce0cefed793&amp;shop=1&amp;type=light&amp;format=xml&amp;iof_3_0"/>
    <categories url="http://example.iai-shop.com/edi/export-offer.php?client=example&amp;language=eng&amp;token=e70352d9aebb98139980f64&amp;shop=1&amp;type=categories&amp;format=xml&amp;iof_3_0" hash="0b90eec715995728ef7508a0f17525d9" changed="2018-04-12 10:00:00"/>
    <sizes url="http://example.iai-shop.com/edi/export-offer.php?client=example&amp;language=eng&amp;token=66d7e210df197f54bdf9e4d&amp;shop=1&amp;type=sizes&amp;format=xml&amp;iof_3_0" hash="cf13fdf0ea0697d5dfb94d390d5ca887" changed="2018-04-12 10:00:00"/>
    <producers url="http://example.iai-shop.com/edi/export-offer.php?client=example&amp;language=eng&amp;token=c92abb6a1ceab3195cb5c39&amp;shop=1&amp;type=producers&amp;format=xml&amp;iof_3_0" hash="2f63bbd18e8cec6e504629893946d93e" changed="2018-04-12 10:00:00"/>
    <units url="http://example.iai-shop.com/edi/export-offer.php?client=example&amp;language=eng&amp;token=995759017618853c77383e2&amp;shop=1&amp;type=units&amp;format=xml&amp;iof_3_0" hash="1ce286d71bb9940820bff62e48ce498b" changed="2018-04-12 10:00:00"/>
    <parameters url="http://example.iai-shop.com/edi/export-offer.php?client=example&amp;language=eng&amp;token=6d052042188a0c47ba2ea15&amp;shop=1&amp;type=parameters&amp;format=xml&amp;iof_3_0" hash="46808b604e8c6ac59c0e10f3b30bb863" changed="2018-04-12 10:00:00"/>
    <stocks url="http://example.iai-shop.com/edi/export-offer.php?client=example&amp;language=eng&amp;token=d03ed218361de24b1714f11&amp;shop=1&amp;type=stocks&amp;format=xml&amp;iof_3_0" hash="166220b84e7eeb4ec6bd18a86b2492d1" changed="2018-04-12 10:00:00"/>
    <series url="http://example.iai-shop.com/edi/export-offer.php?client=example&amp;language=eng&amp;token=874294aee5c450d2bbef4c2&amp;shop=1&amp;type=series&amp;format=xml&amp;iof_3_0" hash="50dd0d074dc1f063db9fb28462768e66" changed="2018-04-12 10:00:00"/>
    <warranties url="http://example.iai-shop.com/edi/export-offer.php?client=example&amp;language=eng&amp;token=56b4b60f4f22bc15846c6e6&amp;shop=1&amp;type=warranties&amp;format=xml&amp;iof_3_0" hash="adffba8f9c015d61d17f8c2b33dbaeca" changed="2018-04-12 10:00:00"/>
    <preset url="http://example.iai-shop.com/edi/export-offer.php?client=example&amp;language=eng&amp;token=56b4b60f4f22bc15846c6e6&amp;shop=1&amp;type=preset&amp;format=xml&amp;iof_3_0" hash="75e76977a7890ac172c024c6675e11c7" changed="2018-04-12 10:00:00"/>
</provider_description>

XML Schema Validator: plik gateway (XSD) file