Základní pravidla

  • XML objednávek se používá pouze pro export z Upgates.
  • Zde je k náhledu 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 nabývat hodnoty 0, 1, true, false.
  • Datum je zapsaný jako řeťezec znaků ve formát YYYY-MM-DD dle ISO 8601. Y je rok, M je měsíc a D je den. Příklad: 2020-12-30.

Import

  • Import objednávek pomocí XML není aktuálně k dispozici.
  • Máte k dispozici pouze ve formátu CSV.
  • Dále lze využít napojení na API.
  • Další chování importu můžete ovlivnit nastavením v administraci (viz. nápověda).

Export

  • Exportují se všechny tagy s výjimkou tagů s prázdnou hodnotou. Ty můžete v exportu vynechat.

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
        • <OSS_YN> - objednávka v režimu OSS (pouze pokud má eshop aktivní OSS)
        • <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
        • <TOTAL_PRICE_BEFORE_ROUND> - celková cena objednávky před zaokrouhlením
        • <TOTAL_PRICE_REST> - hodnota zaokrouhlení celkové ceny
        • <TOTAL_EARNINGS> - celková cena zisku z objednávky (pro správnou funkci musí být vyplněny správně nákupní ceny u všech produktů na objednávce)
        • <TOTAL_WEIGHT> - váha všech položek objednávky v gramech
        • <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 (kód produktu nebo varianty)
          • <EAN> - čárový kód
          • <SUPPLIER_CODE> - kód dodavatele
          • <SUPPLIER> - název dodavatele, který je nastaven u produktu
          • <PRODUCT_ID> - ID produktu z databáze (pouze orientačně, pro párování produktů slouží <CODE>)
          • <NOTE> - poznámka k položce objednávky
          • <AVAILABILITY> - dostupnost kterou měl produkt v době vytvoření objednávky
          • <WEIGHT> - váha položky v gramech
          • <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
Na této stránce
Zpět

Další zdroje informací

Facebook poradna

Výměna zkušeností, rady a tipy mezi provozovateli e-shopů na systému UPgates.

Přejít do poradny

Akademie

Získejte znalosti od našich specialistů na marketing, obchod, právo a podnikání.

Přejít do akademie

Novinky z Blogu

Co nového jsme pro vás připravili nebo chystáme najdete na blogu.

Přejít do blogu

Nepodařilo se Vám najít tu správnou odpověď?

Kontaktujte naši technickou podporu, která je tu pro vás od pondělí do pátku 8:00 až 16:00 hod.

Zákaznická podpora