Ügyviteli rendszer

Tartalomjegyzék

REST API leírás

Utolsó modosítás: 2022.11.17.

Verzió: 2022.7

Módosítás összefoglaló #

Ezen rész áttekintést nyújt a dokumentumban történt változtatásokról.

Verziók

Verzió 2022.7, 2022. november 17.

  • Új paraméterek: CreateOffer, CreateOffer2:
    • Coupon
      Kupon azonosító megadására szolgál.
    • Currency
      Pénznemek 3-karakteres devizakódja.

Verzió 2022.6, 2022. október 14.

  • Új paraméter: GetDocument: DateFrom
    Ha ez meg van adva, akkor azokat a bizonylatokat adja vissza amik a dátumtól kezdve módosítva lettek.

Verzió 2022.5, 2022. október 06.

  • Új eljárás: GetStock2: Visszaadja a készletet, a várható beérkezést és az átfutási időt azoknak a termékeknek, ahol be van pipálva az 2. Honlap mező.
  • Új eljárás: GetStockAvailable: Visszaadja a terméket és a készlet telephelyét azoknak a termékeknek, ahol be van pipálva az 1. Honlap mező és van belőle készleten.
  • Új eljárás: GetStock2Available: Visszaadja a terméket és a készlet telephelyét azoknak a termékeknek, ahol be van pipálva az 2. Honlap mező és van belőle készleten.

Verzió 2022.4, 2022. szeptember 21.

  • Új eljárás: GetProduct3: Visszaadja termékeket, a készletüket és az árukat.

Verzió 2022.3, 2022. augusztus 29.

  • Új eljárás: GetAssignee: Felelősök e-mail címeit lehet vele lekérni jogkörre szűrve.

Verzió 2022.2, 2022. május 16.

  • Új eljárás: DeleteAddress: Meglévő címet lehet vele törölni.

Verzió 2022.1, 2022. február 04.

  • GetAddress eljárásban
    • Új paraméter: default (Alapértelmezett)

Verzió 2021.10, 2021. november 26.

  • GetDocumentDetail eljárásban
    • Új paraméter: optional (Opcionális (csak akkor kerül bele, ha true))

Verzió 2021.9, 2021. november 09.

  • Új eljárás: GetProductCategory: Visszaadja az összes olyan terméket és kategóriáját, ahol be van pipálva az 1. Honlap mező.

Verzió 2021.8, 2021. oktróber 12.

  • GetContact eljárásban
    • Új paraméter: ItemRecipient (Áruátvevő)
  • CreateContact eljárásban
    • Új paraméter: ItemRecipient (Áruátvevő)

Verzió 2021.7, 2021. szeptember 13.

  • CreateOffer eljárásban
    • a rendelésszám mezők pontosítása
    • a megjegyzés mezők pontosítása

Verzió 2021.6, 2021. szeptember 09.

  • GetProduct eljárásban
    • Új paraméter: mainstatus (visszaadja a termék státuszát)
  • CreateOffer eljárásban
    • Új paraméter: OrderNoCustomer (Rendelésszám vevő)
    • Új paraméter: OrderNoSupplier (Rendelésszám szállító)
    • Új paraméter: MainComment (A bizonylat megjegyzése)
  • GetDocument eljárásban
    • Új paraméter: order_no_customer (Rendelésszám vevő)
    • Új paraméter: order_no_supplier (Rendelésszám szállító)
    • Új paraméter: comment (A bizonylat megjegyzése)
  • Új eljárás: GetPackingListPdf: visszaadja egy bizonylat csomagolási lista nyomtatványát PDF formátumban.
  • Új eljárás: OfferToOrder: a megadott ajánlatot rendeléssé származtatja és visszaadja annak az azonosítóját.

Verzió 2021.5, 2021. június 22.

Verzió 2021.4, 2021. június 14.

Verzió 2021.3, 2021. június 10.

  • GetPrice eljárásban (paraméter nélküli hívás)
    • a discount paramétert át lett nevezve installer-re (hibás volt az elnevezés).
    • A paraméter leírása ki lett egészítve: „Alapértelmezetten 0.8. Ennél az értéknél nem adja vissza az interfész ezt a paramétert.”
    • Új paraméter: currency.
    • Az akció új paraméterekkel egészült ki: type, group, stock_sweeping, currency, discount_category, payment_method, store, discount, add.
    • Visszaadja a mennyiség kedvezményeket.
    • A válasz visszaadja a kérés típusát (type).
  • CreateContact eljárásban mind létrehozáskor, mind módosításkor beállítja a kapcsolat Webshop paraméterét igazra.
  • GetContact eljárás csak azokat a kapcsolattartókat adja át, akiknél be van pipálva a Webshop paraméter.
  • GetProduct eljárás
    • kiegészült az itemof tömbbel, amely azokat a szetteket tartalmazza, amelyekbe a termék beépülhet.
    • kiegészült a sizecategory mezővel.
    • a discount_category paraméter a leírásban tévesen kedvkat néven szerepelt.
    • kiegészült a promo_discount_category paraméterrel.
  • GetCustomer eljárásban a contact paraméter mostantól a felelős e-mail címét adja vissza.
  • CreateOffer eljárásban a recipment paraméter nem kötelező.
  • Új eljárás: SetAddress

Verzió 2021.2, 2021. május 17.

  • Új eljárás: GetPrice3 – Árak lekérése (Viszonteladói saját ár)
  • GetCustomer paraméter nélküli hívásának eredményéből hiányzott a status mező. Az eljárás visszaadta, csak a leírásból hiányzott.

Verzió 2021.1, 2021. május 9.

Első verzió.

Eljárások #

GetCustomer – Ügyfél adatok lekérése #

Azon ügyfelek adatait adja vissza, ahol a kapcsolattartónál be van pipálva a 1. honlap mező.

BEMENŐ PARAMÉTEREK
CustomerId Ügyfél azonosítója
Email A weboldalra bejelentkezett felhasználó e-mail címe

A rendszer csak azokat az ügyfeleket adja vissza és be van pipálva a Webshop szerződés mező.

Az eljárásnak három hívási módja van:

  • Nincs paraméter megadva
  • CustomerId van megadva
  • Email van megadva

Nincs paraméter megadva #

Ilyenkor visszaadja az összes ügyfelet.

{
  "result": "ok",
  "customer": [
    {
      "id": "azonosító",
      "name": "név",
      "tax_number": "adószám",
      "direction": "irány",
      "currency": "pénznem",
      "payment_method": "fizetési mód",
      "post_payment": "Nem",
      "status": "ügyfél státusza",
      "discount_category": "kedvezmény kategória",
      "contacts": [
        {
          "name": "Terhes Sándor",
          "email": "gyarmatiterhes@gmail.com"
        }
      ]
    }
  ]
}
KIMENŐ PARAMÉTEREK
id * Ügyfél azonosítója
name * Név
tax_number * Belföldi adószám
direction * Irányultság (Belföld, Export/Import, EU export/Import)
currency * Alapértelmezett pénznem (3 karakteres ISO kód. pl.: HUF, EUR)
payment_method * Fizetési mód (a rendszerben szabadon megadhatók fizetési módok, ezeket az ERP-t használó céggel kell egyeztetni)
post_payment * Utólagos fizetés (igen/nem)
status * Ügyfél státusza (Aktív/Inaktív)
discount_category * Irányultság (Belföld, Export/Import, EU export/Import)
contacts Kapcsolattartók (tömb) Csak azokat a kapcsolattartókat adja vissza, akiknél be van pipálva az 1. honlap mező.
name ** Neve
email E-mail címe

CustomerId van megadva #

Visszaadja az ügyfél egyéb adatait.

Ha nincs ilyen azonosítóval ügyfél, akkor hibát ad:

{
  "result": "error", 
  "message": "Az azonosító (...) nem tartozik egyetlen aktív vevőhöz sem!"
}

Ha talált ügyfelet, akkor az alábbi választ adja:

{
  "result": "ok", 
  "CustomerId": "azonosító",
  "contact": "felelős",
  "limit": "váráslási limit",
  "outstand": "tartozás",
  "overdue": "lejárt tartozás",
  "status": "státusz"
}
KIMENŐ PARAMÉTEREK
CustomerId * Ügyfél azonosítója
contact * Saját cégnél ki a felelőse az ügyfélnek. A felelős e-mail címét adja vissza.
limit * Vásárlási limit. Ennél több tartozása nem lehet. Ha elérte a limitet a tartozása, akkor csak készpénzre vásárolhat a vevő. Ha nincs beállítva, akkor 0.
outstand * Összes tartozás
overdue * Lejárt tartozás
status * Státusz (Aktív, Inaktív)

Email van megadva #

Kikeresi az ügyfelek kapcsolattartói közül az e-mail címet tartalmazókat (ugyanaz az email cím több ügyfélhez is kapcsolódhat).

Az ügyfélnek be kell pipálva lennie a Webshop szerződésnek.
A kapcsolattartónál be kell pipálni az 1. honlap mezőt

Ha nem talál megfelelő kapcsolattartót és ezen keresztül ügyfelet, akkor hibát ad:

{
  "result": "error", 
  "message": "Az e-mail cím (...) nem tartozik egyetlen aktív vevőhöz sem!"
}

Ha csak egyet talál, akkor az eredmény ugyanaz, mintha az ügyfél CustomerId-jével lett volna meghívva az eljárás.

Ha több ügyfél is tartozik a megadott e-mail címhez, akkor az alábbi választ adja:

{
  "result": "ok", 
  "customers": [
    {
      "id": "azonosító",
      "name": "név",
      "status": "státusz"
    }, ...
  ]
}
KIMENŐ PARAMÉTEREK
id * Ügyfél azonosítója
name * Név
status * Státusz

GetCustomer2 – Ügyfél adatok lekérése #

Azon ügyfelek adatait adja vissza, ahol a kapcsolattartónál be van pipálva a 2. honlap mező.

BEMENŐ PARAMÉTEREK
Email * A weboldalra bejelentkezett felhasználó e-mail címe

Ha nem talál megfelelő kapcsolattartót és ezen keresztül ügyfelet, akkor hibát ad:

{
  "result": "error", 
  "message": "Az e-mail cím (...) nem tartozik egyetlen aktív vevőhöz sem!"
}

Ha tartozik ügyfél a megadott e-mail címhez, akkor az alábbi választ adja:

{
  "result": "ok", 
  "customers": [
    {
      "id": "azonosító",
      "name": "név"
    } ...
  ]
} 
KIMENŐ PARAMÉTEREK
id * Ügyfél azonosítója
name * Név

GetAddress – Ügyfél címek lekérése #

Visszaadja az ügyfél számlázási és szállítási címeit.

BEMENŐ PARAMÉTEREK
CustomerId * Ügyfél azonosítója

Válasz:

{
  "result": "ok", 
  "CustomerId": "azonosító",
  "Addresses": [
    {
      "id": "belső azon",
      "default": "alapértelmezett",
      "city": "település",
      "zipcode": "irányítószám",
      "country": "ország",
      "kozterulet": "közterület neve",
      "kozteruletjelleg": "közterület jellege",
      "hazszam": "házszám",
      "epulet": "épület",
      "lepcsohaz": "lépcsőház",
      "emelet": "emelet",
      "ajto": "ajtó",
      "street": "teljes cím",
      "email": "e-mail cím",
      "phone": "telefonszám",
      "recipment": "értesítendő személy",
      "billing": "true",
      "shipping": "true"
    }
  ]
} 
KIMENŐ PARAMÉTEREK
CustomerId * Ügyfél azonosítója
Addresses Címek (tömb)
id ** Rendszeren belüli egyedi azonosító (int)
default Alapértelmezett (true/false)
city ** Település
zipcode Irányítószám
country Ország neve. Magyarország esetén nem kerül bele.
kozterulet Közterület neve
kozteruletjelleg Közterület jellege
hazszam Házszám
epulet Épület
lepcsohaz Lépcsőház
emelet Emelet
ajto Ajtó
street Teljes cím összefűzve
email Címhez tartozó e-mail cím
phone Címhez tartozó telefonszám
recipment Címhez tartozó értesítendő személy
billing ** Számlázási cím (true/false)
shipping ** Szállítási cím (true/false)

SetAddress – Ügyfél cím módosítása #

Meglévő címet lehet vele módosítani. Csak számlázási cím módosítható.

Ha olyan címet módosít, ami egyben számlázási cím is, akkor létre hoz egy új címet szállítási címként és vissza adja az új ID-t. Ha csak az email, phone és recipment paraméterek változnak, akkor nem csinál új címet  hozzá.

Amelyik paraméter hiányzik a hívásból, azt üríti a rendszer a címben.

BEMENŐ PARAMÉTEREK
AddressId * Cím belső azonosítója
city * Település
zipcode Irányítószám
country Ország neve. Magyarország esetén nem kerül bele.
kozterulet Közterület neve
kozteruletjelleg Közterület jellege
hazszam Házszám
epulet Épület
lepcsohaz Lépcsőház
emelet Emelet
ajto Ajtó
email Címhez tartozó e-mail cím
phone Címhez tartozó telefonszám
recipment Címhez tartozó értesítendő személy
default Alapértelmezett (true/false)

