Internet Offer Format (IOF) - specyfikacja funkcjonalna

Poznaj strukturę formatu IOF, dzięki czemu będziesz mógł tworzyć swoją ofertę zgodnie z jego specyfikacją i unikniesz wielu problemów z integracją.

Podstawowe założenia

Internet Offer Format (IOF) to format opisu i informowania o dostępności towarów oparty na XML, pozwalający na dzielenie oferty pomiędzy systemem dostawcy a systemem odbiorcy.

Struktura i jej opis

Dzięki przejrzystej strukturze IOF jest łatwy do zaimplementowania w dowolnym systemie. Format ma charakter otwarty i jest udostępniony za darmo na prawach Creative Commons. Poniższy obrazek przedstawia strukturę formatu:


Struktura formatu IOF
  1. Podstawowym plikiem jest plik gateway.xml. Zawiera on informacje o dostawcy oraz linki do pozostałych plików oferty.
  2. Pierwszym głównym plikiem z oferty jest plik full.xml. Zawiera on podstawowe informacje o towarach np. opisy, zdjęcia, atrybuty czy załączniki. Część dostępnych w nim informacji jest celowo powielana z plikami dodatkowymi (referencyjnymi), aby każdy developer mógł wykorzystać je w dogodny dla siebie sposób.
  3. Drugim głównym plikiem z ofertą jest plik light.xml. Zawiera on informacje m.in. o rozmiarach i ich stanach magazynowych, kodach producenta, wagach oraz cenach w walucie odbiorcy.
  4. Pliki: sizes.xml, series.xml, warranties.xml, categories.xml, producers.xml, parameters.xml, są plikami dodatkowymi, ściśle powiązanymi z głównymi plikami oferty. Zawierają one informacje o wielojęzycznych atrybutach towarów w ofercie.
  5. Plik stocks.xml zawiera informacje o magazynach, w których są towary w ofercie.
  6. Plik preset.xml przechowuje informacje na temat konfiguracji oferty na potrzeby programu służącego do importu oraz synchronizacji oferty (np. IAI Downloader.). Sposób tworzenia pliku oraz jego wykorzystania został opisany na stronie eksport i import ustawień dostawcy z pliku w IAI Downloader.

Struktura formatu nadaje się zarówno do zapisu małej oferty, jak i tych wielkich i szczegółowych, dla których można:

  • tworzyć opisy towarów w dowolnych językach,
  • podawać ceny w dowolnej walucie,
  • określać stan ilościowy w konkretnym magazynie,
  • dodawać ikony i zdjęcia w dowolnej ilości,
  • definiować nazwy atrybutów towarów tj. kategorie, rozmiary, gwarancje, serie w różnych językach.
  • ustawiać ceny przekreślone lub sugerowane, które potem są wyświetlane kupującemu w sklepie

Oszczędzaj moc obliczeniową i transfer serwera sklepu

Tworząc własny program integrujący się z IAI-Shop.com, zadbaj o to, aby miał możliwość wykorzystania sum kontrolnych dla zdjęć i ikon towarów, dzięki czemu do API trafią tylko te elementy które faktycznie zostały zmienione od ostatniej synchronizacji, ograniczy to niepotrzebne obciążenia serwera i przyspieszy proces aktualizacji.

Zadbaj również o prawidłową obsługę faktycznych dat wygenerowania poszczególnych plików formatu IOF (full.xml, light.xml, sizes.xml, series.xml, warranties.xml, categories.xml, producers.xml, parameters.xml, stocks.xml) oraz daty ważności głównego pliku gateway.xml co również zwielokrotni oszczędność wykorzystanego transferu i mocy obliczeniowej.

Możliwości i wykorzystanie formatu

Internet Offer Format (IOF) to nośnik informacji o towarach i ich atrybutach, składający się z części pozwalającej na udostępnianie informacji podstawowych takich jak:

  • typ towaru,
  • kategoria,
  • producent,
  • cena: brutto, netto, sugerowana cena detaliczna, przekreślona cena detaliczna,
  • opis: nazwa, opis krótki, opis długi,
  • zdjęcia,
  • ikony,
  • parametry oraz sekcje,
  • gwarancja,
  • rozmiary,
  • serie,
  • wagi,
  • jednostka miary,
  • grupa,
  • załączniki.

która powinna pasować do wszystkich rozwiązań.

Jak również z części rozszerzonej, którą dzięki naszemu wieloletniemu doświadczeniu wzbogacona została o przemyślane rozwiązanie w postaci IOF Extensions. Formatu polecanego szczególnie tym użytkownikom IAI-Shop.com, którzy oprócz standardowej funkcjonalności IOF potrzebują gotowego standardu na obsługę szerszego wachlarza danych o towarach.

Wybierz wygodny dla siebie sposób integracji IOF

Format IOF został opracowany na potrzeby integracji pomiędzy dostawcą towarów a sprzedawcą (dystrybutorem). Stanowi również doskonałe uzupełnienie dla otwartego formatu Internet Cross-docking and Drop-shipping Format (ICDF), którego głównym założeniem jest właśnie skomunikowanie hurtowni i sklepów internetowych.

  • Jeśli jesteś dostawcą-hurtownikiem, bądź chcesz aby Twój sklep dostarczał oferty innym i chcesz wykorzystać format IOF jako podstawę wymiany informacji o swoim asortymencie ze sprzedawcami, to przygotuj stosowne składowe dokumentu IOF według specyfikacji, zapoznając się jednocześnie ze strukturą plików formatu IOF.

  • Jeśli jesteś sprzedawcą (odbiorcą oferty), to przygotuj stosowne narzędzia do przetworzenia dokumentów XML, według przyjętej strategii wykorzystania przesyłanych informacji, do skonstruowania oferty sprzedaży.

Jeżeli Twój dostawca nie jest Klientem IAI i posiada inny system, możesz stworzyć odpowiedni sterownik XSLT, który otrzymaną od dostawcy ofertę w dowolnej strukturze XML przetransformuje na strukturę przyjazną dla programu IAI Downloader.

Specyfikacja techniczna

Poniżej możesz pobrać najnowszą wersję specyfikacji technicznej IOF.