Struktura i jej opis

Plik preset.xml opracowany został na potrzeby aplikacji obsługujących synchronizację ofert IOF. Zawiera wiele ustawień dostawcy, które mogą być odczytywane przez aplikację przy synchronizacji danej ofert.

Ta opcja jest szczególnie pomocna, gdy konfiguracja importu odgrywa bardzo ważną rolę, a podmiot - który chce korzystać z oferty IOF - chce uzyskać gotową do użycia ofertę od dostawcy bez konieczności jej dodatkowej konfiguracji.

Węzły potrzebne do poprawnej konfiguracji oferty i ich opisy:

• long_name, short_name, showcase_image, description, email, tel, fax, www, address_street, address_zipcode, address_city, address_country, currency, offerCreated, offerExpires – wskazują na dane dostawcy, które będą wyświetlane w aplikacji na zakładce URL do pliku,
• url, full, light, categories, sizes, producers, units, parameters, series, traits, warranties, stocks – wskazują adresy URL do poszczególnych plików oferty,
• categories_auto_mapping, sizes_auto_mapping, series_auto_mapping, units_auto_mapping, warranties_auto_mapping – przyjmują wartości True lub False, które decydują o włączeniu bądź wyłączeniu automatycznego odwzorowywania / przypisywania elementów
• categories_auto_select, producers_auto_select, parameters_auto_select – przyjmują wartości True lub False, które decydują o włączeniu bądź wyłączeniu automatycznej synchronizacji elementów
• selected – może zawierać wartości True lub False odpowiedzialne za wybór / anulowanie oferty dostawcy, która ma być synchronizowana,
• remote_gateway – może zawierać wartości True lub False informujące o tym czy plik gateway.xml jest obecny / nie jest obecny na lokalnym dysku,
• fully_configured – może zawierać wartości True lub False odpowiedzialne za pełną konfigurację oferty i jej gotowość do synchronizacji,
• external_program – może zawierać wartości True lub False odpowiedzialne za źródło oferty (wtyczka aplikacji),
• external_program_xml_path – adres URL pliku gateway.xml wygenerowanego przez wtyczkę aplikacji,
• size_code_prefix – prefiks dodawany do kodów zewnętrznego systemu,
• iai_shop_deliverer_id – identyfikator dostawcy, do którego należy przypisać produkty z oferty,
• plugin_id – identyfikator wtyczki,
• size_code_auto – może zawierać wartości True lub False odpowiedzialne za włączanie / wyłączanie opcji automatycznego budowania zewnętrznych kodów systemowych z prefiksu i węzła XML: product/@id i product/sizes/size@id z pliku light.xml
• size_code_code_size - może zawierać wartości True lub False odpowiedzialne za włączanie / wyłączanie opcji automatycznego budowania zewnętrznych kodów systemowych z prefiksu i węzła XML: product/sizes/size/@code z pliku light.xml,
• update_name, update_short_description, update_long_description, ... - może zawierać wartości 1 lub 0 odpowiedzialne za włączanie / wyłączanie aktualizacji wybranego atrybutu podczas procesu synchronizacji,
• debug_product_import - może zawierać wartości True lub False odpowiedzialne za włączanie / wyłączanie opcji potwierdzania każdego importu nowego produktu (tryb debugowania),
• debug_product_update - może zawierać wartości True lub False odpowiedzialne za włączanie / wyłączanie opcji potwierdzania każdej aktualizacji produktu w systemie (tryb debugowania),
• debug_product_always_import - może zawierać wartości True lub False odpowiedzialne za włączanie / wyłączanie opcji automatycznego importowania każdego nowego produktu do systemie, bez potwierdzania (tryb debugowania),
• debug_product_always_update - może zawierać wartości True lub False odpowiedzialne za włączanie / wyłączanie opcji automatycznego aktualizowania każdego produktu w systemie, bez potwierdzania (tryb debugowania),
• products_allowed_operations – zawiera prawa aplikacji do dokonywania zmian w systemie:
  • all – aplikacja może edytować zsynchronizowane produkty i usuwać ich stany magazynowe w systemie,
  • edit – aplikacja może edytować zsynchronizowane produkty - wprowadzać zmiany w systemie,
  • reset – aplikacja może usuwać w systemie stany magazynowe synchronizowanych produktów.
• version_mode – zawiera ustawienia dotyczące zachowania aplikacji w przypadku towarów zgrupowanych:
  • 1 – importuj grupy towarów zgodnie ze źródłem informacji o towarach (ustawienie domyślne),
  • 0 – nie importuj towarów zgrupowanych,
  • 2 – importuj wszystkie towary z grup jako oddzielne towary,