Válasz:

{
  "result": "ok", 
  "newid": "új azonosító"
}
KIMENŐ PARAMÉTEREK
newid Rendszeren belüli egyedi azonosító (int), ha új cím jött létre

DeleteAddress – Ügyfél cím törlése #

Meglévő címet lehet vele törölni.

Nem tényleges törlés.
Az ügyfél cím pipálható paramétereit Hamis-ra (false) állítja.

BEMENŐ PARAMÉTEREK
AddressId * Cím belső azonosítója

Válasz:

{
  "result": "ok"
}

GetProduct – Termékek lekérése #

Visszaadja az összes olyan terméket, ahol be van pipálva az 1. Honlap mező.

Bemenő paraméter nincs.

Ha meg van adva kapcsolódó és ajánlott termék, akkor azokat is visszaadja a termékek alatt. Visszaadja továbbá a termék csoport besorolásait is.

Válasz:

{
  "result": "ok", 
  "products": [
    {
      "id": "cikkszám",
      "name": "megnevezés",
      "name2": "rövid név",
      "status": "státusz",
      "mainstatus": "termék státusz",
      "discount_category": "kedvezmény kategória",
      "promo_discount_category": "akciós kedvezmény kategória",
      "warranty": "garanica",
      "forbidpublicprice": "false",
      "onlyrequest": "true",
      "package1": "csomag méret",
      "package2": "karton méret",
      "website2": "true",
      "net1": "nettó súly",
      "gross1": "bruttó súly",
      "net2": "csomag nettó súly",
      "gross2": "csomag bruttó súly",
      "net3": "karton nettó súly",
      "gross3": "karton bruttó súly",
      "sizedcategory": "méret kategória",
      "description": "leírás",
      "recommended": [
        {
          "id": "cikkszám", 
          "priority": "prioritás", 
          ... 
        }
      ], 
      "related": [
        {
          "id": "cikkszám", 
          "priority": "prioritás", 
          ... 
        }
      ],
      "itemof": [
        {
          "id": "cikkszám", 
          "quantity": "mennyiség", 
          ... 
        }
      ],
      "group": [
        {
          "path": ["szint1", "szint2", ...], 
          "main": "true"            
        }...
      ],

    },...
  ]
} 
KIMENŐ PARAMÉTEREK
id * Cikkszám
name * Megnevezés
name2 Rövid név (ha ki van töltve)
status * Termék státusza: Aktív, Kifutó, Tervezett, Értékcsökkentett, Akciós Akkor Akciós, ha van a termékre élő akció.
mainstatus Termék státusza
discount_category Kedvezmény kategória
promo_discount_category Akciós kedvezmény kategória
warranty Garancia (szöveges mező)
forbidpublicprice * Publikus ár tiltás (true/false)
onlyrequest * Csak rendelésre (true/false)
package1 Csomag méret (float)
package2 Karton méret (float)
website2 2. honlap bevan pipálva (true/false, csak true értékkel esetén kerül bele)
net1 Nettó súly (float)
gross1 Bruttó súly (float)
net2 Csomag nettó súly (float)
gross2 Csomag bruttó súly (float)
net3 Karton nettó súly (float)
gross3 Karton bruttó súly (float)
sizecategory Méret kategória (a rendszerben szabadon megadott lista elem)
description Leírás (sortörést tartalmazhat <br>)
recommended Helyettesítő termékek (tömb) (eredetileg ajánlott volt, ezért a megtévesztő név)
id ** Termék cikkszáma
priority Ajánlási prioritás/sorrend (int)
related Kapcsolódó termékek (tömb)
id ** Termék cikkszáma
priority Ajánlási prioritás/sorrend (int)
itemof Milyen szettekbe épül be
id ** Szett cikkszám
quantity ** Beépülési mennyiség
group Csoport (tömb)
path ** Csoport szintek tömbben felsorolva (tömb) Például ["Kábelek","Gyengeáramú kábelek"]
main Elsődleges csoport (csak true értékkel esetén kerül bele)

GetProduct2 – Termékek lekérése #

Visszaadja az összes olyan terméket, ahol be van pipálva az 2. Honlap mező.

Megegyezik a GetProduct eljárással, csak itt a 2. Honlap mezőre szűri a termékeket.

GetProduct3 – Termékek lekérése (készlet, ár) #

Visszaadja termékeket, a készletüket és az árukat.

BEMENŐ PARAMÉTEREK
raktar Raktár azonosító
kategoria Kedvezmény kategória

Ha nincs megadva szűrés, akkor az összes raktár készletét és kedvezmény kategóriás árakat visszaadja.
A paramétereket pontosvesszővel elválasztva kell megadni (példa raktárakra: ‘A-H;A-N;L’)

Válasz:

{
  "result": "ok", 
  "products": [
    {
      "cikkszam": "KJH23456",
      "cikkszam2": "1",
      "pn": "HUF",
      "keszlet": {
        "A-H": 4
      },
      "arak": {
        "listaar": 56400,
        "telepítő": 39480,
        "viszonteladó": 35532,
        "VIP": 35532,
      },
    },...
  ]
}
KIMENŐ PARAMÉTEREK
Products * Termékek (tömb)
cikkszam ** Cikkszám
cikkszam2 2. cikkszám
pn Pénznem
keszlet Készlet (tömb)
[raktár azonosító] Raktár készlet
arak Árak (tömb)
[kedvezmény kategória] Kedvezmény kategóriás ár

GetPrice – Árak lekérése #

Visszaadja azon termékek árait, ahol be van pipálva az 1. Honlap mező.

BEMENŐ PARAMÉTEREK
Email a weboldalra bejelentkezett felhasználó e-mail címe
CustomerId az ügyfél azonosítója
Type lekérés típusa: Full (default), Change

Ha a lekérés típusa Full, akkor visszaadja az összes terméket a szűrésnek megfelelően.
Ha a típus Change, akkor csak azokat adja vissza, amelyeknek legalább az egyik értéke megváltozott az utolsó lekérés óta.

Ha Email és CustomerId paraméterek nélkül hívjuk meg, akkor a cégektől független listaárakat adja vissza.

{
  "result": "ok", 
  "type": "lekérdezés típusa",
  "products": [
    {
      "id": "C1",
      "price": "listaar",
      "installer": "telepítői százalék",
      "currency": "HUF",
      "action": [
        {
          "type": "price", 
          "end_date": "akció vége dátum", 
          "end_time": "akció vége idő", 
          "stock_sweeping": "Igen", 
          "price": "akciós ár", 
          "currency": "HUF"            
        }, ...
      ], 
      "discount: [
        {
          "quantity: "mennyiség, 
          "price: "ár"
        }, ...
      ]
    }, ...
  ]
} 
KIMENŐ PARAMÉTEREK
type * Lekérdezés típusa (full, change)
id * Cikkszám
price * Listaár (ha az ION-ban az Beállítások/API-nál meg van adva egy ügyfél a klienshez, akkor annak az ügyfélnek az ára)
installer Telepítői százalék (tört számként visszaadva pl.: 0,7) Alapértelmezetten 0,8. Ennél az értéknél nem adja vissza az interfész ezt a paramétert.
currency * Pénznem (pl.: HUF)
action Akció (tömb)
type ** Akció típus price: új alapár van megadva discount: kedvezmény százalék van megadva
end_date ** Akció vége dátum (YYYY.MM.DD)
end_time Akció vége idő (HH.NN) Csak akkor rakja bele, ha ki van töltve.
stock_sweeping Készletkisöprés. (csak Igen esetén szerepel az válaszban)
price *** Akciós ár
currency *** Pénznem (pl.: HUF)
discount_category Kedvezmény kategória
group Csoport szintek tömbben felsorolva (tömb) Például ["Kábelek","Gyengeáramú kábelek"] Az akció időtartamára bekerül a termék ebbe a csoportba.
payment_method Fizetési mód
store Raktár
discount *** Kedvezmény %
add *** (igen/nem) Ha igaz, akkor a kedvezményt a normál kedvezményhez hozzá kell adni, különben felül kell azt írni. Az akciós kedvezmény és az ügyfél normál kedvezménye közül mindig a nagyobb az érvényes.
discount Mennyiségi kedvezmény (tömb)
quantity ** Minimum mennyiség
price ** Minimum mennyiség

*** Az akció típusától függ, hogy kötelező-e.

Ha az Email paraméter meg van adva, akkor az ION kikeresi a kapcsolattartók között az e-mail címet és társítja egy céghez.

Ha egyetlen céghez sem tartozik az e-mail cím, akkor hibát ad:
A e-mail cím (…) nem tartozik egyetlen aktív vevőhöz sem!

Ha több céghez is hozzá van rendelve az e-mail cím, akkor visszaadja a választható cégeket.

{
  "result": "ok", 
  "customers": [
    {
      "id": "U1",
      "name": "Cég1",
      "notpricelisteligible": "True"
    },
    {
      "id": "U2",
      "name": "Cég2",
      "notpricelisteligible": "False"
    },
    ...
  ]
} 
KIMENŐ PARAMÉTEREK
id * ügyfél azonosítója
name * ügyfél neve
notpricelisteligible * árlista tiltása (ION nem használja)

Ilyenkor újra meg kell hívni az eljárást, de már a kiválasztott cég azonosítójával (az e­mail címet nem kell megadni).

Visszaadja a cég azonosítóját és nevét és minden aktív illetve kifutó termékhez vissza adja az ügyfélhez tartozó árat.

{
  "result": "ok", 
  "type": "lekérdezés típusa", 
  "customers": 
    {
      "id": "U1",
      "name": "Cég1",
      "notpricelisteligible": "True"
    },
  "products":[termékek]
} 
KIMENŐ PARAMÉTEREK
type * Lekérdezés típusa (full, change)
customer * Ügyfél adatok
id * Azonosítója
name * Neve
notpricelisteligible * Árlista tiltva (true/false)
products * Termékek Tartalma megegyezik azzal, mint amikor ügyfél nélküli a lekérés

GetPrice2 – Árak lekérése #

Visszaadja azon termékek árait, ahol be van pipálva az 1. Honlap mező.

Megegyezik a GetPrice eljárással, csak itt a 2. Honlap mezőre szűri a termékeket.

GetPrice3 – Árak lekérése (Viszonteladó saját ár) #

Visszaadja az aktív termékek árait és az API-hoz rendelt ügyfél árát.
Bemenő paraméter nincs.

Ha az API-nál nincs megadva ügyfél kód, akkor hibát ad:

{
  "result": "error", 
  "message": "Az API nincs ügyfélhez rendelve!"
}

Ha a megadott ügyfél kód nem tartozik egy aktív ügyfélhez sem, akkor hibát ad:

{
  "result": "error", 
  "message": "Az azonosító (...) nem tartozik egyetlen aktív vevőhöz sem!"
}

Válasz:

{
  "result": "ok", 
  "products": [ 
    {
      "id": "C1",
      "price": "listaár",
      "ownprice": "ügyfél ár",
      "installerprice": "telepítői ár"
    }, ...
  ]
} 
KIMENŐ PARAMÉTEREK
id * Cikkszám
price * Listaár
ownprice * Ügyfél ár
installerprice * Telepítői ár

GetCustomPrice – Egyedi árak és kedvezmények #

Visszaadja az ügyfelekhez tartozó egyedi kedvezményeket és egyedi árakat.

Bemenő paraméter nincs.

Válasz:

{
  "result": "ok", 
  "categories": [ 
    {
      "id": "kategória azonosító",
      "name": "kategória név"
    }, ...
  ],
  "customers": [ 
    {
      "id": "ügyfél azonosító"
      "discount": [
        { 
          "discount": "kedvezmény",
          "categories": [
            56,
            57,
            ...
          ],
          "product": "termék azonosító",
          "payment_method": "fizetési mód",
          "end_date": "vége dátum",
          "end_time": "vége idő"
        }, 
        ...     
     ],
     "price": [
       {
         "price": "listaár",
         "currency": "pénznem",
         "product": "termék azonosító",
         "group": ["szint1", "szint2", ...],
         "work": "munkaszám",
         "workquantity": "munkaszám mennyiség",
         "unit": "mértékegység",
         "end_date": "vége dátum",
         "end_time": "vége idő"
       },
       ...
      ]         
    },...
  ],
} 
KIMENŐ PARAMÉTEREK
Categories Kedvezmény kategóriák (tömb)
id * Kategória azonosítója
name * Kategória neve
id * Ügyfél azonosítója
discount Egyedi kedvezmény (tömb)
categories *** Kedvezmény %-hoz tartozó Kedvezmény kategória azonosítók (tömb)
product *** Termék azonosító
payment_method *** Fizetési mód
discount ** Kedvezmény %
end_date Vége dátum (YYYY.MM.DD)
end_time Vége idő (HH.NN)
price Egyedi ár (tömb)
product *** Termék azonosító
group *** Csoport szintek tömbben felsorolva (tömb) Például ["Kábelek","Gyengeáramú kábelek"]
work Munkaszám
workquantity Munkaszám mennyiség
unit ** Mértékegység
price ** Kedvezményes ár
currency ** Pénznem (3 karakteres ISO kód. pl.: HUF, EUR)
end_date Vége dátum (YYYY.MM.DD)
end_time Vége idő (HH.NN)

