Changelog

v1.0 (2022.07.11)
initial release
v1.1 (2022.08.18)
EAN adat bekerült a termékek közé (getProduct, getProductList)
v1.2 (2022.08.23)
rendeléseknél fizetési mód, szállítási mód, fixponti szállítási adaok, támogatott webáruházakból érkező rendelések egyedi azonosító megjelennek (getOrders)

Autentikáció

Minden művelet autentikációt igényel. A HTTP header-ben egy szabványos Basic autentikációt kell küldeni.

Például: Authorization: Basic YXBpa2V5OmFwaXNlY3JldA==

Ahol a kódolt adat az apikey:apisecret base64 enkódolva. Ezeket az API Key/Secret párosokat az RS3 Ügyviteli Rendszer szervizfunkciók részben lehet beállítani, kiosztani akár eszköz szinten, beállítva azt, hogy melyik végponthoz férhet hozzá az API Key.

Raktárak

cél
raktárak lekérdezése
endpoint
/getWarehouses
példa
https://monolitepszer.api.rs3.hu/getWarehouses
method
GET
válasz

warehouses tartalmazza a raktárakat, azon belül a raktár RS3-beli kódját, megnevezését és státuszát (használatban van-e vagy sem)

adatok
mező magyarázat
warehouse
rkod

raktár RS3-beli kódja (egyedi ID)

megnev

raktár megnevezése

statusz

használatban van-e (0 - nem, 1- igen)

{
  "warehouses": {
    "warehouse": [{
      "rkod": 1,
      "megnev": "RAKTÁR 1",
      "statusz": 1
    }, {
      "rkod": 2,
      "megnev": "RAKTÁR 2",
      "statusz": 0
    }, {
      "rkod": 3,
      "megnev": "SELEJT",
      "statusz": 1
    }, {
      "rkod": 4,
      "megnev": "RAKTÁR (TELEPHELY)",
      "statusz": 1
    }, {
      "rkod": 5,
      "megnev": "RAKTÁR (TELEPHELY #2)",
      "statusz": 1
    }]
  }
}

Beállítások

cél

beállítás lekérdezése, a fejlesztés során ha egy külső rendszernek figyelnie kell egy beállítást, úgy az RS3 részéről a megnevezés neve közölve lesz

endpoint
/getSetting
példa
https://monolitepszer.api.rs3.hu/getSetting?name=beallitas_megnev
method
GET
válasz

pl.: getSetting?name=arsavmegn1 amely tartalmazza a beállítás nevét és értékét, arsavmegn2 .. arsavmegn8 pedig a többi ársáv megnevezését

{
  "setting": {
    "megnev": "arsavmegn1",
    "ertek": "1. ársáv"
  }
}

Termék adatlap

cél
termék lekérése termékkód vagy EAN alapján
endpoint
/getProduct
példa
https://monolitepszer.api.rs3.hu/getProduct?tkod=[base64 kódolva a termékkód]
https://monolitepszer.api.rs3.hu/getProduct?ean=[base64 kódolva az EAN]

Példa #1: /getProduct?tkod=UlMzLTAwMDAx
Példa #2: /getProduct?ean=MjAwMDAwMDAwMDAxNQ==

Mivel 1 vonalkód több termékhez is lehet rögzítve, ezért products/product formában adja vissza az eredményt

opcionálisan hozzáfűzhető a paraméterlistához az &image=1 is, ekkor a képek is visszaadásra kerülnek

method
GET
válasz

ami termékkódra való lekérés esetben 1 product tag-et tartalmaz, EAN-ra való lekérés esetén több is lehet

adatok
mező magyarázat
product
tkod

termékkód

ean

termék vonalkód

megnev

termék megnevezés

ar1

`Ársáv 1` nettó ár

ar2

`Ársáv 2` nettó ár

ar3

`Ársáv 3` nettó ár

ar4

`Ársáv 4` nettó ár

ar5

`Ársáv 5` nettó ár

ar6

`Ársáv 6` nettó ár

ar7

`Ársáv 7` nettó ár

ar8

`Ársáv 8` nettó ár

keszl

termék teljes készlete

lefoglalva

termék összes foglalt készlet

me

mennyiségi egység

gyujtocikk

gyűjtőcikk flag

tarhelyes

be van-e kapcsolva a terméknél a tárhelykezelés

idobelyeg

felvitel vagy módosítás dátuma

location

A tag csak akkor van jelen, ha a termékhez van rendelve raktári hely. 1 terméknek 1 raktárban csak 1 raktári helye lehet, nem tévesztendő össze a tárhellyel, ahol is 1 raktárban tetszőleges számú tárhelyen lehet a termék készlettel.

rkod

raktárkód

raktarihely

raktári hely megnevezése

image

A tag csak akkor van jelen, ha a termékhez van kép rendelve és image=1-gyel történt a kérés. Első helyen a termék elsődleges képe, ezt követően a további hozzárendelt képek kerülnek felsorolásra.

id

a kép RS3-beli egyedi azonosítója. Megjegyzés: 1 kép több termékhez is hozzá lehet rendelve

data

a termék base64 kódolt adata

hash

a termékkép MD5 hash-e

{
  "result": {
    "products": {
      "product": [{
        "tkod": "RS3-00001",
        "ean": "2000000000015",
        "megnev": "Gigabyte RTX 3060 12GB OC GDDR6 192bit LHR",
        "ar1": "166141.732284",
        "ar2": "0.000000",
        "ar3": "0.000000",
        "ar4": "0.000000",
        "ar5": "0.000000",
        "ar6": "0.000000",
        "ar7": "0.000000",
        "ar8": "0.000000",
        "keszl": "8.0000",
        "lefoglalva": "5.0000",
        "me": "db",
        "gyujtocikk": "N",
        "tarhelyes": "N",
        "idobelyeg": "2022-07-02 11:55:45",
        "locations": {
          "location": [{
            "rkod": 1,
            "raktarihely": "Raktári hely 09891"
          }, {
            "rkod": 2,
            "raktarihely": "Raktári hely 09176"
          }]
        },
        "images": {
          "image": [{
            "id": 1,
            "data": "[base64 data]",
            "hash": "473cd72d39ef8be910481f9627528fe5"
          }, {
            "id": 2,
            "data": "[base64 data]",
            "hash": "04c0cb1fa48fe6e48a2ff590aeba2825"
          }, {
            "id": 37,
            "data": "[base64 data]",
            "hash": "693bb6ec23e07fb4b945d82826fdd731"
          }]
        }
      }]
    }
  }
}

Terméklista

cél
termékek lekérdezése lapozható formában
endpoint
/getProductList
példa
kötelező paraméterek
  • page (értéke nullától nagyobb), hanyadik oldalt kérdezzük le
  • limit (értéke 1-200 tartományban van értelmezve), hány elem jelenjen meg 1 lekérésben

