Egyedi webáruház fejlesztői dokumentációja

<< Kattintson a Tartalomjegyzék megjelenítéséhez >>

Navigáció: Első lépések, gyakorlati útmutatók >

Egyedi webáruház fejlesztői dokumentációja

Az express.ügyvitelben lehetőség van egyedi webáruházból megrendeléseket importálni XML formátumból. Az importálásnak két előfeltétele van:

a webáruház beállításokat el kell végezni a programban, ezzel felkészülve az adatok fogadására.

a megfelelő XML struktúrát/adatfájlt legeneráltatni a webáruházból. Ennek felépítéséhez külön mintafájlokat készítettünk, ami erre a linkre kattintva letölthető jelen dokumentációval együtt, illetve az alábbi dokumentumból is kimásolhatók a kódok.

A megfelelő XML állomány elkészítéséhez a webáruházához külön beépülő szükséges, melyet egy webprogramozóval tud elkészíttetni, cégünk nem vállal ilyen feladatot.

XML adatstruktúra minta és leírásuk

Az alábbi struktúra alapján kell legenerálni a webáruházból a megrendeléseket. A csillaggal megjelölt adatok kitöltése kötelező, a többi esetben ha a mező nem tartalmaz adatot, akkor üresen kell átadni!

<?xml version="1.0" encoding="UTF-8" ?>

<Orders>