A discount-on és a price-on belül a *** mezők közül az egyik mindig ki van töltve.

Ha az end_date paraméter üres, akkor nincs lejárata az egyedi kedvezménynek illetve árnak.

CreateOffer – Ajánlat létrehozása #

Rögzít egy ajánlatot a rendszerben webshop munkaszámmal.

BEMENŐ PARAMÉTEREK
CustomerId * Ügyfél azonosítója
Recipment Értesítendő személy az ügyfélnél
Phone Értesítési telefonszám
DataOfReceipt Átvétel dátuma. Ha a szállítási mód Személyes, akkor a bizonylat teljesítését beállítja erre az dátumra.
ShippingMode * Szállítási mód
Payment * Fizetési mód
1) megadás típussal: Átutalás, Készpénz, Bankkártya, Utánvét, Paypal
2) megadás fizetési mód névvel.
Ha típussal van megadva, akkor átutalás esetén 8 napra, egyéb esteben 0 napra állítja a fizetési határidőt és így keres egy fizetési módot. Ha nem találja a megadott fizetési módot, akkor hibát ad: Ismeretlen fizetés típus (...)!
Store * Raktár (Törzsadatok/Raktár ablakon megadott Webshop azonosító)
Comment Weboldalon megadott megjegyzés (levágja 400 karakterre) A bizonylat aljára kerül, több soros lehet.
Return Visszáru (true/false, default: false)
Parity Fuvarparitás
OrderNo Rendelésszám (régi paraméter, ki lesz vezetve)
BillAuto True esetén a rendszer automatikusan választ számlázási címet (true/false, default: false)
BillId A cím ID-je (GetAddress által visszaadott id)
BillZipcode Számlázás cím irányítószáma
BillCity Számlázás cím település
BillStreet Számlázás cím utca, házszám
BillCountry Számlázás cím ország (ha nincs megadva, akkor Magyarország)
BillKozterulet
BillKozteruletjelleg
BillHazszam
BillEpulet
BillLepcsohaz
BillEmelet
BillAjto
ShipAuto True esetén a rendszer automatikusan választ szállítási címet (true/false, default: false)
ShipId A cím ID-je (GetAddress által visszaadott id)
ShipZipcode Számlázás cím irányítószáma
ShipCity Számlázás cím település
ShipStreet Számlázás cím utca, házszám
ShipCountry Számlázás cím ország (ha nincs megadva, akkor Magyarország)
ShipKozterulet
ShipKozteruletjelleg
ShipHazszam
ShipEpulet
ShipLepcsohaz
ShipEmelet
ShipAjto
OrderNoCustomer   Vevői rendelésszám
OrderNoSupplier   Szállítói rendelésszám (ha üres, akkor értékül kapja az OrderNo paraméter értékét.
HeadComment   A bizonylat fejlécébe kerülő megjegyzés.
Coupon   Kupon azonosító
Currency   Pénznemek 3-karakteres devizakódja. Ha nincs megadva, akkor az ügyféltől van kinyerve.
P[x] * Termék azonosító, ahol az [x] egy futó sorszám 1-től
M[x] * Termékhez tartozó mennyisség, ahol az [x] egy futó sorszám 1-től

Az így létrehozott bizonylatok kapnak egy webshop munkaszámot és az Értékesítés/1. webshop menüpont alatt találhatók meg.

Ha olyan szállítási címet kap, ami még nem létezik, akkor azt létrehozza.

Az ügyfél rendszeren belüli felelősének küld egy e-malit Új rendelés érkezett – bizonylatszám tárggyal.

Az alábbi adatok a bizonylat megjegyzésébe kerülnek:

  • Comment – Webshop-ban megadott megjegyzés
  • ShippingMode – Szállítási mód
  • DateOfReceipt – Átvétel időpontja
  • Phone – Telefonszám
  • Recipment – Értesítendő személy
  • Ship… – Szállítási cím

Címek kezelése

Ha a BillAuto illetve ShipAuto mezőkben true szerepel, akkor további cím mező megadására nincs szükség.

Egyébként mindkét cím típusra igaz, hogy vagy az Id-t kötelező megadni vagy az egyéb cím adatokat. Az egyéb adatoknál a kötelezőség értelem szerű. A rendszer az ION-ban megadott címekből kikeresi az Id-t vagy annak hiányában az egyéb adatok alapján a címet.

Számlázási cím csak a rendszerben előzetesen felvitt cím lehet.

Ha eddig ismeretlen szállítási címet adtak meg, akkor azt létrehozza a rendszer egy Webshop-ról megjegyzéssel.

A címben kötelező mezők azok, amik a Nav szerint kötelezőek:

  • Magyar cím esetén (tehát, ha a BillCountry, ShipCountry = Magyarország vagy üres) kötelező az irányítószám, település, közterület neve és jellege.
  • Külföldi cím esetén kötelező a település és a közterület neve (ilyenkor ide kell az egész cím).

A közterület jellegben elfogadott értékek lekérdezhetők a GetKozterulet függvénnyel.

Válasz:

{
  "result": "ok", 
  "offerid": "bizonylatszam"
}
KIMENŐ PARAMÉTEREK
offerid * Létrehozott ajánlat bizonylatszáma

Hibaüzenetek:

  • A CreateOffer eljárás kötelező paraméterei …!
  • Az azonosító (…) nem tartozik egyetlen aktív vevőhöz sem!
  • Az raktár kód (…) nem tartozik egyetlen raktárhoz sem!
  • Legalább egy termék megadása kötelező!
  • Hibás számlázási cím!
  • Hibás szállítási cím!
  • Ismeretlen fizetés típus (…) (1)!
  • Termék nem létezik (P01)!
  • Mennyiség megadása kötelező (P01)!
  • A mennyiségnek pozitívnak kell lennie (P01)!
  • A megadott kupon 1) nem létezik, 2) már felhasználták, 3) lejárt!

CreateOffer2 – Ajánlat létrehozása #

Rögzít egy ajánlatot a rendszerben webshop2 munkaszámmal.

Megegyezik a CreateOffer eljárással, csak itt a webshop2 munkaszámot állítja be.

  • webshop2 munkaszámot állítja be
  • Két plusz bemenő paraméte

GetStock – Készlet lekérése ( webshop 1 ) #

Visszaadja a készletet, a várható beérkezést és az átfutási időt azoknak a termékeknek, ahol be van pipálva az 1. Honlap mező.

Csak azokat a termékeket adja vissza, ahol alábbi feltételek közül legalább az egyik teljesül:

  • van készlet
  • van várható érkezési idő
  • van átfutási idő

Bemenő paraméter nincs.

Válasz:

{
  "result": "ok", 
  "stock": [ 
    {
      "id": "cikkszám",
      "set": "true",
      "location": "telephely",
      "stock": "készlet",
      "arrival": "várható érkezés (YYYY.MM.DD)",
      "transittime": "átuftási idő",
      "unit": "mértékegység",
      "unavailableat": "nem elérhető (YYYY.MM.DD)"
    }, ...
  ]
} 
KIMENŐ PARAMÉTEREK
id * Cikkszám
set A termék szett (true/false, csak true értékkel esetén kerül bele)
location * Telephely
stock * Készlet (float)
arrival Várható érkezés (date) (YYYY.MM.DD)
transittime Átfutási idő (int)
unit Mértékegység
unavailableat Meddig nem elérhető (date) (YYYY.MM.DD)

GetStock2 – Készlet lekérése #

Visszaadja a készletet, a várható beérkezést és az átfutási időt azoknak a termékeknek, ahol be van pipálva az 2. Honlap mező.

Megegyezik a GetStock eljárással, csak itt a 2. Honlap mezőre szűri a termékeket.

GetStockAvailable – Készlet elérhetőség lekérése ( webshop 1 ) #

Visszaadja a terméket és a készlet telephelyét azoknak a termékeknek, ahol be van pipálva az 1. Honlap mező és van belőle készleten.

Szettek esetén visszadjuk a készlet értékét is

Bemenő paraméter nincs.

Válasz:

{
  "result": "ok", 
  "stock": [ 
    {
      "id": "cikkszám",
      "set": "true",
      "location": "telephely",
      "stock": "készlet"
    }, 
    {
      "id": "cikkszám", 
      "location": "telephely"
    }...
  ]
} 
KIMENŐ PARAMÉTEREK
id * Cikkszám
set A termék szett (true/false, csak true értékkel esetén kerül bele)
location * Telephely
stock Készlet (float)

GetStock2Available – Készlet elérhetőség lekérése ( webshop 2 ) #

Visszaadja a terméket és a készlet telephelyét azoknak a termékeknek, ahol be van pipálva az 2. Honlap mező és van belőle készleten.

Megegyezik a GetStockAvailable eljárással, csak itt a 2. Honlap mezőre szűri a termékeket.

GetStock2 – Készlet lekérése #

Visszaadja a készletet, a várható beérkezést és az átfutási időt azoknak a termékeknek, ahol be van pipálva az 2. Honlap mező.

Megegyezik a GetStock eljárással, csak itt a 2. Honlap mezőre szűri a termékeket.

Beállítja a termék webcímét.

BEMENŐ PARAMÉTEREK
Product * Termék cikkszám
Url Weboldal alcíme

Az ION kikeresi a cikkszám alapján a terméket és beállítja a weblink értékét.