megjegyzés: ha page=1-gyel lekérve a pageCount 1, akkor nem szükséges további oldalakat lekérni, mert nem lesz találat



opcionális paraméterek
  • updatedAtMin 2022-07-02T15:08:33 formában
  • image (értéke 0 vagy lehet, 1 esetén a képek is belekerülnek a válaszba base64 kódolva)

https://monolitepszer.api.rs3.hu/getProductList?page=1&limit=200, ahol a page az oldalszámot jelenti, limit pedig az egy kérésben visszaadott termékek darabszámát. A válaszban szereplő pageCount jelzi azt, hogy vannak-e további oldalak. 1-től eltérő érték esetén a page értékét növelve lehet lekérni a következő oldalt (pageCount-ig).

Opcionálisan küldhető paraméter az updatedAtMin, amely egy időbélyeget vár el és csak azokat a termékeket fogja visszadni, amelyek azóta változtak, vagy azóta lettek létrehozva, ilyen esetben a további oldalak lapozása során is küldeni kell ezt az időbélyeget. Pl.: https://monolitepszer.api.rs3.hu/getProductList?page=1&limit=200&updatedAtMin=2022-07-02T15:08:33

method
GET
válasz

pageCount-ban az oldalak száma a limit függvényében, page az aktuális oldal, limit a küldött limit, products-ban pedig a termékek

adatok
struktúra ugyanaz, mint Termék adatlap végpontál
{
  "result": {
    "page": "2",
    "pageCount": "17",
    "limit": "3",
    "products": {
      "product": [{
        "tkod": "41354",
        "ean": "2000000000275",
        "megnev": "Kanlux mennyezeti és oldalfali 2-es spot lámpatest MOLI EL-2I GU10",
        "ar1": "3362.204725",
        "ar2": "3228.346458",
        "ar3": "0.000000",
        "ar4": "0.000000",
        "ar5": "0.000000",
        "ar6": "0.000000",
        "ar7": "0.000000",
        "ar8": "0.000000",
        "keszl": "0.0000",
        "lefoglalva": "0.0000",
        "me": "db",
        "gyujtocikk": "N",
        "tarhelyes": "N",
        "idobelyeg": "2022-07-02 11:15:21"
      }, {
        "tkod": "RS3-00001",
        "ean": "2000000000015",
        "megnev": "Gigabyte RTX 3060 12GB OC GDDR6 192bit LHR",
        "ar1": "166141.732284",
        "ar2": "0.000000",
        "ar3": "0.000000",
        "ar4": "0.000000",
        "ar5": "0.000000",
        "ar6": "0.000000",
        "ar7": "0.000000",
        "ar8": "0.000000",
        "keszl": "8.0000",
        "lefoglalva": "5.0000",
        "me": "db",
        "gyujtocikk": "N",
        "tarhelyes": "N",
        "idobelyeg": "2022-07-02 11:55:45",
        "locations": {
          "location": [{
            "rkod": 1,
            "raktarihely": "Raktári hely 09891"
          }, {
            "rkod": 2,
            "raktarihely": "Raktári hely 09176"
          }]
        },
        "images": {
          "image": [{
            "id": 1,
            "data": "[base64 data]",
            "hash": "473cd72d39ef8be910481f9627528fe5"
          }, {
            "id": 2,
            "data": "[base64 data]",
            "hash": "04c0cb1fa48fe6e48a2ff590aeba2825"
          }, {
            "id": 37,
            "data": "[base64 data]",
            "hash": "693bb6ec23e07fb4b945d82826fdd731"
          }]
        }
      }, {
        "tkod": "RS3-00002",
        "ean": "2000000000022",
        "megnev": "Duracell Basic AA MN1500 ceruza (LR6) alkáli elem bl\/4",
        "ar1": "135.540946",
        "ar2": "0.000000",
        "ar3": "0.000000",
        "ar4": "0.000000",
        "ar5": "0.000000",
        "ar6": "0.000000",
        "ar7": "0.000000",
        "ar8": "0.000000",
        "keszl": "0.0000",
        "lefoglalva": "0.0000",
        "me": "db",
        "gyujtocikk": "N",
        "tarhelyes": "N",
        "idobelyeg": "2022-06-24 11:38:50",
        "images": {
          "image": [{
            "id": 3,
            "data": "[base64 data]",
            "hash": "cbf6e26853879fb5e8900b6a2fd2cb12"
          }, {
            "id": 4,
            "data": "[base64 data]",
            "hash": "902a88cd1fb7333f893367dc57d6ae6e"
          }]
        }
      }]
    }
  }
}

Termékkészlet lekérdezése

cél
termék készletének lekérdezése
endpoint
/getProductQuantity
küldhető adatok
  • termékkód (kötelező)
  • vonalkód (opcionális, csak gyűjtőcikk esetén kerül figyelembevételre, küldés esetén a gyűjtővonalkódon található készletet adja vissza, egyébként a termék készletét)

  • raktárkód (opcionális, ha nincs küldve, akkor összes raktár készletét adja vissza raktárankénti bontásban)

példa
https://monolitepszer.api.rs3.hu/getProductQuantity
method
POST
POST-olt adat
{
  "tkod": "RS3-00001",
  "ean": "123456789012",
  "rkod": "1"
}
válasz

sima termékkódra lekérés rkod nélkül: stocks részben vannak a készlet-adatok raktárankénti bontásban, amennyiben volt raktárszűrés, akkor csak adott raktár készletét adja vissza

adatok
mező magyarázat
stock
rkod

raktar RS3-bali kódja

keszl

termék adott raktárbeli készlet

lefoglalva

termék adott raktárbeli foglalt készlete, készletet foglalhat megrendelés és gyártási utasítás

{
  "result": {
    "statusz": "ok",
    "uzenet": "Művelet sikeres",
    "tkod": "RS3-00001",
    "stocks": {
      "stock": [{
        "rkod": 1,
        "keszl": "7.0000",
        "lefoglalva": "0.0000"
      }, {
        "rkod": 4,
        "keszl": "1.0000",
        "lefoglalva": "0.0000"
      }]
    }
  }
}

Termékkészlet módosítás

cél

termék készletének beállítása adott raktárban adott mennyiségre (kvázi leltár)

endpoint
/setProductQuantity
példa
https://monolitepszer.api.rs3.hu/setProductQuantity

Küldeni kell a raktárkódot, a termékkódot (gyűjtőcikk esetén EAN-t is) és az új mennyiséget

method
POST
POST-olt adat
{
  "rkod": "1",
  "tkod": "RS3-00001",
  "ean": "gyűjtőcikk esetén kötelező, egyéb esetben nem kerül feldolgozásra",
  "mennyiseg": "42",
  "megjegyzes": "opcionális megjegyzés"
}
válasz

sikeres művelet esetén a létrejött készletbizonylat kódját adja vissza

