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 vo formáte CSV.
- Ď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.
Štruktúra XML
- <ORDERS>
- <HEADER> - hlavička
- <PAID_YN> - objednávka zaplatená
- <PAID_DATE> - dátum zaplatenia
- <CODE> - kód objednávky
- <STATUS> - stav objednávky
- <PAID>
- <RESOLVED_YN> - vyriešené / nevyriešené
- <OSS_YN> - objednávka v režime OSS (len pokiaľ má eshop 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
- <PHONE> - telefón
- <EMAIL> - e-mail
- <NAME> - názov firmy
- <COMPANY_NUMBER> - IČ
- <VAT_NUMBER> - DIČ
- <BILLING> - fakturačná adresa
- <STREET> - ulica
- <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
- <CUSTOMER_ID> - ID zákazníka
- <CUSTOMER_CODE> - číslo zákazníka
- <FIRSTNAME> - meno
- <SURNAME> - priezvisko
- <COMMUNICATION> - komunikácia
- <COMPANY_YN> - je zákazník firma
- <COMPANY> - firma
- <ADDRESSES> - adresy
- <ITEMS> - položky objednávky
- <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
- <NAME> - názov parametra
- <VALUE> - hodnota parametra
- <PARAMETER> - parametre variantu
- <CONFIGURATION> - konfigurácia
- <NAME> - názov parametra
- <VALUE> - hodnota parametra
- <PARAMETER> - parametre konfigurácie
- <LENGTH> - metráž
- <UNIT> - jednotka
- <VALUE> - hodnota metráže
- <QUANTITY> - počet kusov
- <PRICE_WITH_VAT> - cena s DPH
- <VAT> - hodnota DPH
- <ITEM>
- <DISCOUNTS> - zľavy
- 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 zľavy pre jednotlivé DPH
- vat - hodnota DPH
- type - typ zľavy. Hodnoty: price, percent
- amount - hodnota zľavy, pokiaľ je typ price bude to cena, pokiaľ je typ percent budú to percentá
- <DISCOUNT> - hodnota zľavy pre jednotlivé DPH
- vat - hodnota DPH
- amount - hodnota zľavy
- price_per_point - cena za jeden bod
- <DISCOUNT> - hodnota zľavy pre jednotlivé DPH
- vat - hodnota DPH
- <DISCOUNT_VOUCHER>
- <QUANTITY_DISCOUNT> - množstevná zľava
- <LOYALTY_POINTS> - vernostné body
- <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
- <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
- <AGREEMENT>
- <HEADER> - hlavička
- version - verzia formátu XML, aktuálne je to 1.0
- <ORDER> - objednávka