A weblinkeknek meg lehet adni egységesen az elejét a Beállítások/Paraméterek ablakon a Termékek/Weblink mezőben (például http://www.ceg.hu/termekek/).

Ebben az eljárásban csak az előbbi módon megadott url után részt kell átadni.

Válasz:

{
  "result": "ok"
}

GetKozterulet – Közterület jellegek lekérése #

Visszaadja a választható közterület jellegeket (utca, út stb.).

Bemenő paraméter nincs.

Válasz:

{
  "result": "ok", 
  "kozterulet": [ 
    {
      "name": "akna"
    },
    {
      "name": "akna-alsó"
    }, ...
  ]
} 
KIMENŐ PARAMÉTEREK
name * Közterület jellege

GetParam – Termék jellemző típusok #

Visszaadja a jellemzők típusokait.
Nincs bemenő paramétere.

Válasz:

{
  "result": "ok", 
  "params": [ 
    {
      "name": "név",
      "datatype": "típus",
      "unit": "mértékegység",
      "closed": "zárt",
      "hidden": "rejtett",
      "order": "sorrend",
      "shortname": "rövidnév",
      "items": ["egy", "egy", ...]
    }, ...
  ]
} 
KIMENŐ PARAMÉTEREK
name * Jellemző neve
datatype * Jellemző típusa (char, number, list, boolean)
unit Mértékegység (csak number típus esetén)
closed * Zárt (true/false)
hidden * Rejtett (true/false)
order Sorrend
shortname Rövid név
items List típus esetén a választható értékek listája

GetProductParam – Termék jellemzők #

Visszaadja azon termékek jellemzőit, ahol be van pipálva az 1. Honlap mező.

Nincs bemenő paramétere.

Válasz:

{
  "result": "ok",
  "productparam": [ 
    {
      "id": "ügyfél azonosító"
      "param": [
        { 
          "név1": "érték1",
          "név2": "érték2",
          ...
        }, 
        ...     
      ]       
    }, ...
  ]
} 
KIMENŐ PARAMÉTEREK
id * Cikkszám
param Jellemzők (tömb)
nev: ertek Típus neve: jellemző értéke
A típus nevek a GetParam eljárással kérhetők le.

GetBarcode – Termék vonalkódok #

Visszaadja a termékekhez tartozó vonalkódokat.
Egy termékhez több vonalkód is tartozhat.
Nincs bemenő paramétere.

Válasz:

{
  "result": "ok", 
  "barcodes": [ 
    {
      "id": "cikkszám",
      "barcode": "vonalkód",
      "quantity": "mennyiség",
      "unit": "mértékegység"
    }, ...
  ]
} 
KIMENŐ PARAMÉTEREK
id * Cikkszám
barcode * Vonalkód
quantity * A vonalkódhoz tartozó mennyiség (gyűjtő vonalkódoknál nagyobb egynél)
unit * Mértékegység. Alapból megegyezik a termék mértékegységével, de gyűjtő vonalkódoknál eltér (például zsugor, rekesz)

CreateContact – Ügyfél kapcsolattartó #

Ügyfelekhez tartozó kapcsolattartókat lehet létrehozni illetve módosítani.

BEMENŐ PARAMÉTEREK
CustomerId * Ügyfél azonosítója
Name Kapcsolattartó neve
Mobile Telefonszám
Email * E-mail cím
EligibleForPurchase Vásárlásra jogosult (true/false default false)
Primary Elsődleges kapcsolattartó (true/false default false)
InvoiceMail E-mail küldés számláról (true/false default false)
DeliveryMail E-mail küldés szállítóról (true/false default false)
ServiceMail E-mail küldés szervizről (true/false default false)
PurchaseMail E-mail küldés beszerzésről (true/false default false)
AutoQuotationMail Automatikus ajánlat küldés (true/false default false)
OrderConfirmMail E-mail küldés rendelés visszaigazolásról (true/false default false)
ItemRecipient   Áruátvevő (true/false default false)

Ha a rendszerben az adott ügyfélnek már szerepel a megadott e-mail címmel kapcsolattartója, akkor módosítja az adatait. Egyéb esetben létrehozza azt.

Új kapcsolattartó létrehozáskor kötelező megadni a kapcsolattartó nevét.
Ha valamelyik nem kötelező paraméter nem szerepel a hívásban, akkor azt nem módosítja.

Mind létrehozáskor, mind módosításkor beállítja a kapcsolat Webshop paraméterét igazra.

Válasz:

{
  "result": "ok"
}

DeleteContact – Ügyfél kapcsolattartó törlése #

Ügyfelekhez tartozó kapcsolattartó törlése.

BEMENŐ PARAMÉTEREK
CustomerId * Ügyfél azonosítója
Name Kapcsolattartó neve
Email E-mail cím

A Name és Email paraméterek közül az egyik megadása kötelező! Elsődlegesen az e-mail címmel keres.

Válasz:

{
  "result": "ok"
}

GetContact – Ügyfél kapcsolattartóinak lekérdezése #

Ügyfelekhez tartozó kapcsolattartó lekérdezése.

BEMENŐ PARAMÉTEREK
CustomerId * Ügyfél azonosítója
Name Kapcsolattartó neve
Email E-mail cím

Ha csak CustomerId paraméter van átadva, akkor visszaadja az ügyfélhez tartozó összes kapcsolattartó adatait.
Egyéb esetben csak a szűrésnek megfelelő kapcsolattartót adja vissza.

Csak azokat a kapcsolattartókat adja át, akiknél be van pipálva a Webshop paraméter.

Válasz: 

{
  "result": "ok", 
  "CustomerId": "azonosító", 
  "contacts": [ 
    {
      "Name": "név",
      "Mobile": "06301111111",
      "Email": "minta@email.com",
      "EligibleForPurchase": "Igen",
      "Primary": "Nem",
      "InvoiceMail": "Igen",
      "DeliveryMail": "Nem",
      "ServiceMail": "Nem",
      "PurchaseMail": "Nem",
      "AutoQuotationMail": "Igen",
      "OrderConfirMail": "Igen",
      "ItemRecipient": "Igen"
    }, ...
  ]
} 
KIMENŐ PARAMÉTEREK
CustomerId * Ügyfél azonosítója
Contacts Kapcsolattartók (tömb)
Name * Kapcsolattartó neve
Mobile Telefonszám
Email * E-mail cím
EligibleForPurchase * Vásárlásra jogosult (Igen/Nem alapértelmezett: Nem)
Primary * Elsődleges kapcsolattartó (Igen/Nem alapértelmezett: Nem)
InvoiceMail * E-mail küldés számláról (Igen/Nem alapértelmezett: Nem)
DeliveryMail * E-mail küldés szállítóról (Igen/Nem alapértelmezett: Nem)
ServiceMail * E-mail küldés szervizről (Igen/Nem alapértelmezett: Nem)
PurchaseMail * E-mail küldés beszerzésről (Igen/Nem alapértelmezett: Nem)
AutoQuotationMail * Automatikus ajánlat küldés (Igen/Nem alapértelmezett: Nem)
OrderConfirmMail * E-mail küldés rendelés visszaigazolásról (Igen/Nem alapértelmezett: Nem)
ItemRecipient * Áruátvevő (Igen/Nem alapértelmezett: Nem)

GetDiscount – Ügyfél kedvezmények lekérése #

Visszaadja az ügyfelekhez és az egyes kedvezményekhez tartozó kedvezmény kategóriákat. Csak azokat a vevőket adja vissza, akiknél be van pipálva az 1. honlap.
Nincs bemenő paraméter.

Először visszaadja a kategóriákat (Categories).
Utána visszaadja az egyes ügyfeleket (Customers), azon belül az egyes kedvezmény százalékokat (value) és a hozzá tartozó kategóriák id-it (categories).

Válasz:

{
  "result": "ok", 
  "categories": [ 
    {
      "id": "kategória azonosító",
      "name": "kategória név"
    }, ...
  ],
  "customers": [ 
    {
      "id": "ügyfél azonosító"
      "discount": [
        { 
          "value": 0,
          "categories": [
            53
          ]
        },
        { 
          "value": 17,
          "categories": [
            56,
            57,
            38,
            44,
            85,
            86,
            95,
            116
          ]
        }, 
        ...     
     ]        
    },...
  ]
} 
KIMENŐ PARAMÉTEREK
Categories Kedvezmény kategóriák (tömb)
id * Kategória azonosítója
name * Kategória neve
Customers Ügyfelek (tömb)
id * Ügyfél azonosító
discounts Kedvezmények (tömb)
value * Kedvezmény %
categories * Kedvezmény %-hoz tartozó Kedvezmény kategória azonosítók (tömb)

GetDocument – Bizonylatok lekérése #

Visszaadja egy ügyfél bizonylatait. Az aktív ajánlatokat (ha végleges) és rendeléseket, továbbá a lezárt szállító leveleket és számlákat.

BEMENŐ PARAMÉTEREK
CustomerId * Ügyfél azonosítója
DateFrom Dátumtól ( YYYY.MM.DD vagy YYYY.MM.DD HH:NN:SS )
Type Bizonylat típus (quotation, order, deliverynote, invoice)
  • quotation: ajánlat
  • order: rendelés
  • deliverynote: szállítólevél
  • invoice: számla

Ha a DateFrom paraméter meg van adva, akkor azokat a bizonylatokat adja vissza, amik a dátumtól kezdve módosítva lettek.
Ha nincs dátum paraméter, akkor az elmúlt 3 hónap bizonylatait adja vissza.
Ha meg van adva, akkor is legfeljebb az elmúlt egy év adatait adja vissza.

Válasz: 

{
  "result": "ok", 
  "CustomerId": "azonosító", 
  "documents": [ 
    {
      "id": "azonosító",
      "number": "bizonylatszám",
      "type": "bizonylatok típusa",
      "dated": "kelt",
      ...
    }, ...
  ]
} 
KIMENŐ PARAMÉTEREK
id * Azonosító (szám)
number * Bizonylatszám
type * Bizonylat típus (quotation, order, deliverynote, invoice)
character * Jelleg (Normál, Sztornó, Helyesbítő, Sztornózott, Helyesbített)
dated * Kelt
date_of_delivery o, d Teljesítés
quotation_valid_until q Ajánlat érvényes
payment_due_date i Fizetési határidő
warehouse * Raktár
net * Nettó
payable * Fizetendő
derived q, o, d Származtatott (Igen, Nem, Részben)
debt i Tartozás
currency * Pénznem (HUF, EUR…)
payment_method * Fizetési mód
order_no_customer   Rendelésszám vevő
order_no_supplier   Rendelésszám szállító
comment   A bizonylat megjegyzése

A bizonylat típusok kezdőbetűjével van jelölve (q, o, d, i), hogy melyik paraméter melyik típusnál szerepel. A *-os paraméterek mindegyik típusnál léteznek.

GetDocumentDetail – Bizonylat tételek lekérése #

Visszaadja egy bizonylat tételeit.

BEMENŐ PARAMÉTEREK
id * Bizonylat azonosító

Válasz:

{
  "result": "ok", 
  "id": "azonosító", 
  "details": [ 
    {
      "number": "sorszám",
      "id": "cikkszám",
      "name": "megnevezés",
      "quantity": "mennyiség",
      "open": "nyitott mennyiség",
      "reserved": "foglalt mennyiség",
      "unit": "mértékegység",
      "price": "nettó egységár",
      "net": "nettó összesen",
      "status": "státusz",
      "arrival": "várható érkezés"
      "optional": "true"
    }, ...
  ]
} 
KIMENŐ PARAMÉTEREK
number * Sorszám
id * Cikkszám
name * Megnevezés
quantity * Mennyiség
open q, o, d quotation: Nyitott mennyiség
order: Nem teljesített mennyiség,
delivery: Rendezetlen mennyiség
reserved o Foglalt mennyiség
unit * Mértékegység
price * Nettó egységár
net * Nettó összesen
status o Tétel státusza (Foglalt, Hiányos)
arrival o Várható beérkezés (YYYY.MM.DD)
optional Opcionális (csak akkor kerül bele, ha true)

GetDocumentPdf – Bizonylathoz tartozó pdf #

Visszaadja egy bizonylat nyomtatványát PDF formátumban.

BEMENŐ PARAMÉTEREK
id * Bizonylat azonosító

Válasz:

{
  "result": "ok", 
  "id": "azonosító",
  "pdf": "base64"
}
KIMENŐ PARAMÉTEREK
id * Bizonylat azonosító
pdf * Bizonylat adatfolyam base64-re kódolva

GetPackingListPdf – Bizonylathoz tartozó csomagolási lista PDF #

Visszaadja egy bizonylat csomagolási lista nyomtatványát PDF formátumban.

BEMENŐ PARAMÉTEREK
id * Bizonylat azonosító

Válasz:

{
  "result": "ok", 
  "id": "azonosító",
  "pdf": "base64"
}
KIMENŐ PARAMÉTEREK
id * Bizonylat azonosító
pdf * Csomagolási lista adatfolyam base64-re kódolva

OfferToOrder – Ajánlat rendeléssé származtatása #

A megadott ajánlatot rendeléssé származtatja és visszaadja annak az azonosítóját.

BEMENŐ PARAMÉTEREK
id * Bizonylat azonosító

Válasz:

{
  "result": "ok", 
  "id": "azonosító",
  "newid": "új azonosító"
}
KIMENŐ PARAMÉTEREK
id * Az ajánlat azonosítója
newid * A rendelés azonosítója

GetProductCategory – Termék kategóriák lekérése #

Visszaadja az összes olyan terméket és kategóriáját, ahol be van pipálva az 1. Honlap mező.

Bemenő paraméter nincs.

Válasz:

{
  "result": "ok", 
  "products": [
    {
      "id": "cikkszám",  
      "name": "megnevezés",
      "name2": "rövid név",
      "status": "státusz",
      "group": [
        {
          "path": ["szint1", "szint2", ...], 
          "main": "true"            
        }...
      ],

    },...
  ]
} 
KIMENŐ PARAMÉTEREK
id * Cikkszám
name * Megnevezés
name2 Rövid név (ha ki van töltve)
status * Termék státusza: Aktív, Kifutó, Tervezett, Értékcsökkentett, Akciós Akkor Akciós, ha van a termékre élő akció.
group Csoport (tömb)
path ** Csoport szintek tömbben felsorolva (tömb) Például ["Kábelek","Gyengeáramú kábelek"]
main Elsődleges csoport (csak true értékkel esetén kerül bele)

GetAssignee – Felelősök lekérése #

Visszaadja a felelősöket a szűrésnek megfelelően.
Ha nincs megadva szűrés, akkor az összes felelőst visszaadja.

BEMENŐ PARAMÉTEREK
Authority Jogkör

Válasz, jogkör megadása esetén:

{
  "result": "ok", 
  "Authority": "jogkör",
  "Assignees": [
    {
      "name": "felelős neve",
      "email": "minta@email.hu" 
  ]
}

Válasz, jogkör megadása nélkül:

{
  "result": "ok", 
  "Assignees": [
    {
      "name": "felelős neve",
      "email": "minta@email.hu",
      "authority": "jogkörök"
  ]
}
KIMENŐ PARAMÉTEREK
Authority Jogkör szűrés
Assignees * Felelősök (tömb)
name ** Felelős neve
email Felelős e-mail címe
authority Jogkörök

REST API leírás

.so-widget-sow-headline-default-778c347719e3 .sow-headline-container p.sow-headline { font-family: Raleway; font-weight: 400; text-align: left; color: #424242; line-height: 1.4em; font-size: 20px; } @media (max-width: 780px) { .so-widget-sow-headline-default-778c347719e3 .sow-headline-container p.sow-headline { text-align: left; } } .so-widget-sow-headline-default-778c347719e3 .sow-headline-container p.sow-headline a { color: #424242; } .so-widget-sow-headline-default-778c347719e3 .sow-headline-container h3.sow-sub-headline { text-align: center; line-height: 1.4em; } @media (max-width: 780px) { .so-widget-sow-headline-default-778c347719e3 .sow-headline-container h3.sow-sub-headline { text-align: center; } } .so-widget-sow-headline-default-778c347719e3 .sow-headline-container .decoration { line-height: 0em; text-align: center; margin-top: 20px; margin-bottom: 20px; } @media (max-width: 780px) { .so-widget-sow-headline-default-778c347719e3 .sow-headline-container .decoration { text-align: center; } } .so-widget-sow-headline-default-778c347719e3 .sow-headline-container .decoration .decoration-inside { height: 1px; display: inline-block; border-top: 1px none #eeeeee; width: 100%; max-width: 80%; } .so-widget-sow-headline-default-778c347719e3 .sow-headline-container *:first-child { margin-top: 0 !important; } .so-widget-sow-headline-default-778c347719e3 .sow-headline-container *:last-child { margin-bottom: 0 !important; }

Utolsó modosítás: 2022.11.17.

Verzió: 2022.7

Módosítás összefoglaló

Ezen rész áttekintést nyújt a dokumentumban történt változtatásokról.

Verziók

Verzió 2022.7, 2022. november 17.

  • Új paraméterek: CreateOffer, CreateOffer2:
    • Coupon
      Kupon azonosító megadására szolgál.
    • Currency
      Pénznemek 3-karakteres devizakódja.

Verzió 2022.6, 2022. október 14.

  • Új paraméter: GetDocument: DateFrom
    Ha ez meg van adva, akkor azokat a bizonylatokat adja vissza amik a dátumtól kezdve módosítva lettek.

Verzió 2022.5, 2022. október 06.

  • Új eljárás: GetStock2: Visszaadja a készletet, a várható beérkezést és az átfutási időt azoknak a termékeknek, ahol be van pipálva az 2. Honlap mező.
  • Új eljárás: GetStockAvailable: Visszaadja a terméket és a készlet telephelyét azoknak a termékeknek, ahol be van pipálva az 1. Honlap mező és van belőle készleten.
  • Új eljárás: GetStock2Available: Visszaadja a terméket és a készlet telephelyét azoknak a termékeknek, ahol be van pipálva az 2. Honlap mező és van belőle készleten.

Verzió 2022.4, 2022. szeptember 21.

  • Új eljárás: GetProduct3: Visszaadja termékeket, a készletüket és az árukat.

Verzió 2022.3, 2022. augusztus 29.

  • Új eljárás: GetAssignee: Felelősök e-mail címeit lehet vele lekérni jogkörre szűrve.

Verzió 2022.2, 2022. május 16.

  • Új eljárás: DeleteAddress: Meglévő címet lehet vele törölni.

Verzió 2022.1, 2022. február 04.

  • GetAddress eljárásban
    • Új paraméter: default (Alapértelmezett)

Verzió 2021.10, 2021. november 26.

  • GetDocumentDetail eljárásban
    • Új paraméter: optional (Opcionális (csak akkor kerül bele, ha true))

Verzió 2021.9, 2021. november 09.

  • Új eljárás: GetProductCategory: Visszaadja az összes olyan terméket és kategóriáját, ahol be van pipálva az 1. Honlap mező.

Verzió 2021.8, 2021. oktróber 12.

  • GetContact eljárásban
    • Új paraméter: ItemRecipient (Áruátvevő)
  • CreateContact eljárásban
    • Új paraméter: ItemRecipient (Áruátvevő)

Verzió 2021.7, 2021. szeptember 13.

  • CreateOffer eljárásban
    • a rendelésszám mezők pontosítása
    • a megjegyzés mezők pontosítása

Verzió 2021.6, 2021. szeptember 09.

  • GetProduct eljárásban
    • Új paraméter: mainstatus (visszaadja a termék státuszát)
  • CreateOffer eljárásban
    • Új paraméter: OrderNoCustomer (Rendelésszám vevő)
    • Új paraméter: OrderNoSupplier (Rendelésszám szállító)
    • Új paraméter: MainComment (A bizonylat megjegyzése)
  • GetDocument eljárásban
    • Új paraméter: order_no_customer (Rendelésszám vevő)
    • Új paraméter: order_no_supplier (Rendelésszám szállító)
    • Új paraméter: comment (A bizonylat megjegyzése)
  • Új eljárás: GetPackingListPdf: visszaadja egy bizonylat csomagolási lista nyomtatványát PDF formátumban.
  • Új eljárás: OfferToOrder: a megadott ajánlatot rendeléssé származtatja és visszaadja annak az azonosítóját.

Verzió 2021.5, 2021. június 22.

Verzió 2021.4, 2021. június 14.

Verzió 2021.3, 2021. június 10.

  • GetPrice eljárásban (paraméter nélküli hívás)
    • a discount paramétert át lett nevezve installer-re (hibás volt az elnevezés).
    • A paraméter leírása ki lett egészítve: „Alapértelmezetten 0.8. Ennél az értéknél nem adja vissza az interfész ezt a paramétert.”
    • Új paraméter: currency.
    • Az akció új paraméterekkel egészült ki: type, group, stock_sweeping, currency, discount_category, payment_method, store, discount, add.
    • Visszaadja a mennyiség kedvezményeket.
    • A válasz visszaadja a kérés típusát (type).
  • CreateContact eljárásban mind létrehozáskor, mind módosításkor beállítja a kapcsolat Webshop paraméterét igazra.
  • GetContact eljárás csak azokat a kapcsolattartókat adja át, akiknél be van pipálva a Webshop paraméter.
  • GetProduct eljárás
    • kiegészült az itemof tömbbel, amely azokat a szetteket tartalmazza, amelyekbe a termék beépülhet.
    • kiegészült a sizecategory mezővel.
    • a discount_category paraméter a leírásban tévesen kedvkat néven szerepelt.
    • kiegészült a promo_discount_category paraméterrel.
  • GetCustomer eljárásban a contact paraméter mostantól a felelős e-mail címét adja vissza.
  • CreateOffer eljárásban a recipment paraméter nem kötelező.
  • Új eljárás: SetAddress

Verzió 2021.2, 2021. május 17.

  • Új eljárás: GetPrice3 – Árak lekérése (Viszonteladói saját ár)
  • GetCustomer paraméter nélküli hívásának eredményéből hiányzott a status mező. Az eljárás visszaadta, csak a leírásból hiányzott.

Verzió 2021.1, 2021. május 9.

Első verzió.

Eljárások

GetCustomer – Ügyfél adatok lekérése

Azon ügyfelek adatait adja vissza, ahol a kapcsolattartónál be van pipálva a 1. honlap mező.

BEMENŐ PARAMÉTEREK
CustomerId Ügyfél azonosítója
Email A weboldalra bejelentkezett felhasználó e-mail címe
.wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000020 { font-size: 20px !important;} .wpdt-fs-000016 { font-size: 16px !important;}

A rendszer csak azokat az ügyfeleket adja vissza és be van pipálva a Webshop szerződés mező.

Az eljárásnak három hívási módja van:

Nincs paraméter megadva

Ilyenkor visszaadja az összes ügyfelet.

{
  "result": "ok",
  "customer": [
    {
      "id": "azonosító",
      "name": "név",
      "tax_number": "adószám",
      "direction": "irány",
      "currency": "pénznem",
      "payment_method": "fizetési mód",
      "post_payment": "Nem",
      "status": "ügyfél státusza",
      "discount_category": "kedvezmény kategória",
      "contacts": [
        {
          "name": "Terhes Sándor",
          "email": "gyarmatiterhes@gmail.com"
        }
      ]
    }
  ]
}
KIMENŐ PARAMÉTEREK
id * Ügyfél azonosítója
name * Név
tax_number * Belföldi adószám
direction * Irányultság (Belföld, Export/Import, EU export/Import)
currency * Alapértelmezett pénznem (3 karakteres ISO kód. pl.: HUF, EUR)
payment_method * Fizetési mód (a rendszerben szabadon megadhatók fizetési módok, ezeket az ERP-t használó céggel kell egyeztetni)
post_payment * Utólagos fizetés (igen/nem)
status * Ügyfél státusza (Aktív/Inaktív)
discount_category * Irányultság (Belföld, Export/Import, EU export/Import)
contacts Kapcsolattartók (tömb) Csak azokat a kapcsolattartókat adja vissza, akiknél be van pipálva az 1. honlap mező.
name ** Neve
email E-mail címe
.wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000020 { font-size: 20px !important;}

CustomerId van megadva

Visszaadja az ügyfél egyéb adatait.

Ha nincs ilyen azonosítóval ügyfél, akkor hibát ad:

{
  "result": "error", 
  "message": "Az azonosító (...) nem tartozik egyetlen aktív vevőhöz sem!"
}

Ha talált ügyfelet, akkor az alábbi választ adja:

{
  "result": "ok", 
  "CustomerId": "azonosító",
  "contact": "felelős",
  "limit": "váráslási limit",
  "outstand": "tartozás",
  "overdue": "lejárt tartozás",
  "status": "státusz"
}
KIMENŐ PARAMÉTEREK
CustomerId * Ügyfél azonosítója
contact * Saját cégnél ki a felelőse az ügyfélnek. A felelős e-mail címét adja vissza.
limit * Vásárlási limit. Ennél több tartozása nem lehet. Ha elérte a limitet a tartozása, akkor csak készpénzre vásárolhat a vevő. Ha nincs beállítva, akkor 0.
outstand * Összes tartozás
overdue * Lejárt tartozás
status * Státusz (Aktív, Inaktív)
.wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000020 { font-size: 20px !important;} .wpdt-fs-000016 { font-size: 16px !important;}

Email van megadva

Kikeresi az ügyfelek kapcsolattartói közül az e-mail címet tartalmazókat (ugyanaz az email cím több ügyfélhez is kapcsolódhat).

Az ügyfélnek be kell pipálva lennie a Webshop szerződésnek.
A kapcsolattartónál be kell pipálni az 1. honlap mezőt

Ha nem talál megfelelő kapcsolattartót és ezen keresztül ügyfelet, akkor hibát ad:

{
  "result": "error", 
  "message": "Az e-mail cím (...) nem tartozik egyetlen aktív vevőhöz sem!"
}

Ha csak egyet talál, akkor az eredmény ugyanaz, mintha az ügyfél CustomerId-jével lett volna meghívva az eljárás.

Ha több ügyfél is tartozik a megadott e-mail címhez, akkor az alábbi választ adja:

{
  "result": "ok", 
  "customers": [
    {
      "id": "azonosító",
      "name": "név",
      "status": "státusz"
    }, ...
  ]
}
KIMENŐ PARAMÉTEREK
id * Ügyfél azonosítója
name * Név
status * Státusz
.wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-fs-000020 { font-size: 20px !important;} .wpdt-fs-000016 { font-size: 16px !important;}

GetCustomer2 – Ügyfél adatok lekérése

Azon ügyfelek adatait adja vissza, ahol a kapcsolattartónál be van pipálva a 2. honlap mező.

BEMENŐ PARAMÉTEREK
Email * A weboldalra bejelentkezett felhasználó e-mail címe
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-fs-000016 { font-size: 16px !important;}

Ha nem talál megfelelő kapcsolattartót és ezen keresztül ügyfelet, akkor hibát ad:

{
  "result": "error", 
  "message": "Az e-mail cím (...) nem tartozik egyetlen aktív vevőhöz sem!"
}

Ha tartozik ügyfél a megadott e-mail címhez, akkor az alábbi választ adja:

{
  "result": "ok", 
  "customers": [
    {
      "id": "azonosító",
      "name": "név"
    } ...
  ]
} 
KIMENŐ PARAMÉTEREK
id * Ügyfél azonosítója
name * Név
.wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000020 { font-size: 20px !important;}

GetAddress – Ügyfél címek lekérése

Visszaadja az ügyfél számlázási és szállítási címeit.

BEMENŐ PARAMÉTEREK
CustomerId * Ügyfél azonosítója
.wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000020 { font-size: 20px !important;} .wpdt-fs-000016 { font-size: 16px !important;}

Válasz:

{
  "result": "ok", 
  "CustomerId": "azonosító",
  "Addresses": [
    {
      "id": "belső azon",
      "default": "alapértelmezett",
      "city": "település",
      "zipcode": "irányítószám",
      "country": "ország",
      "kozterulet": "közterület neve",
      "kozteruletjelleg": "közterület jellege",
      "hazszam": "házszám",
      "epulet": "épület",
      "lepcsohaz": "lépcsőház",
      "emelet": "emelet",
      "ajto": "ajtó",
      "street": "teljes cím",
      "email": "e-mail cím",
      "phone": "telefonszám",
      "recipment": "értesítendő személy",
      "billing": "true",
      "shipping": "true"
    }
  ]
} 
KIMENŐ PARAMÉTEREK
CustomerId * Ügyfél azonosítója
Addresses Címek (tömb)
id ** Rendszeren belüli egyedi azonosító (int)
default Alapértelmezett (true/false)
city ** Település
zipcode Irányítószám
country Ország neve. Magyarország esetén nem kerül bele.
kozterulet Közterület neve
kozteruletjelleg Közterület jellege
hazszam Házszám
epulet Épület
lepcsohaz Lépcsőház
emelet Emelet
ajto Ajtó
street Teljes cím összefűzve
email Címhez tartozó e-mail cím
phone Címhez tartozó telefonszám
recipment Címhez tartozó értesítendő személy
billing ** Számlázási cím (true/false)
shipping ** Szállítási cím (true/false)
.wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000020 { font-size: 20px !important;}

SetAddress – Ügyfél cím módosítása

Meglévő címet lehet vele módosítani. Csak számlázási cím módosítható.

Ha olyan címet módosít, ami egyben számlázási cím is, akkor létre hoz egy új címet szállítási címként és vissza adja az új ID-t. Ha csak az email, phone és recipment paraméterek változnak, akkor nem csinál új címet  hozzá.

Amelyik paraméter hiányzik a hívásból, azt üríti a rendszer a címben.

BEMENŐ PARAMÉTEREK
AddressId * Cím belső azonosítója
city * Település
zipcode Irányítószám
country Ország neve. Magyarország esetén nem kerül bele.
kozterulet Közterület neve
kozteruletjelleg Közterület jellege
hazszam Házszám
epulet Épület
lepcsohaz Lépcsőház
emelet Emelet
ajto Ajtó
email Címhez tartozó e-mail cím
phone Címhez tartozó telefonszám
recipment Címhez tartozó értesítendő személy
default Alapértelmezett (true/false)
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;}

Válasz:

{
  "result": "ok", 
  "newid": "új azonosító"
}
KIMENŐ PARAMÉTEREK
newid Rendszeren belüli egyedi azonosító (int), ha új cím jött létre
.wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000020 { font-size: 20px !important;} .wpdt-tc-000000 { color: #000000 !important;} .wpdt-fs-000016 { font-size: 16px !important;}

DeleteAddress – Ügyfél cím törlése

Meglévő címet lehet vele törölni.

Nem tényleges törlés.
Az ügyfél cím pipálható paramétereit Hamis-ra (false) állítja.

BEMENŐ PARAMÉTEREK
AddressId * Cím belső azonosítója
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;}

Válasz:

{
  "result": "ok"
}

GetProduct – Termékek lekérése

Visszaadja az összes olyan terméket, ahol be van pipálva az 1. Honlap mező.

Bemenő paraméter nincs.

Ha meg van adva kapcsolódó és ajánlott termék, akkor azokat is visszaadja a termékek alatt. Visszaadja továbbá a termék csoport besorolásait is.

Válasz:

{
  "result": "ok", 
  "products": [
    {
      "id": "cikkszám",
      "name": "megnevezés",
      "name2": "rövid név",
      "status": "státusz",
      "mainstatus": "termék státusz",
      "discount_category": "kedvezmény kategória",
      "promo_discount_category": "akciós kedvezmény kategória",
      "warranty": "garanica",
      "forbidpublicprice": "false",
      "onlyrequest": "true",
      "package1": "csomag méret",
      "package2": "karton méret",
      "website2": "true",
      "net1": "nettó súly",
      "gross1": "bruttó súly",
      "net2": "csomag nettó súly",
      "gross2": "csomag bruttó súly",
      "net3": "karton nettó súly",
      "gross3": "karton bruttó súly",
      "sizedcategory": "méret kategória",
      "description": "leírás",
      "recommended": [
        {
          "id": "cikkszám", 
          "priority": "prioritás", 
          ... 
        }
      ], 
      "related": [
        {
          "id": "cikkszám", 
          "priority": "prioritás", 
          ... 
        }
      ],
      "itemof": [
        {
          "id": "cikkszám", 
          "quantity": "mennyiség", 
          ... 
        }
      ],
      "group": [
        {
          "path": ["szint1", "szint2", ...], 
          "main": "true"            
        }...
      ],

    },...
  ]
} 
KIMENŐ PARAMÉTEREK
id * Cikkszám
name * Megnevezés
name2 Rövid név (ha ki van töltve)
status * Termék státusza: Aktív, Kifutó, Tervezett, Értékcsökkentett, Akciós Akkor Akciós, ha van a termékre élő akció.
mainstatus Termék státusza
discount_category Kedvezmény kategória
promo_discount_category Akciós kedvezmény kategória
warranty Garancia (szöveges mező)
forbidpublicprice * Publikus ár tiltás (true/false)
onlyrequest * Csak rendelésre (true/false)
package1 Csomag méret (float)
package2 Karton méret (float)
website2 2. honlap bevan pipálva (true/false, csak true értékkel esetén kerül bele)
net1 Nettó súly (float)
gross1 Bruttó súly (float)
net2 Csomag nettó súly (float)
gross2 Csomag bruttó súly (float)
net3 Karton nettó súly (float)
gross3 Karton bruttó súly (float)
sizecategory Méret kategória (a rendszerben szabadon megadott lista elem)
description Leírás (sortörést tartalmazhat <br>)
recommended Helyettesítő termékek (tömb) (eredetileg ajánlott volt, ezért a megtévesztő név)
id ** Termék cikkszáma
priority Ajánlási prioritás/sorrend (int)
related Kapcsolódó termékek (tömb)
id ** Termék cikkszáma
priority Ajánlási prioritás/sorrend (int)
itemof Milyen szettekbe épül be
id ** Szett cikkszám
quantity ** Beépülési mennyiség
group Csoport (tömb)
path ** Csoport szintek tömbben felsorolva (tömb) Például ["Kábelek","Gyengeáramú kábelek"]
main Elsődleges csoport (csak true értékkel esetén kerül bele)
.wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000020 { font-size: 20px !important;} .wpdt-fs-000016 { font-size: 16px !important;} .wpdt-bc-FFFFFF { background-color: #FFFFFF !important;}

GetProduct2 – Termékek lekérése

Visszaadja az összes olyan terméket, ahol be van pipálva az 2. Honlap mező.

Megegyezik a GetProduct eljárással, csak itt a 2. Honlap mezőre szűri a termékeket.

GetProduct3 – Termékek lekérése (készlet, ár)

Visszaadja termékeket, a készletüket és az árukat.

BEMENŐ PARAMÉTEREK
raktar Raktár azonosító
kategoria Kedvezmény kategória
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;}

Ha nincs megadva szűrés, akkor az összes raktár készletét és kedvezmény kategóriás árakat visszaadja.
A paramétereket pontosvesszővel elválasztva kell megadni (példa raktárakra: ‘A-H;A-N;L’)

Válasz:

{
  "result": "ok", 
  "products": [
    {
      "cikkszam": "KJH23456",
      "cikkszam2": "1",
      "pn": "HUF",
      "keszlet": {
        "A-H": 4
      },
      "arak": {
        "listaar": 56400,
        "telepítő": 39480,
        "viszonteladó": 35532,
        "VIP": 35532,
      },
    },...
  ]
}
KIMENŐ PARAMÉTEREK
Products * Termékek (tömb)
cikkszam ** Cikkszám
cikkszam2 2. cikkszám
pn Pénznem
keszlet Készlet (tömb)
[raktár azonosító] Raktár készlet
arak Árak (tömb)
[kedvezmény kategória] Kedvezmény kategóriás ár
.wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-fs-000020 { font-size: 20px !important;} .wpdt-tc-000000 { color: #000000 !important;} .wpdt-bc-FFFFFF { background-color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

GetPrice – Árak lekérése

Visszaadja azon termékek árait, ahol be van pipálva az 1. Honlap mező.

BEMENŐ PARAMÉTEREK
Email a weboldalra bejelentkezett felhasználó e-mail címe
CustomerId az ügyfél azonosítója
Type lekérés típusa: Full (default), Change
.wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-fs-000020 { font-size: 20px !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

Ha a lekérés típusa Full, akkor visszaadja az összes terméket a szűrésnek megfelelően.
Ha a típus Change, akkor csak azokat adja vissza, amelyeknek legalább az egyik értéke megváltozott az utolsó lekérés óta.

Ha Email és CustomerId paraméterek nélkül hívjuk meg, akkor a cégektől független listaárakat adja vissza.

{
  "result": "ok", 
  "type": "lekérdezés típusa",
  "products": [
    {
      "id": "C1",
      "price": "listaar",
      "installer": "telepítői százalék",
      "currency": "HUF",
      "action": [
        {
          "type": "price", 
          "end_date": "akció vége dátum", 
          "end_time": "akció vége idő", 
          "stock_sweeping": "Igen", 
          "price": "akciós ár", 
          "currency": "HUF"            
        }, ...
      ], 
      "discount: [
        {
          "quantity: "mennyiség, 
          "price: "ár"
        }, ...
      ]
    }, ...
  ]
} 
KIMENŐ PARAMÉTEREK
type * Lekérdezés típusa (full, change)
id * Cikkszám
price * Listaár (ha az ION-ban az Beállítások/API-nál meg van adva egy ügyfél a klienshez, akkor annak az ügyfélnek az ára)
installer Telepítői százalék (tört számként visszaadva pl.: 0,7) Alapértelmezetten 0,8. Ennél az értéknél nem adja vissza az interfész ezt a paramétert.
currency * Pénznem (pl.: HUF)
action Akció (tömb)
type ** Akció típus price: új alapár van megadva discount: kedvezmény százalék van megadva
end_date ** Akció vége dátum (YYYY.MM.DD)
end_time Akció vége idő (HH.NN) Csak akkor rakja bele, ha ki van töltve.
stock_sweeping Készletkisöprés. (csak Igen esetén szerepel az válaszban)
price *** Akciós ár
currency *** Pénznem (pl.: HUF)
discount_category Kedvezmény kategória
group Csoport szintek tömbben felsorolva (tömb) Például ["Kábelek","Gyengeáramú kábelek"] Az akció időtartamára bekerül a termék ebbe a csoportba.
payment_method Fizetési mód
store Raktár
discount *** Kedvezmény %
add *** (igen/nem) Ha igaz, akkor a kedvezményt a normál kedvezményhez hozzá kell adni, különben felül kell azt írni. Az akciós kedvezmény és az ügyfél normál kedvezménye közül mindig a nagyobb az érvényes.
discount Mennyiségi kedvezmény (tömb)
quantity ** Minimum mennyiség
price ** Minimum mennyiség
.wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000020 { font-size: 20px !important;} .wpdt-fs-000016 { font-size: 16px !important;}

*** Az akció típusától függ, hogy kötelező-e.

Ha az Email paraméter meg van adva, akkor az ION kikeresi a kapcsolattartók között az e-mail címet és társítja egy céghez.

Ha egyetlen céghez sem tartozik az e-mail cím, akkor hibát ad:
A e-mail cím (…) nem tartozik egyetlen aktív vevőhöz sem!

Ha több céghez is hozzá van rendelve az e-mail cím, akkor visszaadja a választható cégeket.

{
  "result": "ok", 
  "customers": [
    {
      "id": "U1",
      "name": "Cég1",
      "notpricelisteligible": "True"
    },
    {
      "id": "U2",
      "name": "Cég2",
      "notpricelisteligible": "False"
    },
    ...
  ]
} 
KIMENŐ PARAMÉTEREK
id * ügyfél azonosítója
name * ügyfél neve
notpricelisteligible * árlista tiltása (ION nem használja)
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

Ilyenkor újra meg kell hívni az eljárást, de már a kiválasztott cég azonosítójával (az e­mail címet nem kell megadni).

Visszaadja a cég azonosítóját és nevét és minden aktív illetve kifutó termékhez vissza adja az ügyfélhez tartozó árat.

{
  "result": "ok", 
  "type": "lekérdezés típusa", 
  "customers": 
    {
      "id": "U1",
      "name": "Cég1",
      "notpricelisteligible": "True"
    },
  "products":[termékek]
} 
KIMENŐ PARAMÉTEREK
type * Lekérdezés típusa (full, change)
customer * Ügyfél adatok
id * Azonosítója
name * Neve
notpricelisteligible * Árlista tiltva (true/false)
products * Termékek Tartalma megegyezik azzal, mint amikor ügyfél nélküli a lekérés
.wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000020 { font-size: 20px !important;} .wpdt-fs-000016 { font-size: 16px !important;}

GetPrice2 – Árak lekérése

Visszaadja azon termékek árait, ahol be van pipálva az 1. Honlap mező.

Megegyezik a GetPrice eljárással, csak itt a 2. Honlap mezőre szűri a termékeket.

GetPrice3 – Árak lekérése (Viszonteladó saját ár)

Visszaadja az aktív termékek árait és az API-hoz rendelt ügyfél árát.
Bemenő paraméter nincs.

Ha az API-nál nincs megadva ügyfél kód, akkor hibát ad:

{
  "result": "error", 
  "message": "Az API nincs ügyfélhez rendelve!"
}

Ha a megadott ügyfél kód nem tartozik egy aktív ügyfélhez sem, akkor hibát ad:

{
  "result": "error", 
  "message": "Az azonosító (...) nem tartozik egyetlen aktív vevőhöz sem!"
}

Válasz:

{
  "result": "ok", 
  "products": [ 
    {
      "id": "C1",
      "price": "listaár",
      "ownprice": "ügyfél ár",
      "installerprice": "telepítői ár"
    }, ...
  ]
} 
KIMENŐ PARAMÉTEREK
id * Cikkszám
price * Listaár
ownprice * Ügyfél ár
installerprice * Telepítői ár
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

GetCustomPrice – Egyedi árak és kedvezmények

Visszaadja az ügyfelekhez tartozó egyedi kedvezményeket és egyedi árakat.

Bemenő paraméter nincs.

Válasz:

{
  "result": "ok", 
  "categories": [ 
    {
      "id": "kategória azonosító",
      "name": "kategória név"
    }, ...
  ],
  "customers": [ 
    {
      "id": "ügyfél azonosító"
      "discount": [
        { 
          "discount": "kedvezmény",
          "categories": [
            56,
            57,
            ...
          ],
          "product": "termék azonosító",
          "payment_method": "fizetési mód",
          "end_date": "vége dátum",
          "end_time": "vége idő"
        }, 
        ...     
     ],
     "price": [
       {
         "price": "listaár",
         "currency": "pénznem",
         "product": "termék azonosító",
         "group": ["szint1", "szint2", ...],
         "work": "munkaszám",
         "workquantity": "munkaszám mennyiség",
         "unit": "mértékegység",
         "end_date": "vége dátum",
         "end_time": "vége idő"
       },
       ...
      ]         
    },...
  ],
} 
KIMENŐ PARAMÉTEREK
Categories Kedvezmény kategóriák (tömb)
id * Kategória azonosítója
name * Kategória neve
id * Ügyfél azonosítója
discount Egyedi kedvezmény (tömb)
categories *** Kedvezmény %-hoz tartozó Kedvezmény kategória azonosítók (tömb)
product *** Termék azonosító
payment_method *** Fizetési mód
discount ** Kedvezmény %
end_date Vége dátum (YYYY.MM.DD)
end_time Vége idő (HH.NN)
price Egyedi ár (tömb)
product *** Termék azonosító
group *** Csoport szintek tömbben felsorolva (tömb) Például ["Kábelek","Gyengeáramú kábelek"]
work Munkaszám
workquantity Munkaszám mennyiség
unit ** Mértékegység
price ** Kedvezményes ár
currency ** Pénznem (3 karakteres ISO kód. pl.: HUF, EUR)
end_date Vége dátum (YYYY.MM.DD)
end_time Vége idő (HH.NN)
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

A discount-on és a price-on belül a *** mezők közül az egyik mindig ki van töltve.

Ha az end_date paraméter üres, akkor nincs lejárata az egyedi kedvezménynek illetve árnak.

CreateOffer – Ajánlat létrehozása

Rögzít egy ajánlatot a rendszerben webshop munkaszámmal.

BEMENŐ PARAMÉTEREK
CustomerId * Ügyfél azonosítója
Recipment Értesítendő személy az ügyfélnél
Phone Értesítési telefonszám
DataOfReceipt Átvétel dátuma. Ha a szállítási mód Személyes, akkor a bizonylat teljesítését beállítja erre az dátumra.
ShippingMode * Szállítási mód
Payment * Fizetési mód
1) megadás típussal: Átutalás, Készpénz, Bankkártya, Utánvét, Paypal
2) megadás fizetési mód névvel.
Ha típussal van megadva, akkor átutalás esetén 8 napra, egyéb esteben 0 napra állítja a fizetési határidőt és így keres egy fizetési módot. Ha nem találja a megadott fizetési módot, akkor hibát ad: Ismeretlen fizetés típus (...)!
Store * Raktár (Törzsadatok/Raktár ablakon megadott Webshop azonosító)
Comment Weboldalon megadott megjegyzés (levágja 400 karakterre) A bizonylat aljára kerül, több soros lehet.
Return Visszáru (true/false, default: false)
Parity Fuvarparitás
OrderNo Rendelésszám (régi paraméter, ki lesz vezetve)
BillAuto True esetén a rendszer automatikusan választ számlázási címet (true/false, default: false)
BillId A cím ID-je (GetAddress által visszaadott id)
BillZipcode Számlázás cím irányítószáma
BillCity Számlázás cím település
BillStreet Számlázás cím utca, házszám
BillCountry Számlázás cím ország (ha nincs megadva, akkor Magyarország)
BillKozterulet
BillKozteruletjelleg
BillHazszam
BillEpulet
BillLepcsohaz
BillEmelet
BillAjto
ShipAuto True esetén a rendszer automatikusan választ szállítási címet (true/false, default: false)
ShipId A cím ID-je (GetAddress által visszaadott id)
ShipZipcode Számlázás cím irányítószáma
ShipCity Számlázás cím település
ShipStreet Számlázás cím utca, házszám
ShipCountry Számlázás cím ország (ha nincs megadva, akkor Magyarország)
ShipKozterulet
ShipKozteruletjelleg
ShipHazszam
ShipEpulet
ShipLepcsohaz
ShipEmelet
ShipAjto
OrderNoCustomer   Vevői rendelésszám
OrderNoSupplier   Szállítói rendelésszám (ha üres, akkor értékül kapja az OrderNo paraméter értékét.
HeadComment   A bizonylat fejlécébe kerülő megjegyzés.
Coupon   Kupon azonosító
Currency   Pénznemek 3-karakteres devizakódja. Ha nincs megadva, akkor az ügyféltől van kinyerve.
P[x] * Termék azonosító, ahol az [x] egy futó sorszám 1-től
M[x] * Termékhez tartozó mennyisség, ahol az [x] egy futó sorszám 1-től
.wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000020 { font-size: 20px !important;} .wpdt-fs-000016 { font-size: 16px !important;}

Az így létrehozott bizonylatok kapnak egy webshop munkaszámot és az Értékesítés/1. webshop menüpont alatt találhatók meg.

Ha olyan szállítási címet kap, ami még nem létezik, akkor azt létrehozza.

Az ügyfél rendszeren belüli felelősének küld egy e-malit Új rendelés érkezett – bizonylatszám tárggyal.

Az alábbi adatok a bizonylat megjegyzésébe kerülnek:

Címek kezelése

Ha a BillAuto illetve ShipAuto mezőkben true szerepel, akkor további cím mező megadására nincs szükség.

Egyébként mindkét cím típusra igaz, hogy vagy az Id-t kötelező megadni vagy az egyéb cím adatokat. Az egyéb adatoknál a kötelezőség értelem szerű. A rendszer az ION-ban megadott címekből kikeresi az Id-t vagy annak hiányában az egyéb adatok alapján a címet.

Számlázási cím csak a rendszerben előzetesen felvitt cím lehet.

Ha eddig ismeretlen szállítási címet adtak meg, akkor azt létrehozza a rendszer egy Webshop-ról megjegyzéssel.

A címben kötelező mezők azok, amik a Nav szerint kötelezőek:

A közterület jellegben elfogadott értékek lekérdezhetők a GetKozterulet függvénnyel.

Válasz:

{
  "result": "ok", 
  "offerid": "bizonylatszam"
}
KIMENŐ PARAMÉTEREK
offerid * Létrehozott ajánlat bizonylatszáma
.wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-fs-000020 { font-size: 20px !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

Hibaüzenetek:

CreateOffer2 – Ajánlat létrehozása

Rögzít egy ajánlatot a rendszerben webshop2 munkaszámmal.

Megegyezik a CreateOffer eljárással, csak itt a webshop2 munkaszámot állítja be.

GetStock – Készlet lekérése ( webshop 1 )

Visszaadja a készletet, a várható beérkezést és az átfutási időt azoknak a termékeknek, ahol be van pipálva az 1. Honlap mező.

Csak azokat a termékeket adja vissza, ahol alábbi feltételek közül legalább az egyik teljesül:

Bemenő paraméter nincs.

Válasz:

{
  "result": "ok", 
  "stock": [ 
    {
      "id": "cikkszám",
      "set": "true",
      "location": "telephely",
      "stock": "készlet",
      "arrival": "várható érkezés (YYYY.MM.DD)",
      "transittime": "átuftási idő",
      "unit": "mértékegység",
      "unavailableat": "nem elérhető (YYYY.MM.DD)"
    }, ...
  ]
} 
KIMENŐ PARAMÉTEREK
id * Cikkszám
set A termék szett (true/false, csak true értékkel esetén kerül bele)
location * Telephely
stock * Készlet (float)
arrival Várható érkezés (date) (YYYY.MM.DD)
transittime Átfutási idő (int)
unit Mértékegység
unavailableat Meddig nem elérhető (date) (YYYY.MM.DD)
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

GetStock2 – Készlet lekérése

Visszaadja a készletet, a várható beérkezést és az átfutási időt azoknak a termékeknek, ahol be van pipálva az 2. Honlap mező.

Megegyezik a GetStock eljárással, csak itt a 2. Honlap mezőre szűri a termékeket.

GetStockAvailable – Készlet elérhetőség lekérése ( webshop 1 )

Visszaadja a terméket és a készlet telephelyét azoknak a termékeknek, ahol be van pipálva az 1. Honlap mező és van belőle készleten.

Szettek esetén visszadjuk a készlet értékét is

Bemenő paraméter nincs.

Válasz:

{
  "result": "ok", 
  "stock": [ 
    {
      "id": "cikkszám",
      "set": "true",
      "location": "telephely",
      "stock": "készlet"
    }, 
    {
      "id": "cikkszám", 
      "location": "telephely"
    }...
  ]
} 
KIMENŐ PARAMÉTEREK
id * Cikkszám
set A termék szett (true/false, csak true értékkel esetén kerül bele)
location * Telephely
stock Készlet (float)
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

GetStock2Available – Készlet elérhetőség lekérése ( webshop 2 )

Visszaadja a terméket és a készlet telephelyét azoknak a termékeknek, ahol be van pipálva az 2. Honlap mező és van belőle készleten.

Megegyezik a GetStockAvailable eljárással, csak itt a 2. Honlap mezőre szűri a termékeket.

GetStock2 – Készlet lekérése

Visszaadja a készletet, a várható beérkezést és az átfutási időt azoknak a termékeknek, ahol be van pipálva az 2. Honlap mező.

Megegyezik a GetStock eljárással, csak itt a 2. Honlap mezőre szűri a termékeket.

Beállítja a termék webcímét.

BEMENŐ PARAMÉTEREK
Product * Termék cikkszám
Url Weboldal alcíme
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

Az ION kikeresi a cikkszám alapján a terméket és beállítja a weblink értékét.

A weblinkeknek meg lehet adni egységesen az elejét a Beállítások/Paraméterek ablakon a Termékek/Weblink mezőben (például http://www.ceg.hu/termekek/).

Ebben az eljárásban csak az előbbi módon megadott url után részt kell átadni.

Válasz:

{
  "result": "ok"
}

GetKozterulet – Közterület jellegek lekérése

Visszaadja a választható közterület jellegeket (utca, út stb.).

Bemenő paraméter nincs.

Válasz:

{
  "result": "ok", 
  "kozterulet": [ 
    {
      "name": "akna"
    },
    {
      "name": "akna-alsó"
    }, ...
  ]
} 
KIMENŐ PARAMÉTEREK
name * Közterület jellege
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

GetParam – Termék jellemző típusok

Visszaadja a jellemzők típusokait.
Nincs bemenő paramétere.

Válasz:

{
  "result": "ok", 
  "params": [ 
    {
      "name": "név",
      "datatype": "típus",
      "unit": "mértékegység",
      "closed": "zárt",
      "hidden": "rejtett",
      "order": "sorrend",
      "shortname": "rövidnév",
      "items": ["egy", "egy", ...]
    }, ...
  ]
} 
KIMENŐ PARAMÉTEREK
name * Jellemző neve
datatype * Jellemző típusa (char, number, list, boolean)
unit Mértékegység (csak number típus esetén)
closed * Zárt (true/false)
hidden * Rejtett (true/false)
order Sorrend
shortname Rövid név
items List típus esetén a választható értékek listája
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

GetProductParam – Termék jellemzők

Visszaadja azon termékek jellemzőit, ahol be van pipálva az 1. Honlap mező.

Nincs bemenő paramétere.

Válasz:

{
  "result": "ok",
  "productparam": [ 
    {
      "id": "ügyfél azonosító"
      "param": [
        { 
          "név1": "érték1",
          "név2": "érték2",
          ...
        }, 
        ...     
      ]       
    }, ...
  ]
} 
KIMENŐ PARAMÉTEREK
id * Cikkszám
param Jellemzők (tömb)
nev: ertek Típus neve: jellemző értéke
A típus nevek a GetParam eljárással kérhetők le.
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

GetBarcode – Termék vonalkódok

Visszaadja a termékekhez tartozó vonalkódokat.
Egy termékhez több vonalkód is tartozhat.
Nincs bemenő paramétere.

Válasz:

{
  "result": "ok", 
  "barcodes": [ 
    {
      "id": "cikkszám",
      "barcode": "vonalkód",
      "quantity": "mennyiség",
      "unit": "mértékegység"
    }, ...
  ]
} 
KIMENŐ PARAMÉTEREK
id * Cikkszám
barcode * Vonalkód
quantity * A vonalkódhoz tartozó mennyiség (gyűjtő vonalkódoknál nagyobb egynél)
unit * Mértékegység. Alapból megegyezik a termék mértékegységével, de gyűjtő vonalkódoknál eltér (például zsugor, rekesz)
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

CreateContact – Ügyfél kapcsolattartó

Ügyfelekhez tartozó kapcsolattartókat lehet létrehozni illetve módosítani.

BEMENŐ PARAMÉTEREK
CustomerId * Ügyfél azonosítója
Name Kapcsolattartó neve
Mobile Telefonszám
Email * E-mail cím
EligibleForPurchase Vásárlásra jogosult (true/false default false)
Primary Elsődleges kapcsolattartó (true/false default false)
InvoiceMail E-mail küldés számláról (true/false default false)
DeliveryMail E-mail küldés szállítóról (true/false default false)
ServiceMail E-mail küldés szervizről (true/false default false)
PurchaseMail E-mail küldés beszerzésről (true/false default false)
AutoQuotationMail Automatikus ajánlat küldés (true/false default false)
OrderConfirmMail E-mail küldés rendelés visszaigazolásról (true/false default false)
ItemRecipient   Áruátvevő (true/false default false)
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

Ha a rendszerben az adott ügyfélnek már szerepel a megadott e-mail címmel kapcsolattartója, akkor módosítja az adatait. Egyéb esetben létrehozza azt.

Új kapcsolattartó létrehozáskor kötelező megadni a kapcsolattartó nevét.
Ha valamelyik nem kötelező paraméter nem szerepel a hívásban, akkor azt nem módosítja.

Mind létrehozáskor, mind módosításkor beállítja a kapcsolat Webshop paraméterét igazra.

Válasz:

{
  "result": "ok"
}

DeleteContact – Ügyfél kapcsolattartó törlése

Ügyfelekhez tartozó kapcsolattartó törlése.

BEMENŐ PARAMÉTEREK
CustomerId * Ügyfél azonosítója
Name Kapcsolattartó neve
Email E-mail cím
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

A Name és Email paraméterek közül az egyik megadása kötelező! Elsődlegesen az e-mail címmel keres.

Válasz:

{
  "result": "ok"
}

GetContact – Ügyfél kapcsolattartóinak lekérdezése

Ügyfelekhez tartozó kapcsolattartó lekérdezése.

BEMENŐ PARAMÉTEREK
CustomerId * Ügyfél azonosítója
Name Kapcsolattartó neve
Email E-mail cím
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

Ha csak CustomerId paraméter van átadva, akkor visszaadja az ügyfélhez tartozó összes kapcsolattartó adatait.
Egyéb esetben csak a szűrésnek megfelelő kapcsolattartót adja vissza.

Csak azokat a kapcsolattartókat adja át, akiknél be van pipálva a Webshop paraméter.

Válasz: 

{
  "result": "ok", 
  "CustomerId": "azonosító", 
  "contacts": [ 
    {
      "Name": "név",
      "Mobile": "06301111111",
      "Email": "minta@email.com",
      "EligibleForPurchase": "Igen",
      "Primary": "Nem",
      "InvoiceMail": "Igen",
      "DeliveryMail": "Nem",
      "ServiceMail": "Nem",
      "PurchaseMail": "Nem",
      "AutoQuotationMail": "Igen",
      "OrderConfirMail": "Igen",
      "ItemRecipient": "Igen"
    }, ...
  ]
} 
KIMENŐ PARAMÉTEREK
CustomerId * Ügyfél azonosítója
Contacts Kapcsolattartók (tömb)
Name * Kapcsolattartó neve
Mobile Telefonszám
Email * E-mail cím
EligibleForPurchase * Vásárlásra jogosult (Igen/Nem alapértelmezett: Nem)
Primary * Elsődleges kapcsolattartó (Igen/Nem alapértelmezett: Nem)
InvoiceMail * E-mail küldés számláról (Igen/Nem alapértelmezett: Nem)
DeliveryMail * E-mail küldés szállítóról (Igen/Nem alapértelmezett: Nem)
ServiceMail * E-mail küldés szervizről (Igen/Nem alapértelmezett: Nem)
PurchaseMail * E-mail küldés beszerzésről (Igen/Nem alapértelmezett: Nem)
AutoQuotationMail * Automatikus ajánlat küldés (Igen/Nem alapértelmezett: Nem)
OrderConfirmMail * E-mail küldés rendelés visszaigazolásról (Igen/Nem alapértelmezett: Nem)
ItemRecipient * Áruátvevő (Igen/Nem alapértelmezett: Nem)
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

GetDiscount – Ügyfél kedvezmények lekérése

Visszaadja az ügyfelekhez és az egyes kedvezményekhez tartozó kedvezmény kategóriákat. Csak azokat a vevőket adja vissza, akiknél be van pipálva az 1. honlap.
Nincs bemenő paraméter.

Először visszaadja a kategóriákat (Categories).
Utána visszaadja az egyes ügyfeleket (Customers), azon belül az egyes kedvezmény százalékokat (value) és a hozzá tartozó kategóriák id-it (categories).

Válasz:

{
  "result": "ok", 
  "categories": [ 
    {
      "id": "kategória azonosító",
      "name": "kategória név"
    }, ...
  ],
  "customers": [ 
    {
      "id": "ügyfél azonosító"
      "discount": [
        { 
          "value": 0,
          "categories": [
            53
          ]
        },
        { 
          "value": 17,
          "categories": [
            56,
            57,
            38,
            44,
            85,
            86,
            95,
            116
          ]
        }, 
        ...     
     ]        
    },...
  ]
} 
KIMENŐ PARAMÉTEREK
Categories Kedvezmény kategóriák (tömb)
id * Kategória azonosítója
name * Kategória neve
Customers Ügyfelek (tömb)
id * Ügyfél azonosító
discounts Kedvezmények (tömb)
value * Kedvezmény %
categories * Kedvezmény %-hoz tartozó Kedvezmény kategória azonosítók (tömb)
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

GetDocument – Bizonylatok lekérése

Visszaadja egy ügyfél bizonylatait. Az aktív ajánlatokat (ha végleges) és rendeléseket, továbbá a lezárt szállító leveleket és számlákat.

BEMENŐ PARAMÉTEREK
CustomerId * Ügyfél azonosítója
DateFrom Dátumtól ( YYYY.MM.DD vagy YYYY.MM.DD HH:NN:SS )
Type Bizonylat típus (quotation, order, deliverynote, invoice)
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;}

Ha a DateFrom paraméter meg van adva, akkor azokat a bizonylatokat adja vissza, amik a dátumtól kezdve módosítva lettek.
Ha nincs dátum paraméter, akkor az elmúlt 3 hónap bizonylatait adja vissza.
Ha meg van adva, akkor is legfeljebb az elmúlt egy év adatait adja vissza.

Válasz: 

{
  "result": "ok", 
  "CustomerId": "azonosító", 
  "documents": [ 
    {
      "id": "azonosító",
      "number": "bizonylatszám",
      "type": "bizonylatok típusa",
      "dated": "kelt",
      ...
    }, ...
  ]
} 
KIMENŐ PARAMÉTEREK
id * Azonosító (szám)
number * Bizonylatszám
type * Bizonylat típus (quotation, order, deliverynote, invoice)
character * Jelleg (Normál, Sztornó, Helyesbítő, Sztornózott, Helyesbített)
dated * Kelt
date_of_delivery o, d Teljesítés
quotation_valid_until q Ajánlat érvényes
payment_due_date i Fizetési határidő
warehouse * Raktár
net * Nettó
payable * Fizetendő
derived q, o, d Származtatott (Igen, Nem, Részben)
debt i Tartozás
currency * Pénznem (HUF, EUR…)
payment_method * Fizetési mód
order_no_customer   Rendelésszám vevő
order_no_supplier   Rendelésszám szállító
comment   A bizonylat megjegyzése
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

A bizonylat típusok kezdőbetűjével van jelölve (q, o, d, i), hogy melyik paraméter melyik típusnál szerepel. A *-os paraméterek mindegyik típusnál léteznek.

GetDocumentDetail – Bizonylat tételek lekérése

Visszaadja egy bizonylat tételeit.

BEMENŐ PARAMÉTEREK
id * Bizonylat azonosító
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

Válasz:

{
  "result": "ok", 
  "id": "azonosító", 
  "details": [ 
    {
      "number": "sorszám",
      "id": "cikkszám",
      "name": "megnevezés",
      "quantity": "mennyiség",
      "open": "nyitott mennyiség",
      "reserved": "foglalt mennyiség",
      "unit": "mértékegység",
      "price": "nettó egységár",
      "net": "nettó összesen",
      "status": "státusz",
      "arrival": "várható érkezés"
      "optional": "true"
    }, ...
  ]
} 
KIMENŐ PARAMÉTEREK
number * Sorszám
id * Cikkszám
name * Megnevezés
quantity * Mennyiség
open q, o, d quotation: Nyitott mennyiség
order: Nem teljesített mennyiség,
delivery: Rendezetlen mennyiség
reserved o Foglalt mennyiség
unit * Mértékegység
price * Nettó egységár
net * Nettó összesen
status o Tétel státusza (Foglalt, Hiányos)
arrival o Várható beérkezés (YYYY.MM.DD)
optional Opcionális (csak akkor kerül bele, ha true)
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

GetDocumentPdf – Bizonylathoz tartozó pdf

Visszaadja egy bizonylat nyomtatványát PDF formátumban.

BEMENŐ PARAMÉTEREK
id * Bizonylat azonosító
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

Válasz:

{
  "result": "ok", 
  "id": "azonosító",
  "pdf": "base64"
}
KIMENŐ PARAMÉTEREK
id * Bizonylat azonosító
pdf * Bizonylat adatfolyam base64-re kódolva
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

GetPackingListPdf – Bizonylathoz tartozó csomagolási lista PDF

Visszaadja egy bizonylat csomagolási lista nyomtatványát PDF formátumban.

BEMENŐ PARAMÉTEREK
id * Bizonylat azonosító
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

Válasz:

{
  "result": "ok", 
  "id": "azonosító",
  "pdf": "base64"
}
KIMENŐ PARAMÉTEREK
id * Bizonylat azonosító
pdf * Csomagolási lista adatfolyam base64-re kódolva
.wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000020 { font-size: 20px !important;}

OfferToOrder – Ajánlat rendeléssé származtatása

A megadott ajánlatot rendeléssé származtatja és visszaadja annak az azonosítóját.

BEMENŐ PARAMÉTEREK
id * Bizonylat azonosító
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

Válasz:

{
  "result": "ok", 
  "id": "azonosító",
  "newid": "új azonosító"
}
KIMENŐ PARAMÉTEREK
id * Az ajánlat azonosítója
newid * A rendelés azonosítója
.wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-fs-000020 { font-size: 20px !important;} .wpdt-fs-000016 { font-size: 16px !important;}

GetProductCategory – Termék kategóriák lekérése

Visszaadja az összes olyan terméket és kategóriáját, ahol be van pipálva az 1. Honlap mező.

Bemenő paraméter nincs.

Válasz:

{
  "result": "ok", 
  "products": [
    {
      "id": "cikkszám",  
      "name": "megnevezés",
      "name2": "rövid név",
      "status": "státusz",
      "group": [
        {
          "path": ["szint1", "szint2", ...], 
          "main": "true"            
        }...
      ],

    },...
  ]
} 
KIMENŐ PARAMÉTEREK
id * Cikkszám
name * Megnevezés
name2 Rövid név (ha ki van töltve)
status * Termék státusza: Aktív, Kifutó, Tervezett, Értékcsökkentett, Akciós Akkor Akciós, ha van a termékre élő akció.
group Csoport (tömb)
path ** Csoport szintek tömbben felsorolva (tömb) Például ["Kábelek","Gyengeáramú kábelek"]
main Elsődleges csoport (csak true értékkel esetén kerül bele)
.wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-fs-000020 { font-size: 20px !important;} .wpdt-tc-000000 { color: #000000 !important;} .wpdt-bc-FFFFFF { background-color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}

GetAssignee – Felelősök lekérése

Visszaadja a felelősöket a szűrésnek megfelelően.
Ha nincs megadva szűrés, akkor az összes felelőst visszaadja.

BEMENŐ PARAMÉTEREK
Authority Jogkör
.wpdt-fs-000020 { font-size: 20px !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-tc-FFFFFF { color: #FFFFFF !important;}

Válasz, jogkör megadása esetén:

{
  "result": "ok", 
  "Authority": "jogkör",
  "Assignees": [
    {
      "name": "felelős neve",
      "email": "minta@email.hu" 
  ]
}

Válasz, jogkör megadása nélkül:

{
  "result": "ok", 
  "Assignees": [
    {
      "name": "felelős neve",
      "email": "minta@email.hu",
      "authority": "jogkörök"
  ]
}
KIMENŐ PARAMÉTEREK
Authority Jogkör szűrés
Assignees * Felelősök (tömb)
name ** Felelős neve
email Felelős e-mail címe
authority Jogkörök
.wpdt-tc-FFFFFF { color: #FFFFFF !important;} .wpdt-bc-FF6767 { background-color: #FF6767 !important;} .wpdt-fs-000020 { font-size: 20px !important;} .wpdt-tc-000000 { color: #000000 !important;} .wpdt-bc-FFFFFF { background-color: #FFFFFF !important;} .wpdt-fs-000016 { font-size: 16px !important;}
(30) 459-4105