{
  "result": {
    "statusz": "ok",
    "uzenet": "Művelet sikeres",
    "kod": 3
  }
}

Rendelések lekérdezése

cél

rendelések lekérdezése megadott feltétel szerint (pl: nyitottak, vagy egy adott megrendelés kódra)

endpoint
/getOrders
példa
  • page (értéke nullától nagyobb), hanyadik oldalt kérdezzük le

  • limit (értéke 1-200 tartományban van értelmezve), hány elem jelenjen meg 1 lekérésben

megjegyzés: ha page=1-gyel lekérve a pageCount 1, akkor nem szükséges további oldalakat lekérni, mert nem lesz találat



https://monolitepszer.api.rs3.hu/getOrders?page=1&limit=200&status=PENDING - nyitott rendelések lekérdezése (ebben az esetben minden paraméter kötelező)
https://monolitepszer.api.rs3.hu/getOrders?mkod=100000 - lekérdezés rendelés kódjára. A visszaadott rendelés státuszai az alábbiak lehetnek.

  • PENDING - nyitott rendelés (összekészítésre vár vagy folyamatban van az összeszedés)

  • DONE - összekészített rendelés

  • ARCHIVED - archivált rendelés (pl.: kiszámlázták)

  • DELETED - törölt rendelés

RS3-ban a rendelésnek 3 technika státusza van

  • normál (újonnan felvitt vagy webshopból érkezett rendelés)

  • archivált (amikor kiszámlázták a rendelést, automatikusan archiválódik)

  • törölt (visszamondták vagy nem tudják / akarják kiszolgálni)

RS3-ban a rendelésnek az alábbi egyéb státuszai lehetnek (2-szakaszos kiadásnál értelmezettek)

  • státuszváltoztatásra vár: RS3 úgy van beállítva, hogy a felvitt, vagy webáruházból érkezett rendelés nem kerül egyből raktári feladatba, hanem egy arra jogosult személy tesz úgynevezett szedhető állapotba

  • beszerzés alatt
  • szedhető
  • összekészítve

A nyitott rendelések végponti lekérés a normál technikai státuszú szedhető állapotban lévő rendeléseket adja vissza.

1-szakaszos kiadási módban a raktári feladatba küldött normál technikai státuszú rendeléseket adja vissza.

method
GET
válasz

Rendelés fej és tételek, tételek esetén csak a készletkezelt termékeket adja vissza, szolgáltatási termékeket (szállítási díj, utánvét, kedvezmény) nem. A válasz tartalmazza a feltételek szerinti rendelés(eke)t és azok tételeit orders/order formában

adatok
mező magyarázat
order
mkod

megrendelés RS3-beli kódja (egyedi ID)

megrendelesszam

rendelés száma (nincs mindig töltve)

vkod

vevő RS3-bali kódja (egyedi ID)

megnev

vevő neve

orszag

számlázási cím ország

irsz

számlázási cím irányítószám

varos

számlázási cím település

utca

számlázási cím cím

vegosszeg

rendelés nettó értéke alapdevizában (pl.: HUF)

vegbrutto

rendelés bruttó értéke alapdevizában (pl.: HUF)

devizaveg

rendelés nettó értéke devizában

devizavegbrutto

rendelés brutto értéke devizában

penznem

rendelés pénzneme

arfolyam

rendelés árfolyama

szallorszag

szállítási cím ország

szallirsz

szállítási cím irányítószám

szallvaros

szállítási cím település

szallutca

szállítási cím cím

szalltel

szállítási cím telefonszám

megj

bizonylat megjegyzés

datum

felvitel, vagy módosítás dátuma

fizmod

fizetési mód kód

  • K - készpénz
  • U - utánvét
  • Á - átutalás
  • E - előre utalás
  • V - bankkártyás
fizmodleiras

fizetési mód leírása

kiszallitas

szállítási mód kód (vannak beépített és szabadon felvihető szállítási módok) (F - futár, H - helyszíni átvétel a beépítettek)

kiszallitasleiras

szállítási mód leírás

futarceg

fix pontra szállítás esetén van töltve

  • MPLPOSTSTAY - Postán maradó
  • MPLPOSTPOINT - Posta Pont
  • MPLPARCELMACHINE - Csomagautomata
  • GLSPARCELSHOP - GLS csomagpont
  • PICKPACKPONT - Pick Pack Pont

futarcegpointid

szállítást végző cég adatbázisából lekérhető rekordok egyedi azonosítója

futarcegleiras

fix ponti szállítás leírása

shoprenterorderid

ShopRenter felől jövő rendelés egyedi azonosítója (integer)

unasorderkey

UNAS felől jövő rendelés kulcsa (string, pl.: 5886-183565)

opencart1orderid

OpenCart #1 webáruház felől jövő rendelés egyedi azonosítója (integer)

opencart2orderid

OpenCart #2 webáruház felől jövő rendelés egyedi azonosítója (integer)

opencart3orderid

OpenCart #3 webáruház felől jövő rendelés egyedi azonosítója (integer)

status

rendelés státusza

order_item
id

rendelés tétel egyedi ID-ja

tkod

a tétel termékkódja

ean

a tétel EAN-ja (gyújtőcikknél mindig töltve van)

megnev

a tétel megnevezése

menny

a tétel mennyisége

me

a tétel mennyiség egysége

ar

a tétel nettó egységára

afa

a tétel ÁFA kulcsa

tomeg

a tétel termékének egységnyi tömege (1 mennyiségi egységre vonatkozóan)

megj

a tételhez fűzött megjegyzés

vansorszam

sorozatszámos-e a termék

tarhelyes

tárhelyes-e a termék

sarzsos

sarzsos-e a termék

gyujtocikk

gyűjtőcikk-e a termék

rendez

a tétel sorrendje a bizonylaton belül

allocatedQuantities

a tételhez API-keresztül elvégzett korábbi allokációk (rkod, quantity). Tegyük fel van egy frissen rögzített rendelés, ilyen esetben, mivel nem volt még rá API-s összekészítés, ez a tag üres lesz. API-n keresztül megtörténik az összekészítés, de további módosításokat hajtanak végre a rendelésen (RS3-ban) Pl. mennyiséget növel egy tételnél, vagy új tételt visz fel. Ilyen esetben az a rész már tartalmazni fogja a korábbi összeszedés allokációit, amelyet nem kötelező felhasználni, de elméletileg a távoli rendszer adatainak meg kell egyeznie a küldöttel.