• gatewayGeneratedOn – data i godzina wygenerowania pliku gateway.xml,
• full_lastModified, light_lastModified, categories_lastModified, ... - data i godzina ostatniej modyfikacji wybranego pliku,
• providerImageLastModified – data i godzina ostatniej modyfikacji ikony dostawcy (<showcase_image>) ,
• imageHash – klucz md5 hash ikony dostawcy (<showcase_image>),
• full_xml_generated, light_xml_generated, categories_xml_generated, ... - data i godzina wygenerowania wybranego pliku,
• overwrite_products – może zawierać wartości True lub False odpowiedzialne za określenie czy wszystkie obrazki i opisy powinny zostać nadpisane podczas następnego procesu synchronizacji,
• SRP_price - może zawierać wartość 0 lub 1 odpowiedzialne za włączanie / wyłączanie opcji pobierania informacji o Sugerowanej cenie detalicznej (SRP) z oferty dostawcy,
• STP_price - może zawierać wartość 0 lub 1 odpowiedzialne za włączanie / wyłączanie opcji pobierania informacji o Przekreślonej cenie detalicznej (STP) z oferty dostawcy,
• offer_from_bridge - może zawierać wartość 0 lub 1 określające, czy oferta jest generowana przez program IAI Bridge.
• culture_info – zawiera informacje o zastosowanym formacie liczb i dat.

Changelog:

IOF 3.0

Przykładowa struktura pliku XML:

<?xml version="1.0" encoding="utf-8"?>
<preset file_format="IOF" version="3.0" generated_by="IdoSell" language="pol" generated="2018-04-12 12:00:00" expires="2018-04-13 12:00:00">
    <long_name>example</long_name>
    <short_name>example offer</short_name>
    <showcase_image_url>http://link_to_company_logo.jpg</showcase_image_url>
    <description>example description</description>
    <email>support@superstore.com</email>
    <tel>+48 91 000 000</tel>
    <fax>+48 91 000 001</fax>
    <www>www.iai-shop.com</www>
    <address_street>Piastów 30</address_street>
    <address_zipcode>71-064</address_zipcode>
    <address_city>Szczecin</address_city>
    <address_country>Poland</address_country>
    <currency>PLN</currency>
    <url>path_or_link_to_gateway.xml_file</url>
    <full>path_or_link_to_full.xml_file</full>
    <light>path_or_link_to_light.xml_file</light>
    <categories>path_or_link_to_categories.xml_file</categories>
    <sizes>path_or_link_to_sizes.xml_file</sizes>
    <categories_auto_mapping>true</categories_auto_mapping>
    <selected>false</selected>
    <remote_gateway/>
    <fully_configured>true</fully_configured>
    <external_program>true</external_program>
    <external_program_xml_path>path_to_external_offer_file</external_program_xml_path>
    <producers>path_to_producers.xml_file</producers>
    <units>path_or_link_to_units.xml_file</units>
    <parameters>path_or_link_to_parameters.xml_file</parameters>
    <stocks>path_or_link_to_stocks.xml_file</stocks>
    <series>path_or_link_to_series.xml_file</series>
    <sizes_auto_mapping>true</sizes_auto_mapping>
    <units_auto_mapping>true</units_auto_mapping>
    <size_code_prefix>example-</size_code_prefix>
    <old_size_code_prefix>previous-</old_size_code_prefix>
    <size_code_auto>true</size_code_auto>
    <size_code_code_size>false</size_code_code_size>
    <update_name>1</update_name>
    <update_short_description>1</update_short_description>
    <update_long_description>1</update_long_description>
    <update_version_name>1</update_version_name>
    <update_series>1</update_series>
    <update_producer>1</update_producer>
    <update_category>1</update_category>
    <update_unit>1</update_unit>
    <update_price>1</update_price>
    <update_icon>1</update_icon>
    <update_images>1</update_images>
    <update_quantities>1</update_quantities>
    <products_allowed_operations>all,edit,reset</products_allowed_operations>
    <update_code_producer>1</update_code_producer>
    <update_deliverer>1</update_deliverer>
    <version_mode>1</version_mode>
    <debug_product_import>true</debug_product_import>
    <debug_product_update>true</debug_product_update>
    <debug_product_always_import>false</debug_product_always_import>
    <debug_product_always_update>false</debug_product_always_update>
    <gatewayGeneratedOn>2018-04-12T12:00:00</gatewayGeneratedOn>
    <full_lastModified/>
    <light_lastModified/>
    <categories_lastModified/>
    <sizes_lastModified/>
    <producers_lastModified/>
    <units_lastModified/>
    <series_lastModified/>
    <warranties_lastModified/>
    <providerImageLastModified/>
    <imageHash/>
    <offerCreated>2018-04-12T12:00:00</offerCreated>
    <offerExpires>2018-04-12T12:00:00</offerExpires>
    <warranties>path_or_link_to_warraties.xml_file</warranties>
    <overwrite_products>false</overwrite_products>
    <update_weight>1</update_weight>
    <update_visibility>1</update_visibility>
    <SRP_price>0</SRP_price>
    <STP_price>0</STP_price>
    <offer_from_bridge>0</offer_from_bridge>
    <update_size>1</update_size>
    <culture_info>pl-PL</culture_info>
</preset>

Pliki do pobrania

• Pobierz przykład pliku XML preset
• Pobierz walidator schematu XSD preset