Základní pravidla

  • XML se používá pro export z UPgates
  • můžete se podívat na prázdné vzorové XML
  • k testování struktury XML je možno použít naše XSD
  • tagy končící na _YN> jsou typu boolean a mohou hodnoty 0, 1, true, false
  • tagy reprezentující datum (většinou končící na _FROM> nebo _TO>) používají formát YYYY-MM-DD, kde Y je rok, M je měsíc a D je den (např. 2017-03-07)

Import

  • import objednávek je dispozici pouze ve formátu CSV
  • pro další věci k dispozici je pouze API

Export

  • exportují se všechny tagy z výjimkou tagů s prázdnou hodnotou, ty mohou v exportu chybět

Struktura XML

  • <ORDERS>
    • version - verze formátu XML, aktuálně je to 1.0
    • <ORDER>- objednávka
      • <HEADER>- hlavička
        • <CODE> - kód objednávky
        • <STATUS> - stav objednávky
        • <PAID>
          • <PAID_YN> - objednávka zaplacena
          • <PAID_DATE> - datum zaplacení
        • <RESOLVED_YN> - vyřešeno / nevyřešeno
        • <INVOICE_NUMBER> - číslo faktury k objednávce
        • <CUSTOMER_NOTE> - poznámka zákazníka
        • <INTERNAL_NOTE> - interní poznámka
        • <CURRENCY> - měna podle ISO 4217
        • <TOTAL_PRICE_WITH_VAT> - celková cena objednávky s DPH
        • <TRACKING_CODE> - sledovací kód objednávky
        • <CREATED_AT> - datum a čas vytvoření objednávky
        • <UPDATED_AT> - datum a čas aktualizace objednávky
      • <CUSTOMER>- zákazník
        • <CUSTOMER_ID> - ID zákazníka
        • <CUSTOMER_CODE> - číslo zákazníka
        • <FIRSTNAME> - jméno
        • <SURNAME> - příjmení
        • <COMMUNICATION>- komunikace
          • <PHONE> - telefon
          • <EMAIL> - email
        • <COMPANY_YN> - je zákazník firma
        • <COMPANY>- firma
          • <NAME> - název firmy
          • <COMPANY_NUMBER> - IČ
          • <VAT_NUMBER> - DIČ
        • <ADDRESSES>- adresy
          • <BILLING>- fakturační adresa
            • <STREET> - ulice
            • <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
            • <COMPANY_NAME> - název firmy
            • <FIRSTNAME> - jméno
            • <SURNAME> - příjmení
            • <STREET> - ulice
            • <CITY> - město
            • <STATE> - kraj
            • <ZIP_CODE> - PSČ
            • <COUNTRY_ID> - dvoumístný kód země podle ISO 3166-1 alpha-2
      • <ITEMS>- položky objednávky
        • <ITEM>
          • <TITLE> - název položky
          • <CODE> - kód položky
          • <EAN> - čárový kód
          • <SUPPLIER_CODE> - kód dodavatele
          • <SUPPLIER> - název dodavatele, který je nastaven u produktu
          • <PRODUCT_ID> - ID produktu
          • <NOTE> - poznámka k položce objednávky
          • <VARIANT>- varianta
            • <PARAMETER>- parametry varianty
              • <NAME> - název parametru
              • <VALUE> - hodnota parametru
          • <CONFIGURATION>- konfigurace
            • <PARAMETER>- parametry konfigurace
              • <NAME> - název parametru
              • <VALUE> - hodnota parametru
          • <LENGTH>- metráž
            • <UNIT> - jednotka
            • <VALUE> - hodnota metráže
          • <QUANTITY> - počet kusů
          • <PRICE_WITH_VAT> - cena s DPH
          • <VAT> - hodnota DPH
      • <DISCOUNTS>- slevy
        • <DISCOUNT_VOUCHER>
          • type - typ kupónu. Hodnoty: price, percent
          • amount - hodnota slevy, pokud je typ price bude to cena, pokud je typ percent budout to procenta
          • code - kód slevového kupónu
          • <DISCOUNT>- hodnota slevy pro jednotlivé DPH
            • vat - hodnota DPH
        • <QUANTITY_DISCOUNT>- množstevní sleva
          • type - typ slevy. Hodnoty: price, percent
          • amount - hodnota slevy, pokud je typ price bude to cena, pokud je typ percent budout to procenta
          • <DISCOUNT>- hodnota slevy pro jednotlivé DPH
            • vat - hodnota DPH
        • <LOYALTY_POINTS>- věrnostní body
          • amount - hodnota slevy
          • price_per_point - cena za jeden bod
          • <DISCOUNT>- hodnota slevy pro jednotlivé DPH
            • vat - hodnota DPH
      • <SHIPMENT>- doprava
        • <CODE> - kód dopravy, (ve vlastních polích v administraci)
        • <NAME> - název dopravy
        • <BRANCH_ID> - ID pobočky dopravce, pouze v případě že se jedná o dopravu se systémem poboček např. PPL ParcelShop, Zásilkovna, Uloženka atd.
        • <PRICE_WITH_VAT> - cena s DPH
        • <VAT> - hodnota DPH
      • <PAYMENT>- platba
        • <CODE> - kód platby, (ve vlastních polích v administraci)
        • <NAME> - název platby
        • <PRICE_WITH_VAT> - cena s DPH
        • <VAT> - hodnota DPH
      • <AGREEMENTS>- souhlasy
        • <AGREEMENT>
          • <NAME> - název souhlasu
          • <VALID_TO> - čas do kdy je souhlas platný
          • <STATUS> - stav souhlasu, ano / ne, může nabývat hodnot 1/0