{
  "result": {
    "page": "1",
    "pageCount": "1",
    "limit": "50",
    "orders": {
      "order": [{
        "mkod": 100000,
        "megrendelesszam": "DBM22-00001",
        "vkod": 27,
        "megnev": "Gipsz Jakab",
        "orszag": "Magyarország",
        "irsz": "4400",
        "varos": "Nyíregyháza",
        "utca": "Vécsey köz 11\/A",
        "vegosszeg": "45473.0000",
        "vegbrutto": "57750.0000",
        "devizaveg": "45473.0000",
        "devizavegbrutto": "57750.0000",
        "penznem": "HUF",
        "arfolyam": "1.000000",
        "szallneve": "Gipsz Jakab",
        "szallorszag": "Magyarország",
        "szallirsz": "4400",
        "szallvaros": "Nyíregyháza",
        "szallutca": "Vécsey köz 11\/A",
        "szalltel": "",
        "megj": "",
        "datum": "2022-06-30 15:32:28",
        "fizmod": "U",
        "fizmodleiras": "utánvét",
        "kiszallitas": "C",
        "kiszallitasleiras": "MPL Csomagautomata",
        "futarceg": "MPLPARCELMACHINE",
        "futarcegpointid": "105877",
        "futarcegleiras": "16 sz. automata - Avas Tesco",
        "shoprenterorderid": "31",
        "unasorderkey": "",
        "opencart1orderid": "",
        "opencart2orderid": "",
        "opencart3orderid": "",        
        "status": "PENDING",
        "order_items": {
          "order_item": [{
            "id": 3000,
            "tkod": "RS3-00017",
            "ean": "2000000000190",
            "megnev": "Piros alma",
            "menny": "100.0000",
            "me": "kg",
            "ar": "330.710000",
            "afa": 27,
            "tomeg": "1.000000",
            "megj": "",
            "vansorszam": "N",
            "tarhelyes": "N",
            "sarzsos": "N",
            "gyujtocikk": "N",
            "rendez": 1,
            "allocatedQuantities": []
          }, {
            "id": 3001,
            "tkod": "RS3-00018",
            "ean": "2000000000206",
            "megnev": "Zöld alma",
            "menny": "30.0000",
            "me": "kg",
            "ar": "413.390000",
            "afa": 27,
            "tomeg": "1.000000",
            "megj": "",
            "vansorszam": "N",
            "tarhelyes": "N",
            "sarzsos": "N",
            "gyujtocikk": "N",
            "rendez": 2,
            "allocatedQuantities": []
          }]
        }
      }, {
        "mkod": 100001,
        "megrendelesszam": "DBM22-00002",
        "vkod": 30,
        "megnev": "Teszt cég Kft.",
        "orszag": "Magyarország",
        "irsz": "9000",
        "varos": "Győr",
        "utca": "Véndiófa utca. 12.",
        "vegosszeg": "1368110.0000",
        "vegbrutto": "1737500.0000",
        "devizaveg": "1368110.0000",
        "devizavegbrutto": "1737500.0000",
        "penznem": "HUF",
        "arfolyam": "1.000000",
        "szallneve": "Teszt cég Kft.",
        "szallorszag": "Magyarország",
        "szallirsz": "9000",
        "szallvaros": "Győr",
        "szallutca": "Bácsai út 140.",
        "szalltel": "",
        "megj": "",
        "datum": "2022-06-30 15:33:27",
        "status": "PENDING",
        "order_items": {
          "order_item": [{
            "id": 3002,
            "tkod": "RS3-00032",
            "ean": "2000000000930",
            "megnev": "Gigabyte GA-Z390 AORUS ELITE Intel Z390 LGA1151 ATX alaplap",
            "menny": "10.0000",
            "me": "db",
            "ar": "53740.160000",
            "afa": 27,
            "tomeg": "0.000000",
            "megj": "",
            "vansorszam": "N",
            "tarhelyes": "N",
            "sarzsos": "N",
            "gyujtocikk": "N",
            "rendez": 1,
            "allocatedQuantities": []
          }, {
            "id": 3003,
            "tkod": "RS3-00001",
            "ean": "2000000000015",
            "megnev": "Gigabyte RTX 3060 12GB OC GDDR6 192bit LHR",
            "menny": "5.0000",
            "me": "db",
            "ar": "166141.730000",
            "afa": 27,
            "tomeg": "1.500000",
            "megj": "",
            "vansorszam": "N",
            "tarhelyes": "N",
            "sarzsos": "N",
            "gyujtocikk": "N",
            "rendez": 2,
            "allocatedQuantities": []
          }]
        }
      }]
    }
  }
}

Rendelés módosítás

cél

rendelés módosítása küldött adatok alapján

endpoint
/modifyOrders
példa

https://monolitepszer.api.rs3.hu/modifyOrders

Fejben küldeni kell az érintett rendelés RS3-beli kódját (mkod), a rendelés státuszát (PENDING vagy DONE), ez azért szükséges, hogy a módosítás végrahajtása után összekészített legyen-e a rendelés vagy sem.

Tételeknél küldeni kell a rendeléstétel ID-ját (törlésnél vagy módosításnál) és küldeni kell az összeszedett mennyiségeket raktáranként. Tételek esetén az action kötelező elem és 3 értéket vehet fel: ADD, MODIFY, DELETE. Alap esetben ha a teljes rendelés kiszolgálható, akkor MODIFY fog mindenhol szerepelni.

Amennyiben adott tételt nem tudjuk kiszolgálni és törölni, vagy cserélni szeretnénk adott tételt, akkor a törlendő tételt DELETE-tel, az új tételt pedig ADD-dal kell küldeni. Nem kötelező törölni az olyan tételeket, amelyeket nem tudunk kiszolgálni, mert az RS3-ban szállítólevélbe/számlába átforgatáskor az összeszedett mennyiséggel fog továbbmenni, nyilván ott ahol az összekészített mennyiség 0, az a tétel nem fog rákerülni a szállítólevélre vagy számlára. Az ADD action-nel küldött tételek esetén értelemszerűen az id adatot nem kell tölteni.

Az order_item/allocatedQuantities szekcióban a különböző raktárakból kiallokált mennyiségeket kell küldeni raktárkóddal, mennyiséggel. Az order_item/allocatedQuantities rész elhagyható, ebben az esetben a korábbi összekészíteseket törli, vagy ha nem volt még rá összekészítés, akkor nem változtat semmi.

Az order-t iterálva több rendelés is beküldhető egyszerre módosításra. Maximum 20 rendelés küldhető be egy kérésben.

POST-olt adat
adatok
mező magyarázat kötelező
order
mkod

megrendelés RS3-beli kódja (egyedi ID)

igen

status

rendelés státusza, lehetséges értékek: DONE - összekészítve, PENDING - nincs még összekészítve

igen

comment

rendelés bizonylatmegjegyzés, ha nincs küldve, akkor az RS3-ban megadottat nem írja felül, egyébként igen, akkor is, ha üres (maximum 255 karakter)

nem

order_item
id

rendelés tétel RS3-beli egyedi ID-ja (MODIFY és DELETE action esetén kötelező)

nem

tkod

rendelés tétel termékkódja

igen

