Regisztráció Belépés

Vonalkód gyűjtő API

Gyűjtőívek kezelése — bevéti és kiadási gyűjtők lekérése, létrehozása, módosítása, lezárása és státuszváltás

Végpontok

Authentikáció

Minden API kéréshez szükséges az X-API-KEY header küldése.

X-API-KEY: {az_api_kulcsod}

Maradt még kérdésed?

Írj ticketet nekünk, vagy nézz körbe a keresőnkben.

Ha tetszett, oszd meg másokkal

Alap URL

https://{tenant}.logzi.com/api/collect/

Minden kérés JSON választ ad vissza. Sikeres válasz esetén result.code == 1, hiba esetén result.code == 0.

GET /api/collect/get

Egyetlen gyűjtőív lekérése azonosító alapján, teljes részletekkel (tételek, sorozatszámok, raktárhelyek, projekt).

Query paraméterek

Paraméter Típus Kötelező Leírás
id int A gyűjtőív egyedi azonosítója

Példa kérés

GET /api/collect/get?id=101
X-API-KEY: {az_api_kulcsod}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 101,
    "identify": "COL-2024-0101",
    "date_create": "2024-05-01 10:00:00",
    "date_update": "2024-05-01 11:30:00",
    "receipt_type_id": 34,
    "status_id": 1,
    "company_id": 1,
    "company_user_id": 3,
    "pallet_based": 0,
    "order_out_identify": "OR-2024-0055",
    "comment_top": "",
    "comment_bottom": "",
    "item": [
      {
        "id": 201,
        "partnumber": "PROD-001",
        "quantity": 5,
        "price": 3000,
        "store_id": 1,
        "store_locality_id": 12,
        "pallet_id": null,
        "checked": 0,
        "status_id": 1
      }
    ]
  }
}
GET /api/collect/list

Gyűjtőívek listájának lapozható lekérése szűrési lehetőségekkel.

Query paraméterek

Paraméter Típus Kötelező Leírás
list_offset int Lapozás eltolása (alapértelmezett: 0)
list_count int Oldalanként megjelenő rekordok száma
list_sort[field] string Rendezési mező neve
list_sort[sort] string Rendezés iránya: ASC vagy DESC
list_condition[identify] string Szűrés azonosítóra (LIKE)
list_condition[status_id] int Szűrés státuszra
list_condition[receipt_type_id] int Szűrés gyűjtő típusra (32=bevét, 34=kiadás)
list_condition[company_user_id] int Szűrés felelős munkatársra
list_condition[date_create_from] date Létrehozás dátuma — tól (YYYY-MM-DD)
list_condition[date_create_to] date Létrehozás dátuma — ig (YYYY-MM-DD)
list_condition[partnumber] string Szűrés termékkódra (LIKE)
list_condition[order_out_identify] string Szűrés kimenő megrendelés azonosítóra
list_condition[pallet_barcode] string Szűrés raklap vonalkódra
list_condition[store_locality_barcode] string Szűrés raktárhely vonalkódra

Példa kérés

GET /api/collect/list?list_offset=0&list_condition[receipt_type_id]=34&list_condition[status_id]=1
X-API-KEY: {az_api_kulcsod}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 101,
      "identify": "COL-2024-0101",
      "date_create": "2024-05-01 10:00:00",
      "receipt_type_id": 34,
      "status_id": 1,
      "status_name": "Nyitott",
      "company_user_id": 3
    }
  ],
  "params": {
    "list_count": 20,
    "list_offset": 0,
    "list_all": 134
  }
}
POST /api/collect/save

Gyűjtőív létrehozása vagy módosítása. Új gyűjtőhöz data[id] = 0, módosításhoz a meglévő ID-t add meg.

POST mezők — data objektum

Mező Típus Kötelező Leírás
id int 0 = új gyűjtőív, >0 = módosítás
receipt_type_id int Gyűjtő típusa: 32 = bevét, 34 = kiadás
company_id int Cég azonosítója
company_user_id int Felelős munkatárs ID
company_address_id int Cég telephely ID
pallet_based int 1 = raklapalapú gyűjtés (minden tételhez szükséges pallet_id)
order_out_identify string Kimenő megrendelés hivatkozási száma
order_in_identify string Bejövő megrendelés hivatkozási száma
invoice_in_identify string Bejövő számla hivatkozási száma
delivery_note_in_identify string Bejövő szállítólevél hivatkozási száma
jobnumber_id int Munkaszám azonosítója
departmentnumber_id int Részlegszám azonosítója
comment_top string Megjegyzés (publikus)
comment_bottom string Belső megjegyzés
item array Tételek tömbje (ld. alább)

Tétel mezők — data[item][]

