Ukázkový soubor XML feedu:

• LEAFLETS – Kořenová značka XML feedu

  Povinné

  Typ hodnoty: complex

  Odkaz

  Uvedení celého XML feedu (datového souboru obsahujícího všechny letáky) a jeho uzavření na konci souboru předávajícího informace.

  Příklad:

  <LEAFLETS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <LEAFLET><!-- ... --></LEAFLET>
  <LEAFLET><!-- ... --></LEAFLET>
  <!-- ... -->
  </LEAFLETS>

  • LEAFLET – Obaluje informace konkrétního letáku

    Povinné

    Typ hodnoty: complex

    Odkaz

    Uvedení a uzavření každého jednotlivého letáku v rámci jednoho feedu.

    Příklad:

    <LEAFLET>...</LEAFLET>

    • LEAFLET_ID – Identifikátor letáku

      Doplňkové

      Typ hodnoty: string

      Odkaz

      Unikátní identifikátor letáku (alfanumerické znaky).

      Příklad:

      <LEAFLET_ID>letak-kupi-1</LEAFLET_ID>

    • NAME – Název

      Povinné

      Typ hodnoty: string

      Odkaz

      Název letáku zobrazeného na Kupi. Maximální délka je 255 znaků.

      Příklad:

      <NAME>Název letáku</NAME>

    • VALIDITY – Platnost

      Povinné

      Typ hodnoty: complex

      Odkaz

      Datum platnosti letáku.

      Příklad:

      <VALIDITY>
      	<START>2021-07-01</START>
      	<END>2021-08-31</END>
      </VALIDITY>

    • PUBLISH_DATE – Datum začátku publikace letáku na Kupi

      Povinné

      Typ hodnoty: date

      Odkaz

      Datum ve formátu RRRR-MM-DD začátku publikace letáku na Kupi.

      Příklad:

      <PUBLISH_DATE>2021-07-01</PUBLISH_DATE>

    • IMGURL – Odkaz na obrázek

      Povinné

      Typ hodnoty: string

      Odkaz

      Odkaz na obrázek letáku ve formátu JPG nebo PNG, který slouží k zobrazení náhledu. URL odkaz je třeba uvádět v nezakódované podobě (dle specifikace RFC 3986). Doporučujeme dodávat obrázek v co největším možném rozlišení.

      Příklad:

      <IMGURL>https://kupi.cz/img.jpg</IMGURL>

    • CATEGORY – Kategorie pro zařazení letáku

      Povinné

      Typ hodnoty: number

      Odkaz

      Kupi kategorie, kde má být leták zařazen. Je možné zadat více katagorií.

      Příklad:

      <CATEGORY>1</CATEGORY>

    • LEAFLET_CONFIG – Nastavení zobrazení letáku

      Doplňkové

      Typ hodnoty: complex

      Odkaz

      Slouží ke konfiguraci jednotlivých prvků letáku.

      Příklad:

      <LEAFLET_CONFIG>
      	<LEAFLET_SEARCH>0</LEAFLET_SEARCH>
      	...
      </LEAFLET_CONFIG>

    • LEAFLET_SECTIONS – Sekce letáku

      Povinné

      Typ hodnoty: complex

      Odkaz

      Obsahuje sekce letáku.

      Příklad:

      <LEAFLET_SECTIONS>
      	<SECTION>...</SECTION>
      	...
      </LEAFLET_SECTIONS>

    • MARKETS – Pobočky

      Doplňkové

      Typ hodnoty: complex

      Odkaz

      Seznam poboček obchodníka, kde leták platí.

      Příklad:

      <MARKETS>
      	<MARKET>...</MARKET>
      	...
      </MARKETS>