ean

rendelés tétel vonalkódja, gyűjtőcikknél kötelező, egyéb esetben nem kerül feldolgozásra.

nem

action

lehetséges értékek: ADD, MODIFY, DELETE. Egy normál összeszedés esetén (ahol minden termék részben vagy egészben kiszolgálható és nincs törlés vagy csere vagy új tétel) minden tétel MODIFY-jal fog beérkezni, de lehetőség van törölni és új tételt hozzáadni a rendeléshez.

igen

quantity

csak új tétel (ADD) esetén kerül feldolgozásra (ekkor kötelező), az új rendelés-tétel mennyiségét jelenti

nem

price

csak új tétel (ADD) esetén kerül feldolgozásra (ekkor kötelező), az új rendelés-tétel nettó árát jelenti

nem

comment

rendelés tételhez fűzött megjegyzés, ha nincs küldve, akkor az RS3-ban megadottat nem írja felül, egyébként igen, akkor is, ha üres (maximum 255 karakter)

nem

allocatedQuantities

Raktárból kiallokált (sikeresen összekészített) mennyisegek raktáranként. Amenyiben nincs küldve, úgy a tételhez korábban küldött összekészítési adatok törlésre kerülnek, ezért ha egy tételhez már létezik allokáció akkor azt minden esetben küldeni kell még ha nem is ez a tétel változott, mert az előző allokációkat törli és a küldött adatok alapján fogja meghatározni az összekészített mennyiséget.

nem