Mező Típus Kötelező Leírás
id int 0 = új tétel, >0 = meglévő módosítása
partnumber string Termék cikkszáma
quantity float Gyűjtött mennyiség
price float Egységár (üres esetén árlista alapján töltődik)
store_id int Raktár azonosítója
store_locality_id int Raktárhely azonosítója
pallet_id int Raklap azonosítója
checked int 1 = tétel ellenőrizve/leolvasva
comment_top string Tételmegyjegyzés
serialnumber array Sorozatszámok tömbje (ld. alább)
remove int 1 = tétel törlése módosításkor

Sorozatszám mezők — data[item][][serialnumber][]

Mező Típus Kötelező Leírás
val string Sorozatszám értéke
expire date Lejárati dátum (YYYY-MM-DD)
qty float Ezen sorozatszámhoz tartozó mennyiség

POST mezők — params objektum (opcionális)

Mező Típus Kötelező Leírás
close int 1 = mentés után automatikus lezárás
status_change int Mentés után automatikus státuszváltás a megadott státuszra

Példa kérés

POST /api/collect/save
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "receipt_type_id": 34,
    "company_id": 1,
    "company_user_id": 3,
    "order_out_identify": "OR-2024-0055",
    "comment_bottom": "Sürgős kiszedés",
    "item": [
      {
        "partnumber": "PROD-001",
        "quantity": 5,
        "store_id": 1,
        "store_locality_id": 12,
        "checked": 1
      }
    ]
  },
  "params": {
    "close": 0
  }
}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 102,
    "identify": "COL-2024-0102",
    "item": {
      "1": {
        "id": 205,
        "partnumber": "PROD-001"
      }
    }
  }
}
POST /api/collect/delete

Gyűjtőív törlése. Törölhető státuszok: nyitott (1), lezárt (2), és a különböző feldolgozás alatti állapotok (15, 16, 31–36).

POST mezők — data objektum

Mező Típus Kötelező Leírás
receipt_id int A törlendő gyűjtőív azonosítója

Példa kérés

POST /api/collect/delete
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{
  "data": {
    "receipt_id": 101
  }
}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
POST /api/collect/close

Nyitott gyűjtőív lezárása. A lezárás készletmozgást hajt végre és validálja a tételek mennyiségét. Csak status_id = 1 (nyitott) gyűjtő zárható le.

POST mezők — data objektum

Mező Típus Kötelező Leírás
receipt_id int A lezárandó gyűjtőív azonosítója

Példa kérés

POST /api/collect/close
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{
  "data": {
    "receipt_id": 101
  }
}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
POST /api/collect/status_change

Gyűjtőív státuszának megváltoztatása a feldolgozási folyamat lépései között. A státusz 16 (kiszedett) csak kiadási (34-es típusú) gyűjtőnél, 15-ös státuszból állítható be.

POST mezők — data objektum

Mező Típus Kötelező Leírás
receipt_id int A gyűjtőív azonosítója
status_id int Új státusz azonosítója
comment_bottom string Belső megjegyzés frissítése
company_user_id int Felelős munkatárs átadása másik felhasználónak

Példa kérés

POST /api/collect/status_change
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{
  "data": {
    "receipt_id": 101,
    "status_id": 15,
    "comment_bottom": "Kiszedésre vár"
  }
}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
GET /api/collect/download

Gyűjtőív dokumentumának letöltése/generálása különböző formátumokban (PDF, base64 string, stream).

Query paraméterek

Paraméter Típus Kötelező Leírás
receipt_id int A gyűjtőív azonosítója
file_type string Kimeneti formátum (ld. alább)
language string Sablon nyelvi mappa neve (pl. hungarian)
language_id int Nyelv azonosítója (ID alapú kereséshez)
template_id int Egyedi nyomtatási sablon ID

file_type lehetséges értékek

Érték Leírás
pdf Base64 kódolt PDF visszaadása metaadatokkal
pdf-string Azonos a pdf-fel — base64 string + metaadat
pdf-string-sample Előnézeti PDF generálás
stream Közvetlen fájl stream (böngésző letöltés)

Példa kérés

GET /api/collect/download?receipt_id=101&file_type=pdf
X-API-KEY: {az_api_kulcsod}

Példa válasz (file_type=pdf)

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "name": "COL-2024-0101.pdf",
    "content": "JVBERi0xLjQK...",
    "receipt": { ... }
  }
}

Vedd fel a kapcsolatot velünk

Érdeklődsz a szoftverünkkel kapcsolatban, írj bátran!

Érdeklődés küldése

Segítségre van szükséged?

Ha nem találod a választ és szükséged van segítségre

Nézz körbe a help centerben

Regisztrációdat hozd létre most,
fizess később!

Próbáld ki 3 napig ingyen, kockázatok és kötöttségek nélkül!
Regisztráció készítése
Regisztráció