Dokumentácia XML - objednávky

Základné pravidlá

  • XML objednávok sa používa len pre export z Upgates.
  • Tu je k náhľadu prázdne vzorové XML.
  • Na testovanie štruktúry XML je možné použiť naše XSD.
  • Tagy končiace na _YN> sú typu boolean a môžu nadobúdať hodnoty 0, 1, true, false.
  • Dátum je zapísaný ako reťazec znakov vo formáte YYYY-MM-DD podľa ISO 8601. Y je rok, M je mesiac a D je deň. Príklad: 2020-12-30.

Import

  • Import objednávok pomocou XML nie je aktuálne k dispozícii.
  • Máte k dispozícii len import vo formáte.
  • Ďalej je možné využiť napojenie na API.
  • Ďalšie správanie importu môžete ovplyvniť nastavením v administrácii (viď nápoveda).

Export

  • Exportujú sa všetky tagy s výnimkou tagov s prázdnou hodnotou.

Struktura XML

  • <ORDERS>
    • version - verzia formátu XML, aktuálne je to 1.0
    • <ORDER> - objednávka
      • <HEADER> - hlavička
        • <CODE> - kód objednávky
        • <STATUS> - stav objednávky
        • <PAID>
          • <PAID_YN> - objednávka zaplatená
          • <PAID_DATE> - dátum zaplatenia
        • <RESOLVED_YN> - vyriešené / nevyriešené
        • <OSS_YN> - objednávka v režime OSS (len pokiaľ má e-shop aktívnu OSS)
        • <INVOICE_NUMBER> - číslo faktúry k objednávke
        • <CUSTOMER_NOTE> - poznámka zákazníka
        • <INTERNAL_NOTE> - interná poznámka
        • <CURRENCY> - mena podľa ISO 4217
        • <TOTAL_PRICE_WITH_VAT> - celková cena objednávky s DPH
        • <TOTAL_PRICE_BEFORE_ROUND> - celková cena objednávky pred zaokrúhlením
        • <TOTAL_PRICE_REST> - hodnota zaokrúhlenia celkovej ceny
        • <TOTAL_EARNINGS> - celková cena zisku z objednávky (pre správnu funkciu musia byť vyplnené správne nákupné ceny pri všetkých produktoch na objednávke)
        • <TOTAL_WEIGHT> - váha všetkých položiek objednávky v gramoch
        • <TRACKING_CODE> - sledovací kód objednávky
        • <CREATED_AT> - dátum a čas vytvorenia objednávky
        • <UPDATED_AT> - dátum a čas aktualizácie objednávky
      • <CUSTOMER> - zákazník
        • <CUSTOMER_ID> - ID zákazníka
        • <CUSTOMER_CODE> - číslo zákazníka
        • <FIRSTNAME> - meno
        • <SURNAME> - priezvisko
        • <COMMUNICATION> - komunikácia
          • <PHONE> - telefón
          • <EMAIL> - email
        • <COMPANY_YN> - je zákazník firma
        • <COMPANY> - firma
          • <NAME> - názov firmy
          • <COMPANY_NUMBER> - IČO
          • <VAT_NUMBER> - DIČ
        • <ADDRESSES> - adresy
          • <BILLING> - fakturačná adresa
            • <STREET> - ulice
            • <CITY> - mesto
            • <STATE> - kraj
            • <ZIP_CODE> - PSČ
            • <COUNTRY_ID> - dvojmiestny kód krajiny podľa ISO 3166-1 alpha-2
          • <POSTAL> - doručovacia adresa
            • <COMPANY_NAME> - názov firmy
            • <FIRSTNAME> - meno
            • <SURNAME> - priezvisko
            • <STREET> - ulica
            • <CITY> - mesto
            • <STATE> - kraj
            • <ZIP_CODE> - PSČ
            • <COUNTRY_ID> - dvojmiestny kód krajiny podľa ISO 3166-1 alpha-2
      • <ITEMS> - položky objednávky
        • <ITEM>
          • <TITLE> - názov položky
          • <CODE> - kód položky (kód produktu alebo variantu)
          • <EAN> - čiarový kód
          • <SUPPLIER_CODE> - kód dodávateľa
          • <SUPPLIER> - názov dodávateľa, ktorý je nastavený pri produkte
          • <PRODUCT_ID> - ID produktu z databázy (len orientačne, pre párovanie produktov slúži <CODE>)
          • <NOTE> - poznámka k položke objednávky
          • <AVAILABILITY> - dostupnosť, ktorú mal produkt v čase vytvorenia objednávky
          • <WEIGHT> - váha položky v gramoch
          • <VARIANT> - variant
            • <PARAMETER> - parametre variantu
              • <NAME> - názov parametra
              • <VALUE> - hodnota parametra
          • <CONFIGURATION> - konfigurácia
            • <PARAMETER> - parametre konfigurácie
              • <NAME> - názov parametra
              • <VALUE> - hodnota parametra
          • <LENGTH> - metráž
            • <UNIT> - jednotka
            • <VALUE> - hodnota metráže
          • <QUANTITY> - počet kusov
          • <PRICE_WITH_VAT> - cena s DPH
          • <VAT> - hodnota DPH
      • <DISCOUNTS> - zľavy
        • <DISCOUNT_VOUCHER>
          • type - typ kupónu. Hodnoty: price, percent
          • amount - hodnota zľavy, pokiaľ je typ price bude to cena, pokiaľ je typ percent budú to percentá
          • code - kód zľavového kupónu
          • <DISCOUNT> - hodnota slevy pro jednotlivé DPH
            • vat - hodnota DPH
        • <QUANTITY_DISCOUNT> - množstevní sleva
          • type - typ zľavy. Hodnoty: price, percent
          • amount - hodnota slevy, pokud je typ price bude to cena, pokud je typ percent budout to procenta
          • <DISCOUNT> - hodnota zľavy pre jednotlivé DPH
            • vat - hodnota DPH
        • <LOYALTY_POINTS> - vernostné body
          • amount - hodnota slevy
          • price_per_point - cena za jeden bod
          • <DISCOUNT> - hodnota zľavy pre jednotlivé DPH
            • vat - hodnota DPH
      • <SHIPMENT> - doprava
        • <CODE> - kód dopravy, (vo vlastných poliach v administrácii)
        • <NAME> - názov dopravy
        • <BRANCH_ID> - ID pobočky dopravcu, len v prípade, že ide o dopravu so systémom pobočiek napr. PPL ParcelShop, Zásielkovňa, Uloženka atď.
        • <PRICE_WITH_VAT> - cena s DPH
        • <VAT> - hodnota DPH
      • <PAYMENT> - platba
        • <CODE> - kód platby (vo vlastných poliach v administrácii)
        • <NAME> - názov platby
        • <PRICE_WITH_VAT> - cena s DPH
        • <VAT> - hodnota DPH
      • <AGREEMENTS> - súhlasy
        • <AGREEMENT>
          • <NAME> - názov súhlasu
          • <VALID_TO> - čas dokedy je súhlas platný
          • <STATUS> - stav súhlasu, áno / nie, môže nadobúdať hodnoty 1/0
      • <METAS> - vlastné pole
        • <META
          • type - typ vlastného poľa, možné hodnoty:
            • radio - prepínač
            • checkbox - zaškrtávacie políčko
            • input - textové pole
            • date - dátum
            • email - email
            • number - číslo
            • select - rozbaľovacia ponuka
            • multiselect - multi rozbaľovacia ponuka
            • textarea - viacriadkové textové pole
            • formatted - viacriadkové textové pole formátované (WYSIWYG)
          • <META_KEY> - kľúč vlastného poľa - povolené znaky sú malé písmená, čísla (nesmú byť na prvej pozícii) a podčiarknutie
          • <META_VALUE> - hodnota vlastného poľa, uvádza sa pokiaľ je rovnaká pre všetky jazykové mutácie
Na tejto stránke

Další zdroje informací

Facebook forum

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

Přejít do fora

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