Registrácia Prihlásenie

API zberu čiarových kódov

Správa zberných dokladov — získavanie, vytváranie, úprava, uzavretie a zmena stavu príjmových a výdajových zberov

Koncové body

Autentifikácia

Ku každej API požiadavke je potrebné odoslať hlavičku X-API-KEY.

X-API-KEY: {vas_api_kluc}

Máte ešte otázky?

Napíšte nám tiket, alebo si pozrite naše centrum pomoci.

Ak sa vám páčilo, podeľte sa s ostatnými

Základná URL

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

Každá požiadavka vracia JSON odpoveď. V prípade úspešnej odpovede je result.code == 1, v prípade chyby result.code == 0.

GET /api/collect/get

Získanie jedného zberného dokladu na základe identifikátora, s úplnými podrobnosťami (položky, sériové čísla, skladové miesta, projekt).

Query parametre

Parameter Typ Povinné Popis
id int Jedinečný identifikátor zberného dokladu

Príklad požiadavky

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

Príklad odpovede

{
  "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

Stránkovateľné získanie zoznamu zberných dokladov s možnosťami filtrovania.

Query parametre

Parameter Typ Povinné Popis
list_offset int Posun stránkovania (predvolené: 0)
list_count int Počet záznamov zobrazených na stránku
list_sort[field] string Názov poľa na zoradenie
list_sort[sort] string Smer zoradenia: ASC alebo DESC
list_condition[identify] string Filtrovanie podľa identifikátora (LIKE)
list_condition[status_id] int Filtrovanie podľa stavu
list_condition[receipt_type_id] int Filtrovanie podľa typu zberu (32=príjem, 34=výdaj)
list_condition[company_user_id] int Filtrovanie podľa zodpovedného pracovníka
list_condition[date_create_from] date Dátum vytvorenia — od (YYYY-MM-DD)
list_condition[date_create_to] date Dátum vytvorenia — do (YYYY-MM-DD)
list_condition[partnumber] string Filtrovanie podľa kódu produktu (LIKE)
list_condition[order_out_identify] string Filtrovanie podľa identifikátora výstupnej objednávky
list_condition[pallet_barcode] string Filtrovanie podľa čiarového kódu palety
list_condition[store_locality_barcode] string Filtrovanie podľa čiarového kódu skladového miesta

Príklad požiadavky

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

Príklad odpovede

{
  "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

Vytvorenie alebo úprava zberného dokladu. Pre nový zber zadajte data[id] = 0, pre úpravu zadajte existujúce ID.

POST polia — objekt data

Pole Typ Povinné Popis
id int 0 = nový zberný doklad, >0 = úprava
receipt_type_id int Typ zberu: 32 = príjem, 34 = výdaj
company_id int Identifikátor firmy
company_user_id int ID zodpovedného pracovníka
company_address_id int ID prevádzky firmy
pallet_based int 1 = zber založený na paletách (pre každú položku je potrebné pallet_id)
order_out_identify string Referenčné číslo výstupnej objednávky
order_in_identify string Referenčné číslo vstupnej objednávky
invoice_in_identify string Referenčné číslo vstupnej faktúry
delivery_note_in_identify string Referenčné číslo vstupného dodacieho listu
jobnumber_id int Identifikátor pracovného čísla
departmentnumber_id int Identifikátor čísla oddelenia
comment_top string Poznámka (verejná)
comment_bottom string Interná poznámka
item array Pole položiek (pozri nižšie)

Polia položky — data[item][]

Pole Typ Povinné Popis
id int 0 = nová položka, >0 = úprava existujúcej
partnumber string Kód produktu
quantity float Zozbierané množstvo
price float Jednotková cena (ak je prázdna, vyplní sa podľa cenníka)
store_id int Identifikátor skladu
store_locality_id int Identifikátor skladového miesta
pallet_id int Identifikátor palety
checked int 1 = položka skontrolovaná/naskenovaná
comment_top string Poznámka k položke
serialnumber array Pole sériových čísel (pozri nižšie)
remove int 1 = zmazanie položky pri úprave

Polia sériového čísla — data[item][][serialnumber][]

Pole Typ Povinné Popis
val string Hodnota sériového čísla
expire date Dátum expirácie (YYYY-MM-DD)
qty float Množstvo patriace k tomuto sériovému číslu

POST polia — objekt params (voliteľné)

Pole Typ Povinné Popis
close int 1 = automatické uzavretie po uložení
status_change int Automatická zmena stavu na zadaný stav po uložení

Príklad požiadavky

POST /api/collect/save
X-API-KEY: {vas_api_kluc}
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
  }
}

Príklad odpovede

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

Zmazanie zberného dokladu. Zmazať možno v stavoch: otvorený (1), uzavretý (2) a rôzne stavy v spracovaní (15, 16, 31–36).

POST polia — objekt data

Pole Typ Povinné Popis
receipt_id int Identifikátor zberného dokladu na zmazanie

Príklad požiadavky

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

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

Príklad odpovede

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

Uzavretie otvoreného zberného dokladu. Uzavretie vykoná skladový pohyb a validuje množstvo položiek. Uzavrieť možno iba zber so status_id = 1 (otvorený).

POST polia — objekt data

Pole Typ Povinné Popis
receipt_id int Identifikátor zberného dokladu na uzavretie

Príklad požiadavky

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

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

Príklad odpovede

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

Zmena stavu zberného dokladu medzi krokmi procesu spracovania. Stav 16 (vyskladnené) je možné nastaviť iba pri výdajovom zbere (typ 34) zo stavu 15.

POST polia — objekt data

Pole Typ Povinné Popis
receipt_id int Identifikátor zberného dokladu
status_id int Identifikátor nového stavu
comment_bottom string Aktualizácia internej poznámky
company_user_id int Odovzdanie zodpovedného pracovníka inému používateľovi

Príklad požiadavky

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

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

Príklad odpovede

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

Stiahnutie/generovanie dokumentu zberného dokladu v rôznych formátoch (PDF, reťazec base64, stream).

Query parametre

Parameter Typ Povinné Popis
receipt_id int Identifikátor zberného dokladu
file_type string Výstupný formát (pozri nižšie)
language string Názov jazykového priečinka šablóny (napr. hungarian)
language_id int Identifikátor jazyka (pre vyhľadávanie podľa ID)
template_id int ID vlastnej tlačovej šablóny

Možné hodnoty file_type

Hodnota Popis
pdf Vrátenie PDF kódovaného v base64 s metadátami
pdf-string Zhodné s pdf — reťazec base64 + metadáta
pdf-string-sample Generovanie náhľadového PDF
stream Priamy súborový stream (stiahnutie v prehliadači)

Príklad požiadavky

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

Príklad odpovede (file_type=pdf)

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

Kontaktuj nás

Zaujíma ťa náš softvér? Pokojne nám napíš!

Odoslať dopyt

Potrebuješ pomoc?

Ak nevieš nájsť odpoveď a potrebuješ pomoc

Pozri sa do centra pomoci

Zaregistruj sa teraz,
zaplať neskôr!

Vyskúšaj 3 dni zadarmo, bez rizika a záväzkov!
Vytvorenie registrácie
Registrácia