<Order>

  <Key>ORD-001</Key>                                                               <!-- *megrendelés bizonylatszáma a webáruházban (kötelező, max 100 hosszú)-->

  <Id>ID123456</Id>                                                               <!-- *megrendelés azonosítója a webáruházban (kötelező, max 100 hosszú) -->

  <Date>2025.02.28 10:50:48</Date>                                                 <!-- *megrendelés rögzítésének dátuma (kötelező, YYYY.MM.DD HH:mm:ss formátumban) -->

  <Customer>

    <Id>ID123456</Id>                                                             <!-- *vevő egyedi azonosítója a webáruházban (kötelező, max 100 hosszú) -->

    <Email><![CDATA[gipszjakab@gmail.com]]></Email>                               <!-- *vevő e-mail címe a webáruházban (kötelező, max 200 hosszú) -->

    <Addresses>

      <Invoice>                                                                   <!-- *számlázási cím adatok -->

        <Name><![CDATA[Gipsz Jakab]]></Name>                                       <!-- *vevő neve (kötelező, max 200 hosszú) -->

        <ZIP>1133</ZIP>                                                           <!-- *irányítószám (kötelező,  max 25 hosszú) -->

        <City><![CDATA[Budapest]]></City>                                         <!-- *város (kötelező, max 200 hosszú) -->

        <District><![CDATA[XIII. kerület]]></District>                             <!-- kerület (max 100 hosszú) -->

        <Street><![CDATA[Váci út 76., 5. torony 7. em.]]></Street>                 <!-- összefőzött cím (megadása akkor kötelező, ha nincs bontott cím (közterület neve, jellege, házszám) (max 1000 hosszú)-->

        <StreetName><![CDATA[Váci]]></StreetName>                                 <!-- közterület neve (max 100 hosszú) -->

        <StreetType><![CDATA[út]]></StreetType>                                   <!-- közterület jellege (max 100 hosszú) -->

        <StreetNumber><![CDATA[76.]]></StreetNumber>                               <!-- házszám (max 50 hosszú) -->

        <POB><![CDATA[100]]></POB>                                                 <!-- postafiók (max 50 hosszú) -->

        <Building><![CDATA[1.]]></Building>                                       <!-- épület (max 100 hosszú) -->

        <Stairway><![CDATA[5. torony]]></Stairway>                                 <!-- lépcsőház (max 100 hosszú) -->

        <Floor><![CDATA[7.]]></Floor>                                             <!-- emelet (max 100 hosszú) -->

        <Door><![CDATA[1.]]></Door>                                               <!-- ajtó (max 100 hosszú) -->

        <Country><![CDATA[Magyarország]]></Country>                               <!-- *ország neve (kötelező, max 200 hosszú) -->

        <CountryCode>hu</CountryCode>                                             <!-- *ország 2 betűs kódja (kötelező, max 2 hosszú) -->

        <TaxNumber><![CDATA[12345678-9-10]]></TaxNumber>                           <!-- vevő adószáma (max 100 hosszú) -->

        <EUTaxNumber><![CDATA[HU12345678-9-10]]></EUTaxNumber>                     <!-- vevő közösségen belüli adószáma (max 100 hosszú)-->

        <Mobil><![CDATA[+36-30-123-45678]]></Mobil>                               <!-- vevő mobilszáma (max 70 hosszú) -->

        <Phone><![CDATA[+36-1-123-45678]]></Phone>                                 <!-- vevő telefonszáma (max 70 hosszú) -->

      </Invoice>

      <Shipping>                                                                   <!-- szállítási cím adatok (nem kötelező, a feldolgozás során választható, hogy megegyezzen a számlázási címmel) -->

        <ZIP>1133</ZIP>                                                           <!-- irányítószám -->

        <City><![CDATA[Budapest]]></City>                                         <!-- város -->

        <District><![CDATA[XIII. kerület]]></District>                             <!-- kerület (max 100 hosszú) -->

        <Street><![CDATA[Váci út 76., 5. torony 7. em.]]></Street>                 <!-- összefőzött cím (megadása akkor kötelező, ha nincs bontott cím (közterület neve, jellege, házszám) (max 1000 hosszú)-->

        <StreetName><![CDATA[Váci]]></StreetName>                                 <!-- közterület neve (max 100 hosszú) -->

        <StreetType><![CDATA[út]]></StreetType>                                   <!-- közterület jellege (max 100 hosszú) -->

        <StreetNumber><![CDATA[76.]]></StreetNumber>                               <!-- házszám (max 50 hosszú) -->

        <POB><![CDATA[100]]></POB>                                                 <!-- postafiók (max 50 hosszú) -->

        <Building><![CDATA[1.]]></Building>                                       <!-- épület (max 100 hosszú) -->

        <Stairway><![CDATA[5. torony]]></Stairway>                                 <!-- lépcsőház (max 100 hosszú) -->

        <Floor><![CDATA[7.]]></Floor>                                             <!-- emelet (max 100 hosszú) -->

        <Door><![CDATA[1.]]></Door>                                               <!-- ajtó (max 100 hosszú) -->

        <Country><![CDATA[Magyarország]]></Country>                               <!-- ország neve -->

        <CountryCode>hu</CountryCode>                                             <!-- ország 2 betűs kódja -->

      </Shipping>

    </Addresses>

    <BankName><![CDATA[OTP]]></BankName>                                           <!-- bankfiók neve (max 100 hosszú) -->

    <BankAccountNumber><![CDATA[12345678-12345678-12345678]]></BankAccountNumber> <!-- bankszámlaszám (max 100 hoszzú) -->

    <BankIBAN><![CDATA[HU42]]></BankIBAN>                                         <!-- IBAN kód (előtag) (max 10 hosszú) -->

    <BankSWIFT><![CDATA[OTPVHUHBXXX]]></BankSWIFT>                                 <!-- SWIFT kód (max 100 hosszú) -->

  </Customer>

  <CourierService>

    <Name><![CDATA[GLS csomagpont]]></Name>                                       <!-- futárszolgálat neve -->

    <ParcelPoint><![CDATA[HU123]]></ParcelPoint>                                   <!-- átvételipont azonosítója -->

    <ContactName><![CDATA[Teszt Elek]]></ContactName>                             <!-- kapcsolattartó neve -->

    <Comment><![CDATA[dudálj, mert nem jó a csengő]]></Comment>                   <!-- megjegyzés a futárnak -->

  </CourierService>

  <Currency>HUF</Currency>                                                         <!-- *megrendelés deviza kódja (kötelező, max 10 hosszú) -->

  <CurrencyRate>1</CurrencyRate>                                                   <!-- *megrendelés deviza árfolyama (kötelező, amennyiben 0, a program árfolyamát használja) -->

  <StatusID>STAT01></StatusID>                                                     <!-- *megrendelés státuszának kódja a webáruházban (kötelező, max 100 hosszú) -->

  <Description><![CDATA[megrendelés megjegyzés]]></Description>                   <!-- megrendeléshez fűzött megjegyzés -->

  <Payment>

    <Id>PAY01</Id>                                                                 <!-- *fizetési mód kódja a webáruházban (kötelező, max 100 hosszú) -->

    <Name><![CDATA[Utánvét]]></Name>                                               <!-- *fizetési mód megnevezése a webáruházban (kötelező, max 200 hosszú) -->

  </Payment>

  <SumPriceGross>4990.00</SumPriceGross>                                           <!-- *megrendelés bruttó végösszege a webáruházban (kötelező)-->

  <Items>                                                                         <!-- *megrendelés sorai (kötelező, minimum 1 sor)-->

    <Item>

      <Id>A123456789</Id>                                                         <!-- *áru kódja a webáruházban (kötelező, max 100 hosszú) -->

      <Sku>CSZ001</Sku>                                                           <!-- *áru cikkszáma a webáruházban (kötelező, max 100 hosszú) -->

      <Name><![CDATA[Árvíztűrőtükörfúrógép]]></Name>                               <!-- *áru megnevezése a webáruházban (kötelező, max 200 hosszú) -->

      <Description><![CDATA[sor megjegyzés]]></Description>                       <!-- megrendeléssorhoz fűzött megjegyzés -->

      <Unit>db</Unit>                                                             <!-- *áru mennyiségi egysége (kötelező, max 50 hosszú) -->

      <Quantity>2</Quantity>                                                       <!-- *megrendeléssoron szerepelő mennyiség (kötelező) -->

      <UnitPriceNet>1574.8031</UnitPriceNet>                                       <!-- *áru nettó egységára (kötelező) -->

      <UnitPriceGross>2000</UnitPriceGross>                                       <!-- *áru bruttó egységára (kötelező, ha nettó egységár nulla, akkor bruttó bevitel típussal ez az érték kerül a bizonylatsorba) -->

      <Vat>27%</Vat>                                                               <!-- *megrendeléssor áfájának neve (kötelező, max 100 hosszú) -->

      <VatPercent>0.27</VatPercent>                                               <!-- *megrendeléssor áfa szorzója (kötelező, max 4 tizedesjegy) -->

    </Item>

    <Item>

      <Id>service_plus_1</Id>

      <Sku>service_plus_1</Sku>

      <Name><![CDATA[PET palack]]></Name>

      <Description><![CDATA[]]></Description>

      <Unit>doboz</Unit>

      <Quantity>2</Quantity>

      <UnitPriceNet>47.6190</UnitPriceNet>

      <UnitPriceGross>50</UnitPriceGross>

      <Vat>5%</Vat>

      <VatPercent>0.05</VatPercent>

    </Item>

    <Item>

      <Id>payment</Id>

      <Sku>payment</Sku>

      <Name><![CDATA[Fizetési kezelési költség]]></Name>

      <Description><![CDATA[Fizetés futárnál]]></Description>

      <Unit>db</Unit>

      <Quantity>1</Quantity>

      <UnitPriceNet>385.83</UnitPriceNet>

      <UnitPriceGross>490</UnitPriceGross>

      <Vat>27%</Vat>

      <VatPercent>0.27</VatPercent>

    </Item>

    <Item>

      <Id>shipping</Id>

      <Sku>shipping</Sku>

      <Name><![CDATA[Szállítási költség]]></Name>

      <Description><![CDATA[GLS futár házhozszállítás]]></Description>

      <Unit>db</Unit>

      <Quantity>1</Quantity>

      <UnitPriceNet>787.40</UnitPriceNet>

      <UnitPriceGross>1000</UnitPriceGross>

      <Vat>27%</Vat>

      <VatPercent>0.27</VatPercent>

    </Item>

    <Item>

      <Id>coupon500</Id>

      <Sku>coupon500</Sku>

      <Name><![CDATA[Kupon]]></Name>

      <Description><![CDATA[500 forint kupon]]></Description>

      <Unit>db</Unit>

      <Quantity>1</Quantity>

      <UnitPriceNet>-393.7008</UnitPriceNet>

      <UnitPriceGross>-500</UnitPriceGross>

      <Vat>27%</Vat>

      <VatPercent>0.27</VatPercent>

    </Item>

    <Item>

      <Id>discount100</Id>

      <Sku>discount100</Sku>

      <Name><![CDATA[Kedvezmény]]></Name>

      <Description><![CDATA[Törzsvásárlói kedvezmény (100 forint)]]></Description>

      <Unit>db</Unit>

      <Quantity>1</Quantity>

      <UnitPriceNet>-78.7401</UnitPriceNet>

      <UnitPriceGross>-100</UnitPriceGross>

      <Vat>27%</Vat>

      <VatPercent>0.27</VatPercent>

    </Item>

  </Items>

</Order>
</Orders>

A <![CDATA[]]> konténer használatára a speciális karakterek átadása miatt van szükség.

Futárszolgálat modul megléte esetén ügyeljünk arra, hogy a CourierService csoport Name mezőjében ugyanolyan néven jöjjön át az adat, ami a programba is rögzítve van Futárszolgálat neveként!

Megrendelések feldolgozása

Az express.ügyvitel Webáruház csoport Webáruház megrendelések menüpontban, a Letöltés webáruházból gombra a program meghívja a webes útvonalon lévő parancsot (ami válaszul a fentiekben látható XML-struktúrát adja vissza) vagy az XML adatfájlt.

Pl.: https://webshop.revol.hu/getOrders.php?key=123456 vagy a helyi XML fájlt.

A beolvasás után a Webáruház megrendelések áttekintőben megjelennek az XML-ből importált megrendelések, melyeket a Feldolgozás gombbal emelhetünk át a Megrendelésekbe.

A feldolgozás folyamata megegyezik a többi webáruházéval, azaz először partner, a fizetési mód, majd árutársítás következik.

Amennyiben Parancsfájl be lett állítva a webáruház paramétereinél, akkor a webáruház a megrendelés feldolgozásakor/elutasításakor meghívja azt, átadja paraméterben a webáruház-kulcsot, a szükséges státuszváltás azonosítóját, és vesszővel elválasztva azoknak a webáruház megrendeléseknek a webáruházbeli azonosítóját, amikre a státuszváltás vonatkozik.

Webáruházas megrendelés státuszok (status kapcsolóval) az alábbiak lehetnek:

0: feldolgozásra vár

1: feldolgozott

2: elutasított

Például amennyiben feldolgozza az ID123456 és ID456789 azonosítójú megrendeléseket, akkor a következő linket hívja meg sikeres feldolgozás után:
https://webshop.revol.hu/setStatus.php?key=123456&status=1&orderid=ID123456,ID456789

amennyiben elutasítja az ID123456 webáruhaz azonosítójú megrendelést, akkor ezt:
https://webshop.revol.hu/setStatus.php?key=123456&status=2&orderid=ID123456

Ezzel a működéssel lehetőséget ad a webáruháznak, hogy módosítsa az adott megrendelések státuszát, így információt közölhet a folyamat állapotáról a webáruház oldalán, illetve szabályozhatja a letöltendő megrendeléseket, hogy a már feldolgozott, vagy elutasított státuszúakat ne generálja bele a megrendelések lekérdezésekor az XML állományba.

Példa a webáruház beállításoknál beírt mezőkre és a generált linkekre:

Kattintson a képre a nagyobb méretben való megtekintéshez!

 

Áruk feltöltése

Az árukat a Webáruház csoporton belül, a Webáruház – áru kapcsolat menüpontban lehet feltölteni a Feltöltés webáruházba gombbal. A megjelenő ablakban válasszuk ki az egyedi webáruházat, jelöljük be a szükséges opciókat, melyek az alábbiak lehetnek:

Csak a kiválasztottak: ha bejelöljük, csak azok az áruk lesznek feltöltve, amiket kiválasztottunk. Több árut a CTRL vagy a SHIFT billentyűk segítségével jelölhetünk ki a Feltöltés webáruházba gomb megnyomása előtt. Ha ez az opció nincs bepipálva, minden társított áru feltöltésre kerül.

Csak a legutóbbi feltöltésük óta módosultak: csak azok az áruk kerülnek feltöltésre, amiben változás történt a legutóbbi feltöltés óta.

Képek nélküli feltöltés: Ha vannak a feltöltendő áruknak képei, azok is feltöltésre kerülhetnek egy „Item” előtaggal, a termék egyedi azonosítójával (Oid, kötőjelek nélkül) és 1-5 sorszámmal, aláhúzásokkal elválasztva (például.: ha az Oid 0583a555-41d7-46a8-b732-15c0fc93ea11, akkor az első kép Item_0583a55541d746a8b73215c0fc93ea11_1 fájlnévvel és a kép kiterjesztésével lesz feltöltve FTP kapcsolaton keresztül.)
Az áruhoz tartozó képeket csak akkor tölti fel a program, ameddig az áru nem lett betársítva egy webáruházas áruval. Miután már érkezett megrendelés az adott árura és betársításra került, akkor már nem töltődik fel a kép a felesleges, nagy adatforgalom elkerülése érdekében.
Ha nem akarjuk a termékképeket feltölteni, akkor ne jelöljük be ezt az opciót! Ekkor csak az árukat tartalmazó XML lesz feltöltve az FTP-re, a képek nem, társítástól függetlenül.

A kiválasztott „Express XML” típusú webáruházba FTP-n keresztül kerülnek feltöltésre az áruk XML formátumban, az előbb megadott paraméterek szerint.

Áru XML minta és leírás

<?xml version="1.0" encoding="UTF-8" ?>

<Items xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <Item>

      <Id>A123456</Id>                                                              <!-- áru azonosítója a webáruházban, ha be van társítva (max 100 hosszú) -->

      <Sku>CSZ001</Sku>                                                              <!-- áru cikkszáma (max 100 hosszú) -->

      <Name><![CDATA[Árvíztűrőtükörfúrógép]]></Name>                                <!-- áru megnevezése (max 200 hosszú) -->

      <Name2><![CDATA[Flood-resistant mirror drilling machine]]></Name2>            <!-- áru megnevezése 2 (max 200 hosszú) -->

      <Name3><![CDATA[Überflutungssichere Spiegelbohrmaschine]]></Name3>            <!-- áru megnevezése 3 (max 200 hosszú) -->

      <Description><![CDATA[Árvíztűrőtükörfúrógép leírása]]></Description>          <!-- áru leírása -->

      <Active>true</Active>                                                          <!-- áru aktív-e (true/false)-->

      <Unit>db</Unit>                                                                <!-- áru mennyiségi egysége (max 50 hosszú) -->

      <MinStock>2</MinStock>                                                        <!-- minimum készlet -->

      <StockQuantity>10</StockQuantity>                                              <!-- aktuális készlet -->

      <Currency>HUF</Currency>                                                      <!-- áru deviza kódja (max 10 hosszú) -->

      <UnitPriceNet>1100.0000</UnitPriceNet>                                        <!-- áru nettó egységára -->

      <UnitPriceGross>1397.0000</UnitPriceGross>                                    <!-- áru bruttó egységára -->

      <UnitPriceNet2>1200.0000</UnitPriceNet2>                                      <!-- áru nettó egységára 2. -->

      <UnitPriceGross2>1524.0000</UnitPriceGross2>                                  <!-- áru bruttó egységára 2. -->

      <UnitPriceNet3>2000.0000</UnitPriceNet3>                                      <!-- áru nettó egységára 3. -->

      <UnitPriceGross3>2540.0000</UnitPriceGross3>                                  <!-- áru bruttó egységára 3. -->

      <Vat>27%</Vat>                                                                <!-- áru áfájának neve (max 100 hosszú) -->

      <VatPercent>0.27</VatPercent>                                                  <!-- áru áfa szorzója (max 4 tizedesjegy) -->

      <ItemGroup1><![CDATA[Kifutó termékek]]></ItemGroup1>                        <!-- áru csoport 1 megnevezése (max 200 hosszú) -->

      <ItemGroup2><![CDATA[Akciós áruk]]></ItemGroup2>                            <!-- áru csoport 2 megnevezése (max 200 hosszú) -->

      <ItemGroup3><![CDATA[Háztartási gépek]]></ItemGroup3>                          <!-- áru csoport 3 megnevezése (max 200 hosszú) -->

      <Image1>Item_0583a55541d746a8b73215c0fc93ea11_1.png</Image1>                  <!-- áru kép 1 fájlnév (max 102 hosszú) -->

      <Image2>Item_0583a55541d746a8b73215c0fc93ea11_2.png</Image2>                  <!-- áru kép 2 fájlnév (max 102 hosszú) -->

      <Image3>Item_0583a55541d746a8b73215c0fc93ea11_3.png</Image3>                  <!-- áru kép 3 fájlnév (max 102 hosszú) -->

      <Image4>Item_0583a55541d746a8b73215c0fc93ea11_4.png</Image4>                  <!-- áru kép 4 fájlnév (max 102 hosszú) -->

      <Image5>Item_0583a55541d746a8b73215c0fc93ea11_5.png</Image5>                  <!-- áru kép 5 fájlnév (max 102 hosszú) -->

      <ExtraData1>csak 1 méteres darabokban</ExtraData1>                            <!-- áru kiegészítő adat 1 (max 200 hosszú) -->

      <ExtraData2>magyar termék</ExtraData2>                                        <!-- áru kiegészítő adat 2 (max 200 hosszú) -->

      <ExtraData3>törékeny</ExtraData3>                                            <!-- áru kiegészítő adat 3 (max 200 hosszú) -->

      <ExtraData4>1 év garancia</ExtraData4>                                        <!-- áru kiegészítő adat 4 (max 200 hosszú) -->

      <ExtraData5>valami fontos infó</ExtraData5>                                    <!-- áru kiegészítő adat 5 (max 200 hosszú) -->

  </Item>

  <Item>

  <!-- a következő áru... -->

  </Item>

</Items>