Példa 1
Minden mennyiség kiszolgálható, a rendelés új státusza DONE, azaz összekészítve
{
  "orders": {
    "order": [
      {
        "mkod": 100000,
        "status": "DONE",
        "comment": "Megjegyzés a rendeléshez, ha nincs comment tag küldve, akkor nem írja felül, egyébként igen",
        "order_items": {
          "order_item": [
            {
              "id": 3000,
              "tkod": "RS3-00017",
              "action": "MODIFY",
              "comment": "megjegyzés a rendelés tételhez, ha nincs comment tag küldve, akkor nem írja felül, egyébként igen",
              "allocatedQuantities": {
                "allocatedQuantity": [
                  {
                    "rkod": 1,
                    "quantity": 100
                  }
                ]
              }
            },
            {
              "id": 3001,
              "tkod": "RS3-00018",
              "action": "MODIFY",
              "allocatedQuantities": {
                "allocatedQuantity": [
                  {
                    "rkod": 1,
                    "quantity": 30
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
Példa 2
Egyik tétel részben kiszolgálható csak, a rendelés új státusz DONE, azaz összekészítve
{
  "orders": {
    "order": [
      {
        "mkod": 100000,
        "status": "DONE",
        "comment": "Megjegyzés a rendeléshez, ha nincs comment tag küldve, akkor nem írja felül, egyébként igen",
        "order_items": {
          "order_item": [
            {
              "id": 3000,
              "tkod": "RS3-00017",
              "action": "MODIFY",
              "comment": "megjegyzés a rendelés tételhez, ha nincs comment tag küldve, akkor nem írja felül, egyébként igen",
              "allocatedQuantities": {
                "allocatedQuantity": [
                  {
                    "rkod": 1,
                    "quantity": 100
                  }
                ]
              }
            },
            {
              "id": 3001,
              "tkod": "RS3-00018",
              "action": "MODIFY",
              "allocatedQuantities": {
                "allocatedQuantity": [
                  {
                    "rkod": 1,
                    "quantity": 20
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
Példa 3
Egyik tétel törlésre kerül, egy termék pedig hozzáadva (pl.: csere)
{
  "orders": {
    "order": [
      {
        "mkod": 100000,
        "status": "DONE",
        "order_items": {
          "order_item": [
            {
              "id": 3000,
              "tkod": "RS3-00017",
              "action": "MODIFY",
              "allocatedQuantities": {
                "allocatedQuantity": [
                  {
                    "rkod": 1,
                    "quantity": 100
                  }
                ]
              }
            },
            {
              "id": 3001,
              "tkod": "RS3-00018",
              "action": "DELETE"
            },
            {
              "tkod": "RS3-00052",
              "action": "ADD",
              "quantity": 30,
              "price": "433.070000",
              "allocatedQuantities": {
                "allocatedQuantity": [
                  {
                    "rkod": 1,
                    "quantity": 30
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
method
POST
válasz

A válasz vagy hibaüzenet vagy visszajelzés, hogy a művelet sikeres, az érintett rendelések kódjai vesszővel elválasztva. Csak akkor hajtódnak végre a változások, ha minden rendelés minden tétele rendben van, tehát nincs olyan, hogy az egyik rendelés sikeresen ment be, de egy másik rendelés nem, mint ahogy az sem hogy egy rendelés küldése esetén egyik termék művelete sikeres, egy másiké nem.

{
  "result": {
    "statusz": "ok",
    "uzenet": "Művelet sikeres",
    "mkod": "100000,100001"
  }
}

Bevételezések lekérdezése

cél

bevét bizonylatok lekérdezése megadott feltétel szerint (pl: bizonylat kelte, vagy egy adott bevétbizonylat kódra) lapozható formában

endpoint
/getPurchases
példa
  • page (értéke nullától nagyobb), hanyadik oldalt kérdezzük le

  • limit (értéke 1-200 tartományban van értelmezve), hány elem jelenjen meg 1 lekérésben

  • fromDate dátumtól, valid dátum

  • toDate dátumig, valid dátum

megjegyzés: ha page=1-gyel lekérve a pageCount 1, akkor nem szükséges további oldalakat lekérni, mert nem lesz találat



https://monolitepszer.api.rs3.hu/getPurchases?page=1&limit=200&fromDate=2022-06-01&toDate=2022-06-03 (ebben az esetben minden paraméter kötelező)
https://monolitepszer.api.rs3.hu/getPurchases?bkod=100000 - lekérdezés bevételezés kódjára (itt semmilyen egyéb paraméter nem kerül figyelembevételre).

method
GET
válasz

Bevételezés fej és tételek, tételek esetén csak a készletkezelt termékeket adja vissza, szolgáltatási termékeket (szállítási díj, utánvét, kedvezmény) nem. Csak a készletet érintő bevét-bizonylatokat adja vissza purchases/purchase formában (pl.: összevont bevét számlákat, bizományos bevét számlákat nem)

adatok
mező magyarázat
purchase
bkod

bevételezés RS3-beli kódja (egyedi ID)

szallitolevszam

szállítólevél száma

szamlaszam

számlaszám

szamlakelte

bizonylat kelte

teljesites

bizonylat teljesítési dátuma

fizmod

fizetési mód

  • K - készpénz
  • Á - átutalás
  • B - belső
  • V - bankkártya
  • E - előre utalás
  • C - csekk
  • U - utánvét
  • I - inkasszó

beszkod

beszállító RS3-bali kódja (egyedi ID)

megnev

beszállító neve

orszag

számlázási cím ország

irsz

számlázási cím irányítószám

varos

számlázási cím település

utca

számlázási cím cím

vegosszeg

bizonylat nettó értéke alapdevizában (pl.: HUF)

vegbrutto

bizonylat bruttó értéke alapdevizában (pl.: HUF)

devizaveg

bizonylat nettó értéke devizában

devizavegbrutto

bizonylat brutto értéke devizában

penznem

bizonylat pénzneme

arfolyam

bizonylat árfolyama

megj

bizonylat megjegyzés

datum

felvitel, vagy módosítás dátuma

purchase_item
id

bizonylat tétel egyedi ID-ja

tkod

a tétel termékkódja

ean

a tétel EAN-ja (gyújtőcikknél mindig töltve van)

megnev

a tétel megnevezése

menny

a tétel mennyisége

me

a tétel mennyiség egysége

ar

a tétel nettó egységára

afa

a tétel ÁFA kulcsa

tomeg

a tétel termékének egységnyi tömege (1 mennyiségi egységre vonatkozóan)

megj

a tételhez fűzött megjegyzés

vansorszam

sorozatszámos-e a termék

tarhelyes

tárhelyes-e a termék

sarzsos

sarzsos-e a termék

gyujtocikk

gyűjtőcikk-e a termék

rendez

a tétel sorrendje a bizonylaton belül

{
  "result": {
    "page": "1",
    "pageCount": "1",
    "limit": "100",
    "purchases": {
      "purchase": [{
        "bkod": 5,
        "szallitolevszam": "SZL 0001",
        "szamlaszam": "",
        "szamlakelte": "2022-07-01",
        "teljesites": "2022-07-01",
        "fizmod": "Á",
        "beszkod": 4,
        "megnev": "Penta Familia Szövetkezet",
        "orszag": "Magyarország",
        "irsz": "4445",
        "varos": "Nagycserkesz",
        "utca": "Vasvári Pál u. 2.",
        "vegosszeg": "2277165.0000",
        "vegbrutto": "2892000.0000",
        "devizaveg": "2277165.0000",
        "devizavegbrutto": "2892000.0000",
        "penznem": "HUF",
        "arfolyam": "1.000000",
        "megj": "",
        "datum": "2022-07-01 15:44:59",
        "purchase_items": {
          "purchase_item": [{
            "id": 9,
            "tkod": "RS3-00017",
            "ean": "2000000000190",
            "megnev": "Piros alma",
            "menny": "10000.0000",
            "me": "kg",
            "ar": "216.535400",
            "afa": 27,
            "tomeg": "1.000000",
            "megj": "",
            "vansorszam": "N",
            "tarhelyes": "N",
            "sarzsos": "N",
            "gyujtocikk": "N",
            "rendez": 1
          }, {
            "id": 10,
            "tkod": "RS3-00018",
            "ean": "2000000000206",
            "megnev": "Zöld alma",
            "menny": "400.0000",
            "me": "kg",
            "ar": "279.527600",
            "afa": 27,
            "tomeg": "1.000000",
            "megj": "",
            "vansorszam": "N",
            "tarhelyes": "N",
            "sarzsos": "N",
            "gyujtocikk": "N",
            "rendez": 2
          }]
        }
      }, {
        "bkod": 6,
        "szallitolevszam": "SZL 0002",
        "szamlaszam": "",
        "szamlakelte": "2022-07-01",
        "teljesites": "2022-07-01",
        "fizmod": "Á",
        "beszkod": 4,
        "megnev": "Penta Familia Szövetkezet",
        "orszag": "Magyarország",
        "irsz": "4445",
        "varos": "Nagycserkesz",
        "utca": "Vasvári Pál u. 2.",
        "vegosszeg": "30709.0000",
        "vegbrutto": "39000.0000",
        "devizaveg": "30709.0000",
        "devizavegbrutto": "39000.0000",
        "penznem": "HUF",
        "arfolyam": "1.000000",
        "megj": "",
        "datum": "2022-07-01 15:45:22",
        "purchase_items": {
          "purchase_item": [{
            "id": 11,
            "tkod": "RS3-00021",
            "ean": "2000000000305",
            "megnev": "Zöldhagyma",
            "menny": "300.0000",
            "me": "db",
            "ar": "102.362200",
            "afa": 27,
            "tomeg": "0.010000",
            "megj": "",
            "vansorszam": "N",
            "tarhelyes": "N",
            "sarzsos": "N",
            "gyujtocikk": "N",
            "rendez": 1
          }]
        }
      }, {
        "bkod": 8,
        "szallitolevszam": "",
        "szamlaszam": "INV-1212989",
        "szamlakelte": "2022-07-01",
        "teljesites": "2022-07-01",
        "fizmod": "Á",
        "beszkod": 1,
        "megnev": "Computer Emporium Kft.",
        "orszag": "Magyarország",
        "irsz": "1131",
        "varos": "Budapest",
        "utca": "Reitter Ferenc u. 132",
        "vegosszeg": "1147087.0000",
        "vegbrutto": "1456800.0000",
        "devizaveg": "1147087.0000",
        "devizavegbrutto": "1456800.0000",
        "penznem": "HUF",
        "arfolyam": "1.000000",
        "megj": "",
        "datum": "2022-07-01 15:47:21",
        "purchase_items": {
          "purchase_item": [{
            "id": 15,
            "tkod": "RS3-00032",
            "ean": "2000000000930",
            "megnev": "Gigabyte GA-Z390 AORUS ELITE Intel Z390 LGA1151 ATX alaplap",
            "menny": "10.0000",
            "me": "db",
            "ar": "44433.070900",
            "afa": 27,
            "tomeg": "0.000000",
            "megj": "",
            "vansorszam": "N",
            "tarhelyes": "N",
            "sarzsos": "N",
            "gyujtocikk": "N",
            "rendez": 1
          }, {
            "id": 16,
            "tkod": "RS3-00001",
            "ean": "2000000000015",
            "megnev": "Gigabyte RTX 3060 12GB OC GDDR6 192bit LHR",
            "menny": "5.0000",
            "me": "db",
            "ar": "140551.181100",
            "afa": 27,
            "tomeg": "1.500000",
            "megj": "",
            "vansorszam": "N",
            "tarhelyes": "N",
            "sarzsos": "N",
            "gyujtocikk": "N",
            "rendez": 2
          }]
        }
      }]
    }
  }
}

Eladások lekérdezése

cél

eladási bizonylatok lekérdezése megadott feltétel szerint (pl: teljesítés dátum szerint, vagy egy adott bizonylat kódra) lapozható formában

endpoint
/getSales
példa
  • page (értéke nullától nagyobb), hanyadik oldalt kérdezzük le

  • limit (értéke 1-200 tartományban van értelmezve), hány elem jelenjen meg 1 lekérésben

  • fromDate dátumtól, valid dátum

  • toDate dátumig, valid dátum

megjegyzés: ha page=1-gyel lekérve a pageCount 1, akkor nem szükséges további oldalakat lekérni, mert nem lesz találat



https://monolitepszer.api.rs3.hu/getSales?page=1&limit=200&fromDate=2022-06-01&toDate=2022-06-03 (ebben az esetben minden paraméter kötelező)
https://monolitepszer.api.rs3.hu/getSales?kod=100000 - lekérdezés bizonylat kódjára (itt semmilyen egyéb paraméter nem kerül figyelembevételre).

method
GET
válasz

Eladási bizonylatok (szállítólevél, számla) fej és tételek, tételek esetén visszanyúl a rendeléshez és jelzi, hogy API-n keresztül lett-e összekészítve és ha igen, melyik API Key-vel. AZ adatokat sales/sale formában adja vissza A tételeknél visszaadja a raktárallokációkat is. Bizonyos számláknál (pl.: szállítóból készült összevont számla) nincs ilyen adat, mivel ott a szállítólevél érint készletet.

adatok
mező magyarázat
sale
kod

szállítólevél vagy számla RS3-beli kódja (egyedi ID)

szallitolevszam

szállítólevél száma

szamlaszam

számlaszám

szamlakelte

bizonylat kelte

teljesites

bizonylat teljesítési dátuma

fizmod

fizetési mód

  • K - készpénz
  • Á - átutalás
  • B - belső
  • V - bankkártya
  • E - előre utalás
  • C - csekk
  • U - utánvét
  • I - inkasszó

vkod

vevő RS3-beli kódja (egyedi ID)

megnev

számlázási cím név

orszag

számlázási cím ország

irsz

számlázási cím irányítószám

varos

számlázási cím település

utca

számlázási cím cím

vegosszeg

bizonylat nettó értéke alapdevizában (pl.: HUF)

vegbrutto

bizonylat bruttó értéke alapdevizában (pl.: HUF)

devizaveg

bizonylat nettó értéke devizában

devizavegbrutto

bizonylat brutto értéke devizában

penznem

bizonylat pénzneme

arfolyam

bizonylat árfolyama

osszevonva

ha bizonylatszám van benne, akkor szállítólevél és az adat megmondja, hogy melyik számlába lett összevonva. Ha `I`, akkor ez egy összevont számla. Üres: ha szállítólevél akkor még nem lett összevonva, ha számla, akkor ez egy direkt számla.

megj

bizonylat megjegyzés

datum

felvitel, vagy módosítás dátuma

sale_item
id

bizonylat tétel egyedi ID-ja

tkod

a tétel termékkódja

ean

a tétel EAN-ja (gyújtőcikknél mindig töltve van)

megnev

a tétel megnevezése

menny

a tétel mennyisége

me

a tétel mennyiség egysége

ar

a tétel nettó egységára

afa

a tétel ÁFA kulcsa

tomeg

a tétel termékének egységnyi tömege (1 mennyiségi egységre vonatkozóan)

megj

a tételhez fűzött megjegyzés

vansorszam

sorozatszámos-e a termék

tarhelyes

tárhelyes-e a termék

sarzsos

sarzsos-e a termék

gyujtocikk

gyűjtőcikk-e a termék

rendez

a tétel sorrendje a bizonylaton belül

allocatedQuantities

bizonylat-tételhez tartozó raktárallokációk.

{
  "result": {
    "page": "1",
    "pageCount": "1",
    "limit": "20",
    "sales": {
      "sale": [{
        "kod": 1,
        "szallitolevszam": "KSZL-0003",
        "szamlaszam": "",
        "szamlakelte": "2022-07-02",
        "teljesites": "2022-07-02",
        "vkod": 27,
        "megnev": "Gipsz Jakab",
        "orszag": "Magyarország",
        "irsz": "4400",
        "varos": "Nyíregyháza",
        "utca": "Vécsey köz 11\/A",
        "vegosszeg": "45473.0000",
        "vegbrutto": "57750.0000",
        "devizaveg": "45473.0000",
        "devizavegbrutto": "57750.0000",
        "penznem": "HUF",
        "arfolyam": "1.000000",
        "osszevonva": "K-0004",
        "megj": "",
        "datum": "2022-07-02 15:47:28",
        "sale_items": {
          "sale_item": [{
            "id": 1,
            "tkod": "RS3-00017",
            "ean": "2000000000190",
            "megnev": "Piros alma",
            "menny": "100.0000",
            "me": "kg",
            "ar": "330.710000",
            "afa": 27,
            "tomeg": "1.000000",
            "megj": "",
            "vansorszam": "N",
            "tarhelyes": "N",
            "sarzsos": "N",
            "gyujtocikk": "N",
            "rendez": 1,
            "apikey": "YaCtgGEae6Ir",
            "allocatedQuantities": {
              "alocatedQuantity": [{
                "rkod": 1,
                "quantity": "100.0000"
              }]
            }
          }, {
            "id": 2,
            "tkod": "RS3-00018",
            "ean": "2000000000206",
            "megnev": "Zöld alma",
            "menny": "30.0000",
            "me": "kg",
            "ar": "413.390000",
            "afa": 27,
            "tomeg": "1.000000",
            "megj": "",
            "vansorszam": "N",
            "tarhelyes": "N",
            "sarzsos": "N",
            "gyujtocikk": "N",
            "rendez": 2,
            "apikey": "YaCtgGEae6Ir",
            "allocatedQuantities": {
              "alocatedQuantity": [{
                "rkod": 1,
                "quantity": "30.0000"
              }]
            }
          }]
        }
      }, {
        "kod": 2,
        "szallitolevszam": "",
        "szamlaszam": "K-0004",
        "szamlakelte": "2022-07-02",
        "teljesites": "2022-07-02",
        "vkod": 27,
        "megnev": "Gipsz Jakab",
        "orszag": "Magyarország",
        "irsz": "4400",
        "varos": "Nyíregyháza",
        "utca": "Vécsey köz 11\/A",
        "vegosszeg": "45473.0000",
        "vegbrutto": "57750.0000",
        "devizaveg": "45473.0000",
        "devizavegbrutto": "57750.0000",
        "penznem": "HUF",
        "arfolyam": "1.000000",
        "osszevonva": "I",
        "megj": "",
        "datum": "2022-07-02 15:47:42",
        "sale_items": {
          "sale_item": [{
            "id": 3,
            "tkod": "RS3-00017",
            "ean": "2000000000190",
            "megnev": "Piros alma",
            "menny": "100.0000",
            "me": "kg",
            "ar": "330.710000",
            "afa": 27,
            "tomeg": "1.000000",
            "megj": "",
            "vansorszam": "N",
            "tarhelyes": "N",
            "sarzsos": "N",
            "gyujtocikk": "N",
            "rendez": 1,
            "apikey": "YaCtgGEae6Ir",
            "allocatedQuantities": []
          }, {
            "id": 4,
            "tkod": "RS3-00018",
            "ean": "2000000000206",
            "megnev": "Zöld alma",
            "menny": "30.0000",
            "me": "kg",
            "ar": "413.390000",
            "afa": 27,
            "tomeg": "1.000000",
            "megj": "",
            "vansorszam": "N",
            "tarhelyes": "N",
            "sarzsos": "N",
            "gyujtocikk": "N",
            "rendez": 2,
            "apikey": "YaCtgGEae6Ir",
            "allocatedQuantities": []
          }]
        }
      }, {
        "kod": 3,
        "szallitolevszam": "",
        "szamlaszam": "K-0005",
        "szamlakelte": "2022-07-02",
        "teljesites": "2022-07-02",
        "vkod": 30,
        "megnev": "Teszt cég Kft.",
        "orszag": "Magyarország",
        "irsz": "9000",
        "varos": "Győr",
        "utca": "Véndiófa utca. 12.",
        "vegosszeg": "1260630.0000",
        "vegbrutto": "1601000.0000",
        "devizaveg": "1260630.0000",
        "devizavegbrutto": "1601000.0000",
        "penznem": "HUF",
        "arfolyam": "1.000000",
        "osszevonva": "",
        "megj": "",
        "datum": "2022-07-02 15:48:05",
        "sale_items": {
          "sale_item": [{
            "id": 5,
            "tkod": "RS3-00032",
            "ean": "2000000000930",
            "megnev": "Gigabyte GA-Z390 AORUS ELITE Intel Z390 LGA1151 ATX alaplap",
            "menny": "8.0000",
            "me": "db",
            "ar": "53740.160000",
            "afa": 27,
            "tomeg": "0.000000",
            "megj": "",
            "vansorszam": "N",
            "tarhelyes": "N",
            "sarzsos": "N",
            "gyujtocikk": "N",
            "rendez": 1,
            "apikey": "YaCtgGEae6Ir",
            "allocatedQuantities": {
              "alocatedQuantity": [{
                "rkod": 1,
                "quantity": "8.0000"
              }]
            }
          }, {
            "id": 6,
            "tkod": "RS3-00001",
            "ean": "2000000000015",
            "megnev": "Gigabyte RTX 3060 12GB OC GDDR6 192bit LHR",
            "menny": "5.0000",
            "me": "db",
            "ar": "166141.730000",
            "afa": 27,
            "tomeg": "1.500000",
            "megj": "",
            "vansorszam": "N",
            "tarhelyes": "N",
            "sarzsos": "N",
            "gyujtocikk": "N",
            "rendez": 2,
            "apikey": "YaCtgGEae6Ir",
            "allocatedQuantities": {
              "alocatedQuantity": [{
                "rkod": 1,
                "quantity": "5.0000"
              }]
            }
          }]
        }
      }]
    }
  }
}

Recepturák lekérdezése

cél

recepturák/gyártási folyamatok lekérdezése lapozható formában

endpoint
/getRecipes
példa
  • page (értéke nullától nagyobb), hanyadik oldalt kérdezzük le

  • limit (értéke 1-200 tartományban van értelmezve), hány elem jelenjen meg 1 lekérésben

megjegyzés: ha page=1-gyel lekérve a pageCount 1, akkor nem szükséges további oldalakat lekérni, mert nem lesz találat



https://monolitepszer.api.rs3.hu/getRecipes?page=1&limit=200 (ebben az esetben minden paraméter kötelező)
https://monolitepszer.api.rs3.hu/getRecipes?kod=42 - lekérdezés receptúra kódjára (itt semmilyen egyéb paraméter nem kerül figyelembevételre).

method
GET
válasz

Receptúra késztermék és alapanyok product és raw_material formában mennyiségekkel, amely megmondja, hogy adott késztermék adott mennyiségének előállításához milyen alapanyagok milyen mennyiséggel szükségesek

adatok
mező magyarázat
recipe
kod

receptúra egyedi azonosítója (egyedi ID)

tkod

késztermék termékkód

ean

késztermék EAN

megnev

késztermék termék megnevezés

gyartmegnev

gyártás megnevezés (többnyire cikk megnevezés, de átírható RS3-ban)

valtozat

egy késztermék többféleképpen is legyártható, a különböző receptúrák változatokkal vanna elkülönítve

elsodleges

készterméken belül elsődleges recptúra-e (pl.: gyors gyártáshoz, szátbontáshoz)

megj

megjegyzés a receptúrához

tipus

M - mennyiség alapú, S - százalék alapú

menny

késztermék mennyisége, amire vonatkozik az alapanyagok mennyisége

me

késztermék mennyiségi egysége

raw_material
id

receptúra tétel egyedi ID-ja

tkod

alapanyag termékkód

ean

alapanyag EAN

megnev

alapanyag termék megnevezés

menny

alapanyag mennyisége

me

alapanyag mennyiségi egysége

{
  "result": {
    "page": "1",
    "pageCount": "1",
    "limit": "100",
    "recipes": {
      "recipe": [{
        "kod": 1,
        "tkod": "RS3-00045",
        "ean": "2000000001050",
        "megnev": "Késztermék #1",
        "gyartmegnev": "Késztermék #1",
        "valtozat": 1,
        "elsodleges": "I",
        "megj": "kesztermék #1 gyártása",
        "tipus": "M",
        "menny": "1.0000",
        "me": "db",
        "raw_materials": {
          "raw_material": [{
            "id": 1,
            "tkod": "RS3-00047",
            "ean": "",
            "megnev": "Alapanyag #1",
            "menny": "1.000000",
            "me": "db"
          }, {
            "id": 2,
            "tkod": "RS3-00048",
            "ean": "",
            "megnev": "Alapanyag #2",
            "menny": "2.000000",
            "me": "db"
          }]
        }
      }, {
        "kod": 2,
        "tkod": "RS3-00046",
        "ean": "2000000001067",
        "megnev": "Késztermék #2",
        "gyartmegnev": "Késztermék #2",
        "valtozat": 1,
        "elsodleges": "I",
        "megj": "késztermék #2 gyártása",
        "tipus": "M",
        "menny": "1.0000",
        "me": "db",
        "raw_materials": {
          "raw_material": [{
            "id": 3,
            "tkod": "RS3-00049",
            "ean": "",
            "megnev": "Alapanyag #3",
            "menny": "5.000000",
            "me": "db"
          }, {
            "id": 4,
            "tkod": "RS3-00050",
            "ean": "",
            "megnev": "Alapanyag #4",
            "menny": "1.000000",
            "me": "db"
          }]
        }
      }]
    }
  }
}