Základní pravidla

Import

  • neuvádějte prázdné obalové tagy (např. tag <ADDRESSES>, pokud neobsahuje žádné adresy)
  • v případě editace (při importu) se prázdný tag chápe jako vymazání původní hodnoty v databázi
  • zákazníci se při importu párují podle emailu
  • všechny tagy jsou nepovinné, kromě kořenových tagů <CONTACTS> a <CONTACT>. Při importu nových produktů je povinný tag <EMAIL> (s celou nadřezenou strukturou). Dále je všude povinný atribut language.
  • systém eviduje 3 druhy zákazníků:
    • kontakt - <CUSTOMER_YN> = 0 a <COMPANY_YN> = 0
    • zákazník osoba - <CUSTOMER_YN> = 1 a <COMPANY_YN> = 0
    • zákazník firma - <CUSTOMER_YN> = 1 a <COMPANY_YN> = 1
  • tagy které mohou obsahovat HTML formátování je možno zapsat buď převedeno do HTML entit, nebo pomocí CDATA (<![CDATA[ ]]>)
  • číslelné hodnoty se uvání nezformátované bez znaku jednotky (např. ceny, hmotnost nebo DPH). Jako oddělovač desetinných míst použijte tečku nebo čárku.
  • další chování importu můžete ovlivnit nastavením v administraci
  • více informací o importu najdete v článku Import dat do e-shopu

Export

  • exportují se všechny tagy z výjimkou tagů s prázdnou hodnotou, ty mohou v exportu chybět
  • export z jednoho projektu UPgates je možno použít pro import do jiného projetu UPgates

Struktura XML

  • <CONTACTS>
    • version - verze formátu XML, aktuálně je to 1.0
    • <CONTACT>
      • <CUSTOMER_ID> - ID zákazníka (pouze export)
      • <CUSTOMER_YN>
        • 1 = zákazník (registrovaný; má zákaznický účet)
        • 0 = kontakt (neregistrovaný)
      • <COMPANY_YN>
        • 1 = firemní zákazník (má vyplněné firemní údaje)
        • 0 = osoba zákazník
      • <DEGREE> - titul
      • <FIRSTNAME> - křestní jméno
      • <SURNAME> - příjmení
      • <NICKNAME> - přezdívka
      • <CODE> - zákaznické číslo. Pokud není uvedeno, vyplní se automaticky podle číselné řady
      • <LANGUAGE> - dvoumístný kód jazyka, pod kterým byl kontakt vytvořen. Jazyk musí být založen v administraci. Pokud není uveden, automaticky se bere výchozí jazyk
      • <NEWSLETTER_YN> - kontakt chce / nechce dostávat newsletter
      • <CAN_SEE_PRIVATE_YN> - zákazník vidí / nevidí neveřejný obsah
      • <SET_PRICELIST_BY_TURNOVER_YN> - nastaven ceník podle obratu zákazníka
      • <PRICELIST> - název ceníku, který má zákazník přidělen. Páruje se podle existující hodnoty v databázi (v hlavním jazyku) a pokud neexistuje, nezakládá se automaticky nová!
      • <DEFAULT_TURNOVER> - výchozí hodnota obratu
      • <LOYALTY_SYSTEM> - počet bodů získaných ve věrnostním systému
      • <COMPANY>- firemní údaje
        • <NAME> - název firmy
        • <COMPANY_NUMBER> - IČ
        • <VAT_NUMBER> - DIČ
      • <COMMUNICATION>- komunikace
        • <PHONE> - telefon, pouze čísla a znak + na začátku, všechny ostatní znaky budou odstaněny
        • <FAX> - fax
        • <IM> - instant messaging
        • <SALUTATION> - oslovení zákazníka (v jeho jazyce)
        • <DECLENSION> - skloňování zákazníkova jména v 5. pádě
      • <LOGIN>- přihlašovací údaje
        • <ACTIVE_YN> - povolení nebo zakázání přihlášení zákazníka do zákaznického účtu
        • <BLOCKED_YN> - blokovaný kontakt
        • <EMAIL> - jednoznačný identifikátor kontaktu a zákazníka (POVINNÝ). Přihlašovací údaj do zákaznického účtu v případě zákazníka. Páruje se podle existující hodnoty v databázi, nebo vytvoří nový kontakt
        • <PASSWORD> - heslo pro přihlášení do zákaznického účtu. Pokud je uvedeno, bude nový zákazník založen s tímto heslem a stávajícímu se změní. Pokud není uvedeno, stávajícímu zákazníkovi zůstane původní heslo a novému se vygeneruje náhodné
      • <GROUPS>- skupiny
        • <GROUP> - název skupiny. Páruje se podle existující hodnoty v databázi (v hlavním jazyku), nebo vytvoří novou
      • <NOTE> - poznámka
      • <CAN_RATE_PRODUCTS_YN> - může hodnotit produkty - hvězdičky, recenze
      • <ADDRESSES>- adresy
        • <BILLING>- fakturační adresa
          • <STREET> - ulice a číslo
          • <CITY> - město
          • <STATE> - kraj
          • <ZIP_CODE> - PSČ
          • <COUNTRY_ID> - dvoumístný kód země podle ISO 3166-1 alpha-2
        • <POSTAL>- doručovací adresa (možno opakovat vícekrát)
          • <COMPANY_NAME> - název firmy
          • <FIRSTNAME> - křestní jméno
          • <SURNAME> - příjmení
          • <STREET> - ulice a číslo
          • <CITY> - město
          • <STATE> - kraj
          • <ZIP_CODE> - PSČ
          • <COUNTRY_ID> - dvoumístný kód země podle ISO 3166-1 alpha-2
      • <AGREEMENTS>- souhlasy
        • <AGREEMENT>
          • <NAME> - název souhlasu, páruje se s existujícím souhlasem v databázi, pokud odpovídající souhlas neexistuje ignoruje se
          • <TIME> - čas pořízení souhlasu, pokud bude prázdné, nebo nebude uvedeno, bere se aktuální čas
          • <VALID_TO> - čas do kdy je souhlas platný, pokud bude prázdné, nebo nebude uvedeno, bere se z nastavení konkrétního souhlasu
          • <STATUS> - stav souhlasu, ano / ne, může nabývat hodnot 1/0
      • <METAS>- vlastní pole
        • <META>
          • type - typ vlastního pole, možné hodnoty: radio, checkbox, input, date, email, number, select, multiselect, textarea (výchozí), formatted
          • <META_KEY> - klíč vlastního pole - povolené znaky jsou malá písmena, čísla (nesmí být na první pozici) a podtržítko
          • <META_VALUE> - hodnota vlastního pole, uvádí se pokud je stejná pro všechny jazykové mutace
          • <META_VALUES>- hodnoty vlastního pole pro jednotlivé jazykové mutace
            • <META_VALUE>
              • language - specifikace jazykové mutace